From c7b860297ddf53c1f9ef501583c824fdd00cbc40 Mon Sep 17 00:00:00 2001 From: msxzq <44255871+msxzq@users.noreply.github.com> Date: Fri, 19 Oct 2018 02:23:26 +0800 Subject: [PATCH 001/464] Swagger changes for connectors: Google AdWords, Oracle Service Cloud, OData, Rest Service, Dynamics AX and support for wildcardPath. (#4258) * Zhenquan Xu: swaager for connector Google AdWords. * Zhenquan Xu: swagger for connector Oracle Service Cloud. * Zhenquan Xu: swagger changes for existing OData connector. * David Zhao: swagger for connector Rest Service. * Charles Gu: Delete required property in StoredProcedureParameter. * Tina Hu: swagger changes to support WildcardPath. * Zhenquan Xu: swagger for connector Dynamics AX. --- .../2018-06-01/entityTypes/Dataset.json | 126 ++++++- .../2018-06-01/entityTypes/LinkedService.json | 329 +++++++++++++++++- .../2018-06-01/entityTypes/Pipeline.json | 73 +++- 3 files changed, 507 insertions(+), 21 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e2ab56cec7a8..1e26ca5e9325 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -337,6 +337,10 @@ "type": "object", "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." }, + "wildcardPath": { + "type": "object", + "description": "The path of the S3 object with wildcard supported. Type: string (or Expression with resultType string)." + }, "version": { "type": "object", "description": "The version for the S3 object. Type: string (or Expression with resultType string)." @@ -389,6 +393,10 @@ "type": "object", "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." }, + "wildcardPath": { + "type": "object", + "description": "The whole path include file name of the Azure Blob storage with wildcard supported. Type: string (or Expression with resultType string)." + }, "format": { "description": "The format of the Azure Blob storage.", "$ref": "#/definitions/DatasetStorageFormat" @@ -608,6 +616,38 @@ } } }, + "DynamicsAXResourceDataset": { + "x-ms-discriminator-value": "DynamicsAXResource", + "description": "The path of the Dynamics AX OData entity.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXResourceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXResourceDatasetTypeProperties": { + "description": "Dynamics AX OData resource dataset properties.", + "properties": { + "path": { + "type": "string", + "description": "The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "path" + ] + }, "AzureDataLakeStoreDataset": { "x-ms-discriminator-value": "AzureDataLakeStoreFile", "description": "Azure Data Lake Store dataset.", @@ -643,14 +683,15 @@ "description": "The format of the Data Lake Store.", "$ref": "#/definitions/DatasetStorageFormat" }, + "wildcardPath": { + "type": "object", + "description": "The whole path include file name in the Azure Data Lake Store with wildcard supported. Type: string (or Expression with resultType string)." + }, "compression": { "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", "$ref": "#/definitions/DatasetCompression" } - }, - "required": [ - "folderPath" - ] + } }, "FileShareDataset": { "x-ms-discriminator-value": "FileShare", @@ -683,6 +724,10 @@ "type": "object", "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." }, + "wildcardPath": { + "type": "object", + "description": "The whole path include file name of the on-premises file system with wildcard supported. Type: string (or Expression with resultType string)." + }, "format": { "description": "The format of the files.", "$ref": "#/definitions/DatasetStorageFormat" @@ -790,6 +835,18 @@ "tableName" ] }, + "OracleServiceCloudObjectDataset" : { + "x-ms-discriminator-value": "OracleServiceCloudObject", + "description": "Oracle Service Cloud dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, "AzureMySqlTableDataset": { "x-ms-discriminator-value": "AzureMySqlTable", "description": "The Azure MySQL database dataset.", @@ -1090,6 +1147,51 @@ } } }, + "RestServiceDataset": { + "x-ms-discriminator-value": "RestResource", + "description": "A Rest service dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestServiceDatasetTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RestServiceDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "relativeUrl": { + "type": "object", + "description": "The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string)." + }, + "requestMethod": { + "type": "object", + "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." + }, + "requestBody": { + "type": "object", + "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." + }, + "additionalHeaders": { + "type": "object", + "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." + }, + "paginationRules": { + "description": "The pagination rules to compose next page requests.", + "type": "object" + } + } + }, "AmazonMWSObjectDataset" : { "x-ms-discriminator-value": "AmazonMWSObject", "description": "Amazon Marketplace Web Service dataset.", @@ -1151,8 +1253,20 @@ } }, "EloquaObjectDataset" : { - "x-ms-discriminator-value": "EloquaObject", - "description": "Eloqua server dataset.", + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + } + }, + "GoogleAdWordsObjectDataset" : { + "x-ms-discriminator-value": "GoogleAdWordsObject", + "description": "Google AdWords service dataset.", "type": "object", "allOf": [ { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index b893ab4f12a0..8fc15ddd557a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -459,8 +459,8 @@ "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." }, "serviceUri": { - "type": "object", - "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + "type": "object", + "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." }, "organizationName": { "type": "object", @@ -497,6 +497,58 @@ "username" ] }, + "DynamicsAXLinkedService": { + "x-ms-discriminator-value": "DynamicsAX", + "description": "Dynamics AX linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Dynamics AX linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DynamicsAXLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DynamicsAXLinkedServiceTypeProperties": { + "description": "Dynamics AX linked service properties.", + "properties": { + "url": { + "type": "object", + "description": "The URL of Dynamics AX OData API. Type: string (or Expression with resultType string)." + }, + "tenant": { + "type": "object", + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "type": "object", + "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." + }, + "servicePrincipalKey": { + "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "encryptedCredential": { + "type": "object", + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." + } + }, + "required": [ + "url" + ] + }, "HDInsightLinkedService": { "x-ms-discriminator-value": "HDInsight", "description": "HDInsight linked service.", @@ -629,6 +681,64 @@ "connectionString" ] }, + "OracleServiceCloudLinkedService": { + "x-ms-discriminator-value": "OracleServiceCloud", + "description": "Oracle Service Cloud linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/OracleServiceCloudLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "OracleServiceCloudLinkedServiceTypeProperties": { + "description": "Oracle Service Cloud linked service properties.", + "properties": { + "host": { + "description": "The URL of the Oracle Service Cloud instance.", + "type": "object" + }, + "username": { + "description": "The user name that you use to access Oracle Service Cloud server.", + "type": "object" + }, + "password": { + "description": "The password corresponding to the user name that you provided in the username key.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "useEncryptedEndpoints": { + "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "useHostVerification": { + "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "usePeerVerification": { + "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "host", + "username", + "password" + ] + }, "AzureMySqlLinkedService": { "x-ms-discriminator-value": "AzureMySql", "description": "Azure MySQL database linked service.", @@ -1106,8 +1216,11 @@ "description": "Type of authentication used to connect to the OData service.", "type": "string", "enum": [ + "Anonymous", "Basic", - "Anonymous" + "Windows", + "AadServicePrincipal", + "ManagedServiceIdentity" ], "x-ms-enum": { "name": "ODataAuthenticationType", @@ -1122,13 +1235,50 @@ "description": "Password of the OData service.", "$ref": "../datafactory.json#/definitions/SecretBase" }, + "tenant": { + "type": "object", + "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." + }, + "servicePrincipalId": { + "type": "object", + "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." + }, + "aadResourceId": { + "type": "object", + "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." + }, + "aadServicePrincipalCredentialType": { + "description": "Specify the credential type (key or cert) is used for service principal.", + "type": "string", + "enum": [ + "ServicePrincipalKey", + "ServicePrincipalCert" + ], + "x-ms-enum": { + "name": "ODataAadServicePrincipalCredentialType", + "modelAsString": true + } + }, + "servicePrincipalKey": { + "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCert": { + "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "servicePrincipalEmbeddedCertPassword": { + "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." } }, "required": [ - "url" + "url", + "authenticationType" ] }, "WebLinkedService": { @@ -1776,6 +1926,85 @@ "url" ] }, + "RestServiceLinkedService": { + "x-ms-discriminator-value": "RestService", + "description": "Rest Service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Rest Service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RestServiceLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "RestServiceLinkedServiceTypeProperties": { + "description": "Rest Service linked service properties.", + "properties": { + "url": { + "description": "The base URL of the REST service.", + "type": "object" + }, + "enableServerCertificateValidation": { + "type": "object", + "description": "Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean)." + }, + "authenticationType": { + "description": "Type of authentication used to connect to the REST service.", + "type": "string", + "enum": [ + "Anonymous", + "Basic", + "AadServicePrincial", + "ManagedServiceIdentity" + ], + "x-ms-enum": { + "name": "RestServiceAuthenticationType", + "modelAsString": true + } + }, + "userName": { + "description": "The user name used in Basic authentication type.", + "type": "object" + }, + "password": { + "description": "The password used in Basic authentication type.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "servicePrincipalId": { + "description": "The application’s client ID used in AadServicePrincipal authentication type.", + "type": "object" + }, + "servicePrincipalKey": { + "description": "The application’s key used in AadServicePrincipal authentication type.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "tenant": { + "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.", + "type": "object" + }, + "aadResourceId": { + "description": "The resource you are requesting authorization to use.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "url", + "authenticationType" + ] + }, "FtpServerLinkedService": { "x-ms-discriminator-value": "FtpServer", "description": "A FTP server Linked Service.", @@ -2280,9 +2509,9 @@ "required": [ "typeProperties" ] - }, - "EloquaLinkedServiceTypeProperties": { - "description": "Eloqua server linked service properties.", + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", @@ -2308,14 +2537,96 @@ "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", "type": "object" }, - "encryptedCredential": { - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ "endpoint", "username" + ] + }, + "GoogleAdWordsLinkedService": { + "x-ms-discriminator-value": "GoogleAdWords", + "description": "Google Awords service linked service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedService" + } + ], + "properties": { + "typeProperties": { + "description": "Google AdWords service linked service properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GoogleAdWordsLinkedServiceTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "GoogleAdWordsLinkedServiceTypeProperties": { + "description": "Google AdWords service linked service properties.", + "properties": { + "clientCustomerID": { + "description": "The Client customer ID of the AdWords account that you want to fetch report data for.", + "type": "object" + }, + "developerToken":{ + "description": "The developer token associated with the manager account that you use to grant access to the AdWords API.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "authenticationType": { + "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", + "type": "string", + "enum": [ + "ServiceAuthentication", + "UserAuthentication" + ], + "x-ms-enum": { + "name": "GoogleAdWordsAuthenticationType", + "modelAsString": true + } + }, + "refreshToken": { + "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientId": { + "description": "The client id of the google application used to acquire the refresh token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "clientSecret": { + "description": "The client secret of the google application used to acquire the refresh token.", + "$ref": "../datafactory.json#/definitions/SecretBase" + }, + "email": { + "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", + "type": "object" + }, + "keyFilePath": { + "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", + "type": "object" + }, + "trustedCertPath": { + "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", + "type": "object" + }, + "useSystemTrustStore": { + "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", + "type": "object" + }, + "encryptedCredential": { + "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", + "type": "object" + } + }, + "required": [ + "clientCustomerID", + "developerToken", + "authenticationType" ] }, "GoogleBigQueryLinkedService": { 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 24fdecaf29ea..1ca8adb3f12f 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 @@ -384,6 +384,21 @@ } } }, + "DynamicsAXSource": { + "description": "A copy activity Dynamics AX source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, "RelationalSource": { "description": "A copy activity source for various relational databases.", "type": "object", @@ -595,6 +610,21 @@ } } }, + "OracleServiceCloudSource": { + "description": "A copy activity Oracle Service Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, "WebSource": { "description": "A copy activity source for web page table.", "type": "object", @@ -685,6 +715,25 @@ } } }, + "RestServiceSource": { + "description": "A copy activity Rest service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "httpRequestTimeout": { + "type": "object", + "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + }, + "requestInterval": { + "type": "object", + "description": "The time to await before sending next page request. Default value: 00:00:01. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." + } + } + }, "AmazonMWSSource": { "description": "A copy activity Amazon Marketplace Web Service source.", "type": "object", @@ -759,9 +808,24 @@ "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", + "GoogleAdWordsSource": { + "description": "A copy activity Google AdWords service source.", "type": "object", "allOf": [ { @@ -1184,10 +1248,7 @@ "description": "Stored procedure parameter type.", "$ref": "#/definitions/StoredProcedureParameterType" } - }, - "required": [ - "value" - ] + } }, "StoredProcedureParameterType": { "description": "Stored procedure parameter type.", From 9981b6a1fc5cddbecb355c6ea5520417445cb580 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 11:31:31 -0700 Subject: [PATCH 002/464] Remove TypeScript and NodeJS schedule readmes (#4266) --- specification/scheduler/resource-manager/readme.md | 2 -- .../scheduler/resource-manager/readme.nodejs.md | 14 -------------- .../resource-manager/readme.typescript.md | 12 ------------ 3 files changed, 28 deletions(-) delete mode 100644 specification/scheduler/resource-manager/readme.nodejs.md delete mode 100644 specification/scheduler/resource-manager/readme.typescript.md diff --git a/specification/scheduler/resource-manager/readme.md b/specification/scheduler/resource-manager/readme.md index 8f43142dfd3a..5402fc586d48 100644 --- a/specification/scheduler/resource-manager/readme.md +++ b/specification/scheduler/resource-manager/readme.md @@ -72,8 +72,6 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - - repo: azure-sdk-for-js - - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_scheduler'] diff --git a/specification/scheduler/resource-manager/readme.nodejs.md b/specification/scheduler/resource-manager/readme.nodejs.md deleted file mode 100644 index 2aa2a7594c69..000000000000 --- a/specification/scheduler/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,14 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-scheduler - output-folder: $(node-sdks-folder)/lib/services/schedulerManagement2 - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` diff --git a/specification/scheduler/resource-manager/readme.typescript.md b/specification/scheduler/resource-manager/readme.typescript.md deleted file mode 100644 index 20d86de0fa1e..000000000000 --- a/specification/scheduler/resource-manager/readme.typescript.md +++ /dev/null @@ -1,12 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -``` yaml $(typescript) -typescript: - azure-arm: true - package-name: "@azure/arm-scheduler" - output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-scheduler" - generate-metadata: true -``` From 877219d5f8bbdce026ea7cbb79d92e3f383c0764 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 11:50:26 -0700 Subject: [PATCH 003/464] Add azure-sdk-for-js to networking readme.md (#4261) --- specification/network/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index c23bf2ccdf3f..42e699ca7436 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -760,6 +760,7 @@ swagger-to-sdk: - python ./scripts/multiapi_init_gen.py azure-mgmt-network - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: From fab522f3c2eca65a78fde8c9ad2f108f3742a8b0 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Thu, 18 Oct 2018 12:49:21 -0700 Subject: [PATCH 004/464] =?UTF-8?q?EventGrid:=20Update=20README=20files=20?= =?UTF-8?q?to=20include=20the=20current=20new=20preview=20api=E2=80=A6=20(?= =?UTF-8?q?#4235)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * EventGrid: Update README files to include the current new preview api version 2018-09-preview * Update readme.go.md with related api version info * fix parsing failure due to missing closing ``` in readme.go.md * suppress failure due to known tool bug per approval from adxsr * Fix suppression message --- .../eventgrid/resource-manager/readme.go.md | 9 +++++++ .../eventgrid/resource-manager/readme.md | 25 ++++++++++++++++++- .../eventgrid/resource-manager/readme.ruby.md | 11 ++++++++ 3 files changed, 44 insertions(+), 1 deletion(-) diff --git a/specification/eventgrid/resource-manager/readme.go.md b/specification/eventgrid/resource-manager/readme.go.md index 6508061bc189..f77675d88cd1 100644 --- a/specification/eventgrid/resource-manager/readme.go.md +++ b/specification/eventgrid/resource-manager/readme.go.md @@ -13,11 +13,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-09-preview - tag: package-2018-05-preview - tag: package-2018-01 - tag: package-2017-09-preview - tag: package-2017-06-preview ``` +### Tag: package-2018-09-preview and go + +These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-15-preview/$(namespace) +``` ### Tag: package-2018-05-preview and go diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index 814def808d4f..be7dcc9ba2a0 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Azure EventGrid API. ``` yaml openapi-type: arm -tag: package-2018-05-preview +tag: package-2018-09-preview ``` @@ -39,6 +39,14 @@ input-file: - Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json ``` +## Suppression + +``` yaml +directive: + - suppress: TrackedResourcePatchOperation + from: EventGrid.json + reason: PATCH operation already exists in the json file but this is known issue in the ARM validation. +``` ### Tag: package-2018-05-preview @@ -167,10 +175,25 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-eventgrid ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-09-preview - tag: package-2018-05-preview - tag: package-2018-01 ``` +### Tag: package-2018-09-preview and java + +These settings apply only when `--tag=package-2018-09-preview --java` is specified on the command line. + +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventgrid.v2018_09_15_preview + output-folder: $(azure-libraries-for-java-folder)/eventgrid/resource-manager/v2018_09_15_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2018-05-preview and java These settings apply only when `--tag=package-2018-05-preview --java` is specified on the command line. diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md index e71ecf40468d..8c534cd95f85 100644 --- a/specification/eventgrid/resource-manager/readme.ruby.md +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -12,12 +12,23 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2018-09-preview - tag: package-2018-05-preview - tag: package-2018-01 - tag: package-2017-09-preview - tag: package-2017-06-preview ``` +### Tag: package-2018-09-preview and ruby +These settings apply only when `--tag=package-2018-09-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(ruby) + +namespace: "Azure::EventGrid::Mgmt::V2018_09_15_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + ### Tag: package-2018-05-preview and ruby These settings apply only when `--tag=package-2018-05-preview --ruby` is specified on the command line. From 3e999db5580c7a4989f92a040ec2cdd5c2980508 Mon Sep 17 00:00:00 2001 From: Khiraling <35118371+kjeur@users.noreply.github.com> Date: Thu, 18 Oct 2018 13:09:04 -0700 Subject: [PATCH 005/464] Updating readme for new version - Forecast (#4269) * Cost Analysis Forecast support Preview version * Foreacast and usage examples - Preview * Correcting columns from rows- Forecast 2018-12-01-preview * Adding new type for forecast and usage - preview * Updating readme for new version - Forecast --- .../resource-manager/readme.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index d7bae3938af8..6135a098a45c 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -46,6 +46,16 @@ input-file: ``` +### Tag: package-2018-12-preview + +These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12-preview' +input-file: +- Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json +``` + + --- # Code Generation @@ -157,3 +167,16 @@ java: regenerate-manager: true generate-interface: true ``` + +### Tag: package-2018-12-preview and java + +These settings apply only when `--tag=package-2018-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.costmanagement.v2018_12_01_preview + output-folder: $(azure-libraries-for-java-folder)/costmanagement/resource-manager/v2018_12_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file From 3efb0f79678dac54d153205c1a2ecfd03b97981c Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:08:05 -0700 Subject: [PATCH 006/464] Add cognitiveservices\data-plane\ComputerVision\readme.typescript.md (#4271) --- .../data-plane/ComputerVision/readme.md | 1 + .../ComputerVision/readme.typescript.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.md index f9a000adc2fb..30e6b9c8191f 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/readme.md +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.md @@ -33,6 +33,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/ComputerVision/readme.typescript.md b/specification/cognitiveservices/data-plane/ComputerVision/readme.typescript.md new file mode 100644 index 000000000000..64e9e1d8776d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/readme.typescript.md @@ -0,0 +1,18 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +directive: + from: source-file-nodejs + where: $ + transform: > + $ = $.replace( /mode: string, url: string/g, "url: string, mode: string" ); + $ = $.replace( /mode, url/g, "url, mode" ); +typescript: + package-name: "@azure/cognitiveservices-computervision" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-computervision" + azure-arm: false + generate-metadata: true +``` From 9620cc259d3c93f2a5c90b6431e7aafaedb44642 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:16:33 -0700 Subject: [PATCH 007/464] Add cognitiveservices\data-plane\LUIS\Authoring\readme.typescript.md (#4281) --- .../data-plane/LUIS/Authoring/readme.md | 2 ++ .../data-plane/LUIS/Authoring/readme.typescript.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md index bb35d7240112..9cf6c6b1b34e 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md @@ -61,6 +61,8 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node ``` ### Authoring 2.0 - CSharp Settings diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.typescript.md b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.typescript.md new file mode 100644 index 000000000000..2cce2d7664c4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-luis-authoring" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-luis-authoring" + azure-arm: false + generate-metadata: true +``` From 9b2f2ee6de3dc8fb95d3380359ade7eea2314ead Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:16:57 -0700 Subject: [PATCH 008/464] Add cognitiveservices\data-plane\NewsSearch\readme.typescript.md (#4280) --- .../data-plane/NewsSearch/readme.md | 1 + .../data-plane/NewsSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/NewsSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/NewsSearch/readme.md b/specification/cognitiveservices/data-plane/NewsSearch/readme.md index 9df4ff55d5ad..cfebe1ac5270 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/readme.md +++ b/specification/cognitiveservices/data-plane/NewsSearch/readme.md @@ -40,6 +40,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/NewsSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/NewsSearch/readme.typescript.md new file mode 100644 index 000000000000..5e9eb040d123 --- /dev/null +++ b/specification/cognitiveservices/data-plane/NewsSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-newssearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-newssearch" + override-client-name: NewsSearchAPIClient + azure-arm: false + generate-metadata: true +``` From fe291125b72ec6a689e673d902992659d399e6dd Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:17:10 -0700 Subject: [PATCH 009/464] Add cognitiveservices\data-plane\SpellCheck\readme.typescript.md (#4282) --- .../data-plane/SpellCheck/readme.md | 1 + .../data-plane/SpellCheck/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/SpellCheck/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/SpellCheck/readme.md b/specification/cognitiveservices/data-plane/SpellCheck/readme.md index 33db78c23264..44ac66e42b59 100644 --- a/specification/cognitiveservices/data-plane/SpellCheck/readme.md +++ b/specification/cognitiveservices/data-plane/SpellCheck/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/SpellCheck/readme.typescript.md b/specification/cognitiveservices/data-plane/SpellCheck/readme.typescript.md new file mode 100644 index 000000000000..9fd7b78ebd0f --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpellCheck/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-spellcheck" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-spellcheck" + override-client-name: SpellCheckAPIClient + azure-arm: false + generate-metadata: true +``` From 9b867a5fb8c2d6019bc8587e25086ea28d74b13d Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:17:36 -0700 Subject: [PATCH 010/464] Add cognitiveservices\data-plane\ImageSearch\readme.typescript.md (#4279) --- .../data-plane/ImageSearch/readme.md | 1 + .../data-plane/ImageSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/ImageSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/ImageSearch/readme.md b/specification/cognitiveservices/data-plane/ImageSearch/readme.md index aaa0ccc09bcd..4482ec3e1133 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/readme.md +++ b/specification/cognitiveservices/data-plane/ImageSearch/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/ImageSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/ImageSearch/readme.typescript.md new file mode 100644 index 000000000000..f34fff13feee --- /dev/null +++ b/specification/cognitiveservices/data-plane/ImageSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-imagesearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-imagesearch" + override-client-name: ImageSearchAPIClient + azure-arm: false + generate-metadata: true +``` From 59f7036841f281aa6cad7476c0c8011da3b3c0d0 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:18:56 -0700 Subject: [PATCH 011/464] Add cognitiveservices\data-plane\Face\readme.typescript.md (#4278) --- .../cognitiveservices/data-plane/Face/readme.md | 1 + .../data-plane/Face/readme.typescript.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Face/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/Face/readme.md b/specification/cognitiveservices/data-plane/Face/readme.md index 043487a1c87b..e03a66ac3723 100644 --- a/specification/cognitiveservices/data-plane/Face/readme.md +++ b/specification/cognitiveservices/data-plane/Face/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/Face/readme.typescript.md b/specification/cognitiveservices/data-plane/Face/readme.typescript.md new file mode 100644 index 000000000000..38bb9d5eedec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-face" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-face" + azure-arm: false + generate-metadata: true +``` From a1a750d3680f694038faba9cdddcf60b583c0db4 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:19:38 -0700 Subject: [PATCH 012/464] Add cognitiveservices\data-plane\EntitySearch\readme.typescript.md (#4276) --- .../data-plane/EntitySearch/readme.md | 1 + .../data-plane/EntitySearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/EntitySearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/EntitySearch/readme.md b/specification/cognitiveservices/data-plane/EntitySearch/readme.md index 10e231e19d1a..2f0c4859ff11 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/readme.md +++ b/specification/cognitiveservices/data-plane/EntitySearch/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/EntitySearch/readme.typescript.md b/specification/cognitiveservices/data-plane/EntitySearch/readme.typescript.md new file mode 100644 index 000000000000..b64954a23134 --- /dev/null +++ b/specification/cognitiveservices/data-plane/EntitySearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-entitysearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-entitysearch" + override-client-name: EntitySearchAPIClient + azure-arm: false + generate-metadata: true +``` From 66e86b587e54f8edcc2e7355c848e6497a96054c Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:20:23 -0700 Subject: [PATCH 013/464] Add cognitiveservices\data-plane\CustomWebSearch\readme.typescript.md (#4274) --- .../data-plane/CustomWebSearch/readme.md | 1 + .../data-plane/CustomWebSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/CustomWebSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md index 2c25c9db9c86..fc25d5fb6885 100644 --- a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md @@ -32,6 +32,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.typescript.md new file mode 100644 index 000000000000..54eba5ca7878 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-customsearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-customsearch" + override-client-name: CustomSearchAPIClient + azure-arm: false + generate-metadata: true +``` From ee46c02167c0389aaedcefee997e4ede86b70ed3 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:20:47 -0700 Subject: [PATCH 014/464] Add cognitiveservices\data-plane\LUIS\Runtime\readme.typescript.md (#4283) --- .../data-plane/LUIS/Runtime/readme.md | 2 ++ .../data-plane/LUIS/Runtime/readme.typescript.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/LUIS/Runtime/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md index 278d367e5d95..2ffe8859e39a 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.md @@ -38,6 +38,8 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node ``` ### Runtime 2.0 - CSharp Settings diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.typescript.md b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.typescript.md new file mode 100644 index 000000000000..78bcd51513d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-luis-runtime" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-luis-runtime" + azure-arm: false + generate-metadata: true +``` From caf0754bb5454e58485ee2edae524a4f38f0732e Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:21:58 -0700 Subject: [PATCH 015/464] Add cognitiveservices\data-plane\TextAnalytics\readme.typescript.md (#4284) --- .../data-plane/TextAnalytics/readme.md | 1 + .../data-plane/TextAnalytics/readme.typescript.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/TextAnalytics/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 603fec1d97af..13bb690d2276 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -150,6 +150,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.typescript.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.typescript.md new file mode 100644 index 000000000000..cce9f774bdb3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-textanalytics" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-textanalytics" + azure-arm: false + generate-metadata: true +``` From 24d3fba7aec3fc9e58f88405cf85aec7d1281c52 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:22:21 -0700 Subject: [PATCH 016/464] Add cognitiveservices\data-plane\VideoSearch\readme.typescript.md (#4285) --- .../data-plane/VideoSearch/readme.md | 1 + .../data-plane/VideoSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/VideoSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/VideoSearch/readme.md b/specification/cognitiveservices/data-plane/VideoSearch/readme.md index d4bdd6d4de8a..816d1ddba408 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/readme.md +++ b/specification/cognitiveservices/data-plane/VideoSearch/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/VideoSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/VideoSearch/readme.typescript.md new file mode 100644 index 000000000000..bf3d54000875 --- /dev/null +++ b/specification/cognitiveservices/data-plane/VideoSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-videosearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-videosearch" + override-client-name: VideoSearchAPIClient + azure-arm: false + generate-metadata: true +``` From e691b7f2ca7f278ca36500841501193b33d1850e Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:23:26 -0700 Subject: [PATCH 017/464] Add cognitiveservices\data-plane\VisualSearch\readme.typescript.md (#4286) --- .../data-plane/VisualSearch/readme.md | 2 ++ .../data-plane/VisualSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 15 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/VisualSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/VisualSearch/readme.md b/specification/cognitiveservices/data-plane/VisualSearch/readme.md index 5b0b4d0cb399..cc2205e5e5d1 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/readme.md +++ b/specification/cognitiveservices/data-plane/VisualSearch/readme.md @@ -37,6 +37,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node ``` ## CSharp Settings diff --git a/specification/cognitiveservices/data-plane/VisualSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/VisualSearch/readme.typescript.md new file mode 100644 index 000000000000..643dee2482fe --- /dev/null +++ b/specification/cognitiveservices/data-plane/VisualSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-visualsearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-visualsearch" + override-client-name: VisualSearchAPIClient + azure-arm: false + generate-metadata: true +``` From ab47b0961d06446d761f2ff08c74665887b3a50d Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:24:05 -0700 Subject: [PATCH 018/464] Add cognitiveservices\data-plane\WebSearch\readme.typescript.md (#4287) --- .../data-plane/WebSearch/readme.md | 1 + .../data-plane/WebSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/WebSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/WebSearch/readme.md b/specification/cognitiveservices/data-plane/WebSearch/readme.md index 707ed35c0f41..0a6a1218ba1d 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/readme.md +++ b/specification/cognitiveservices/data-plane/WebSearch/readme.md @@ -33,6 +33,7 @@ This is not used by Autorest itself. swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/WebSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/WebSearch/readme.typescript.md new file mode 100644 index 000000000000..daba5736c70d --- /dev/null +++ b/specification/cognitiveservices/data-plane/WebSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-websearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-websearch" + override-client-name: WebSearchAPIClient + azure-arm: false + generate-metadata: true +``` From 162bd854f188d13913225f0152f804f1e87a8564 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:40:55 -0700 Subject: [PATCH 019/464] Add cognitiveservices\data-plane\ContentModerator\readme.typescript.md (#4272) * Add cognitiveservices\data-plane\ContentModerator\readme.typescript.md * Fix output path --- .../data-plane/ContentModerator/readme.md | 1 + .../data-plane/ContentModerator/readme.typescript.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/ContentModerator/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/ContentModerator/readme.md b/specification/cognitiveservices/data-plane/ContentModerator/readme.md index 3a88fc613123..da130b7701fe 100644 --- a/specification/cognitiveservices/data-plane/ContentModerator/readme.md +++ b/specification/cognitiveservices/data-plane/ContentModerator/readme.md @@ -37,6 +37,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/ContentModerator/readme.typescript.md b/specification/cognitiveservices/data-plane/ContentModerator/readme.typescript.md new file mode 100644 index 000000000000..33ec89d42f2e --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentModerator/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-contentmoderator" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-contentmoderator" + azure-arm: false + generate-metadata: true +``` From a5b926e3283811edcbb123e3bcc26bb2dd4bce4c Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:48:48 -0700 Subject: [PATCH 020/464] Add cognitiveservices\data-plane\CustomImageSearch\readme.typescript.md (#4273) * Add cognitiveservices\data-plane\CustomImageSearch\readme.typescript.md * Fix output path --- .../data-plane/CustomImageSearch/readme.md | 1 + .../CustomImageSearch/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/CustomImageSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md index 4f7e162b6a46..79f9d929de18 100644 --- a/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.md @@ -32,6 +32,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node ``` diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.typescript.md new file mode 100644 index 000000000000..1f27f47e4fff --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-customimagesearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-customimagesearch" + override-client-name: CustomImageSearchAPIClient + azure-arm: false + generate-metadata: true +``` From 0c4f738c9943ac54217ef8656ec1c3d5aeefdce0 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:49:04 -0700 Subject: [PATCH 021/464] Add cognitiveservices/data-plane/AutoSuggest/readme.typescript.md (#4270) * Add cognitiveservices/undefined/readme.typescript.md * Renamt client name --- .../data-plane/AutoSuggest/readme.md | 1 + .../data-plane/AutoSuggest/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/AutoSuggest/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/readme.md b/specification/cognitiveservices/data-plane/AutoSuggest/readme.md index fa68a292805e..fd4d7960c120 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/readme.md +++ b/specification/cognitiveservices/data-plane/AutoSuggest/readme.md @@ -31,6 +31,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-libraries-for-java - repo: azure-sdk-for-go + - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/readme.typescript.md b/specification/cognitiveservices/data-plane/AutoSuggest/readme.typescript.md new file mode 100644 index 000000000000..99f73e05998b --- /dev/null +++ b/specification/cognitiveservices/data-plane/AutoSuggest/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-autosuggest" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-autosuggest" + override-client-name: AutoSuggestClient + azure-arm: false + generate-metadata: true +``` From f121ea1d2629ca51040cfec142b74576f73df110 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:56:08 -0700 Subject: [PATCH 022/464] Add cognitiveservices\data-plane\CustomVision\Prediction\readme.typescript.md (#4275) * Add cognitiveservices\data-plane\CustomVision\Prediction\readme.typescript.md * Fix output path --- .../data-plane/CustomVision/Prediction/readme.md | 1 + .../CustomVision/Prediction/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index f3e3c623891c..0d9677e06268 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -43,6 +43,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-java + - repo: azure-sdk-for-js - repo: azure-sdk-for-node ``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.typescript.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.typescript.md new file mode 100644 index 000000000000..73b67856d051 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-customvision-prediction" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-customvision-prediction" + override-client-name: PredictionAPIClient + azure-arm: false + generate-metadata: true +``` From 835770d81d8601c36966f1041bdcae1882341739 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 18 Oct 2018 15:56:53 -0700 Subject: [PATCH 023/464] Add cognitiveservices\data-plane\CustomVision\Training\readme.typescript.md (#4277) * Add cognitiveservices\data-plane\CustomVision\Training\readme.typescript.md * Fix output path --- .../data-plane/CustomVision/Training/readme.md | 1 + .../CustomVision/Training/readme.typescript.md | 13 +++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md index d9a30544c253..b53e3e43337b 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md @@ -56,6 +56,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-python - repo: azure-sdk-for-java + - repo: azure-sdk-for-js - repo: azure-sdk-for-node ``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.typescript.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.typescript.md new file mode 100644 index 000000000000..e4698ec80216 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-customvision-training" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-customvision-training" + override-client-name: TrainingAPIClient + azure-arm: false + generate-metadata: true +``` From b40870e7c2a461f26fe92771cbb57098d3fd97a5 Mon Sep 17 00:00:00 2001 From: saschein <42913100+saschein@users.noreply.github.com> Date: Fri, 19 Oct 2018 17:47:23 +0300 Subject: [PATCH 024/464] New resource: Add Alert resource type to cost-management (#4056) * Initial Alerts-API commit * Fix validation errors * Additional validation fixes * Fix code-review remarks - Added acknowledged field. - Removed 'acknowledged ' from alert status. * Remove scopeId from alertId * Renamed 'acknowledged' to 'dismissed' after PM change Also fixed a mistake in examples: Acknowledged isn't a valid status anymore. * Removed 'dismissed' field. Added 'dismissed' as an AlertStatus This is due to PM changes. Sorry for the mess. * Update alert definition according to PM changes * Naming fixes for alertType/alertCriteria * Add properties/costEntityId as filter option * MonetaryCommitment renamed to credit * Fix model validator errors --- .../2018-08-01-preview/costmanagement.json | 387 ++++++++++++++++++ .../2018-08-01-preview/examples/Alert.json | 36 ++ .../examples/AlertList.json | 59 +++ 3 files changed, 482 insertions(+) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json index 2af5f5cdfa7a..e737d0fe77a4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json @@ -1732,6 +1732,220 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_List", + "description": "List all alerts for a subscription.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListByResourceGroupName", + "description": "List all alerts for a resource group under a subscription.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetBySubscription", + "description": "Gets the alert for a subscription by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetByResourceGroupName", + "description": "Gets the alert for a resource group under a subscription by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -2636,6 +2850,171 @@ "readOnly": true } } + }, + "AlertListResult": { + "description": "Result of listing alerts. It contains a list of available alerts in the scope provided.", + "properties": { + "value": { + "description": "The list of alerts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Alerts.", + "readOnly": true + } + } + }, + "Alert": { + "type": "object", + "description": "The Alert model definition", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Alert id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Alert name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Alert type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "description": "Alert properties" + } + } + }, + "AlertProperties": { + "description": "The properties of an Alert.", + "properties": { + "costEntityId": { + "description": "The id of the creating cost-entity (budget, invoice, credit).", + "type": "string", + "readOnly": true + }, + "definition": { + "description": "The definition (rule) of an Alert", + "$ref": "#/definitions/AlertDefinition", + "readOnly": true + }, + "description": { + "description": "Description of an alert.", + "type": "string", + "readOnly": true + }, + "scope": { + "description": "The scope of an alert.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "The source of an Alert", + "type": "string", + "enum": [ + "Preset", + "User" + ], + "x-ms-enum": { + "name": "AlertSource", + "modelAsString": true + }, + "readOnly": true + }, + "details": { + "description": "Specific details of an alert - key-value dictionary.", + "x-ms-client-flatten": true, + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "creationTime": { + "format": "date-time", + "description": "The time when the alert was created.", + "type": "string", + "readOnly": true + }, + "closeTime": { + "format": "date-time", + "description": "The time when the alert was closed (resolved / overriden).", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the alert.", + "type": "string", + "enum": [ + "Active", + "Overridden", + "Resolved", + "Dismissed" + ], + "x-ms-enum": { + "name": "AlertStatus", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "AlertDefinition": { + "description": "The definition (rule) of an Alert", + "type": "object", + "properties" : { + "category": { + "description": "Category of the alert.", + "type": "string", + "readOnly": true, + "enum": [ + "Cost", + "Usage", + "Billing" + ], + "x-ms-enum": { + "name": "AlertCategory", + "modelAsString": true + } + }, + "type": { + "description": "The type of cost-entity the alert is defined on.", + "type": "string", + "readOnly": true, + "enum": [ + "Budget", + "Invoice", + "Credit" + ], + "x-ms-enum": { + "name": "AlertType", + "modelAsString": true + } + }, + "criteria": { + "description": "Criteria (condition) of the alert.", + "type": "string", + "readOnly": true, + "enum": [ + "CostThresholdExceeded", + "UsageThresholdExceeded", + "CreditThresholdReached" + ], + "x-ms-enum": { + "name": "AlertCriteria", + "modelAsString": true + } + } + } } }, "parameters": { @@ -2692,6 +3071,14 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "alertIdParameter": { + "name": "alertId", + "in": "path", + "description": "Alert ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json new file mode 100644 index 000000000000..303607957fb9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "01234567-89ab-cdef-0123-456789abcdef", + "resourceGroupName": "rg1", + "alertId": "0e1d6ee7-0052-4996-89e2-023263106885" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/01234567-89ab-cdef-0123-456789abcdef/resourceGroups/rg1/providers/Microsoft.CostManagement/alerts/0e1d6ee7-0052-4996-89e2-023263106885", + "name": "0e1d6ee7-0052-4996-89e2-023263106885", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "This is an example alert", + "source": "User", + "details": { + "amountDue": "500.0", + "billedAmount": "680.36" + }, + "costEntityId": "123", + "creationTime": "2018-09-03T11:21:43.3495582+03:00", + "status": "Active", + "closeTime": "2018-09-10T11:21:43.3495582+03:00" + } + } + } + } + } + + \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json new file mode 100644 index 000000000000..fed8b98dd1dd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "01234567-89ab-cdef-0123-456789abcdef", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/01234567-89ab-cdef-0123-456789abcdef/resourceGroups/rg1/providers/Microsoft.CostManagement/alerts/0e1d6ee7-0052-4996-89e2-023263106885", + "name": "0e1d6ee7-0052-4996-89e2-023263106885", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "This is an example alert", + "source": "User", + "details": { + "amountDue": "500.0", + "billedAmount": "680.36" + }, + "costEntityId": "123", + "creationTime": "2018-09-03T11:21:43.3495582+03:00", + "status": "Resolved", + "closeTime": "2018-09-10T11:21:43.3495582+03:00" + } + }, + { + "id": "/subscriptions/01234567-89ab-cdef-0123-456789abcdef/resourceGroups/rg1/providers/Microsoft.CostManagement/alerts/0e1d6ee7-0052-4996-89e2-023263106454", + "name": "0e1d6ee7-0052-4996-89e2-023263106454", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Credit", + "category": "Billing", + "criteria": "CreditThresholdReached" + }, + "description": "This is another example alert", + "source": "Preset", + "details": { + "amountDue": "500.0", + "billedAmount": "680.36" + }, + "costEntityId": "abc", + "creationTime": "2018-09-03T11:21:43.3495582+03:00", + "status": "Active", + "closeTime": "1970-01-01T00:00:00.0000000+00:00" + } + } + ] + } + } + } + } \ No newline at end of file From c04b00af6791de2ca3e19e62e7ce32074e204793 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Fri, 19 Oct 2018 07:55:47 -0700 Subject: [PATCH 025/464] Add storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md (#4293) * Add storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md * Reset readme.md --- .../Microsoft.StorageDataLake/readme.typescript.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md new file mode 100644 index 000000000000..d81aa4f6b304 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/storage-datalake" + output-folder: "$(typescript-sdks-folder)/packages/@azure/storage-datalake" + generate-metadata: true +``` From 0c56f906561a9c1dbaf77d47693b26bb033c8a14 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Fri, 19 Oct 2018 09:08:11 -0700 Subject: [PATCH 026/464] fix Go SDK codegen for containerservices (#4296) --- specification/containerservices/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerservices/resource-manager/readme.go.md b/specification/containerservices/resource-manager/readme.go.md index c15fd1eae818..e16cb511ada5 100644 --- a/specification/containerservices/resource-manager/readme.go.md +++ b/specification/containerservices/resource-manager/readme.go.md @@ -26,7 +26,7 @@ Please also specify `--go-sdk-folder= Date: Fri, 19 Oct 2018 10:49:04 -0700 Subject: [PATCH 027/464] Cost Analysis Forecast support Preview version (#4290) * Cost Analysis Forecast support Preview version * Foreacast and usage examples - Preview * Correcting columns from rows- Forecast 2018-12-01-preview * Adding new type for forecast and usage - preview * Updating readme for new version - Forecast * Updating comment in readme - Forecast preview --- specification/cost-management/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 6135a098a45c..ade67a1f48e1 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -48,7 +48,7 @@ input-file: ### Tag: package-2018-12-preview -These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. +These settings apply only when `--tag=package-2018-12-preview` is specified on the command line. ``` yaml $(tag) == 'package-2018-12-preview' input-file: From 17fe887af9cc8ef4b44e81e86843a389c2b1bec9 Mon Sep 17 00:00:00 2001 From: Rogelio Delgadillo <35089121+r-delgadillo@users.noreply.github.com> Date: Fri, 19 Oct 2018 13:37:24 -0700 Subject: [PATCH 028/464] [Do not merge] IoTCentral - Add ARM endpoint, update model responses/inputs to align with expected values (#4015) * Fix error model received from ARM * Change model names to be specific to method, add validation to parameter, and send the type of query being requested * Add endpoint to check subdomain availability * Update models to align with expected responses * Fix build errors * Add required field to definitions * Revert model name change. * Remove typo * Update spec file examples * add x-ms-client-flatten to errorSchema * Test default required field for .net SDK * test enum default * revert test changes --- .../examples/Apps_CheckNameAvailability.json | 19 +++- .../Apps_CheckSubdomainAvailability.json | 32 +++++++ .../examples/Apps_CreateOrUpdate.json | 30 +++++- .../2018-09-01/examples/Apps_Delete.json | 24 ++++- .../stable/2018-09-01/examples/Apps_Get.json | 19 +++- .../examples/Apps_ListByResourceGroup.json | 21 +++- .../examples/Apps_ListBySubscription.json | 21 +++- .../2018-09-01/examples/Apps_Update.json | 22 ++++- .../2018-09-01/examples/Operations_List.json | 18 +++- .../stable/2018-09-01/iotcentral.json | 95 +++++++++++++++---- 10 files changed, 268 insertions(+), 33 deletions(-) create mode 100644 specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckSubdomainAvailability.json diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json index be3e48de33fb..daa814b1499f 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckNameAvailability.json @@ -3,15 +3,30 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "api-version": "2018-09-01", "operationInputs": { - "name": "myIoTCentralApp" + "name": "myIoTCentralApp", + "type": "IoTApps" } }, "responses": { "200": { - "headers": {}, + "description": "Returns information about resource name availability", + "headers": { + "code": "200" + }, "body": { "nameAvailable": true } + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } } } } \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckSubdomainAvailability.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckSubdomainAvailability.json new file mode 100644 index 000000000000..1d7bac270480 --- /dev/null +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CheckSubdomainAvailability.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-09-01", + "operationInputs": { + "name": "myIoTCentralApp", + "type": "IoTApps" + } + }, + "responses": { + "200": { + "description": "Returns information about resource subdomain availability", + "headers": { + "code": "200" + }, + "body": { + "nameAvailable": true + } + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } + } + } +} \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json index 08779ed2c704..8416e881acd2 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_CreateOrUpdate.json @@ -16,12 +16,18 @@ }, "responses": { "200": { - "headers": {}, + "header": { + "code": "200", + "message": "OK" + }, "body": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", "name": "myIoTCentralApp", "type": "Microsoft.IoTCentral/IoTApps", "location": "westus", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App 2", @@ -34,12 +40,19 @@ } }, "201": { - "headers": {}, + "headers": { + "code": "201", + "message": "Created", + "target": "ResourceHandler.ExecutePutRequest" + }, "body": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", "name": "myIoTCentralApp", "type": "Microsoft.IoTCentral/IoTApps", "location": "westus", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App", @@ -51,6 +64,17 @@ } } }, - "202": {} + "202": {}, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } + } } } \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json index ea4d3fd59aa4..6cadd187fed0 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Delete.json @@ -6,8 +6,28 @@ "api-version": "2018-09-01" }, "responses": { - "200": {}, + "200": { + "header": { + "code": "200", + "message": "OK", + "target": "ResourceHandler.ExecuteDeleteRequest" + } + }, "202": {}, - "204": {} + "204": {}, + "default": { + "description": "Error message returned for an unexpected response", + "headers": { + "message": "Created", + "code": "200" + }, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } + } } } \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json index 738c93b1e7da..fe6000962120 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Get.json @@ -7,12 +7,18 @@ }, "responses": { "200": { - "headers": {}, + "description": "Returns the application details", + "headers": { + "code": "200" + }, "body": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", "location": "westus", "type": "Microsoft.IoTCentral/IoTApps", "name": "myIoTCentralApp", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App", @@ -23,6 +29,17 @@ "name": "F1" } } + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } } } } \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json index 63d9d00a43c9..d3321d10ea59 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListByResourceGroup.json @@ -6,7 +6,9 @@ }, "responses": { "200": { - "headers": {}, + "headers": { + "code": "200" + }, "body": { "value": [ { @@ -14,6 +16,9 @@ "location": "westus", "type": "Microsoft.IoTCentral/IoTApps", "name": "myIoTCentralApp", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App", @@ -24,7 +29,19 @@ "name": "F1" } } - ] + ], + "nextLink": null + } + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } } } } diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json index a74d0fe95317..6392fc8ad6bb 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_ListBySubscription.json @@ -5,7 +5,9 @@ }, "responses": { "200": { - "headers": {}, + "headers": { + "code": "200" + }, "body": { "value": [ { @@ -13,6 +15,9 @@ "location": "westus", "type": "Microsoft.IoTCentral/IoTApps", "name": "myIoTCentralApp", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App", @@ -23,7 +28,19 @@ "name": "F1" } } - ] + ], + "nextLink": null + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } } } } diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json index cd7ef27c0f02..431b094216d8 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Apps_Update.json @@ -10,12 +10,19 @@ }, "responses": { "200": { - "headers": {}, + "headers": { + "code": "200", + "message": "OK", + "target": "ResourceHandler.ExecutePatchRequest" + }, "body": { "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.IoTCentral/IoTApps/myIoTCentralApp", "location": "westus", "type": "Microsoft.IoTCentral/IoTApps", "name": "myIoTCentralApp", + "tags": { + "key": "value" + }, "properties": { "applicationId": "6ebd8fd3-6e34-419e-908f-9be61ec6f6d6", "displayName": "My IoT Central App 2", @@ -27,6 +34,17 @@ } } }, - "202": {} + "202": {}, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } + } + } } } \ No newline at end of file diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json index 81eac53da335..121472301642 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/examples/Operations_List.json @@ -4,7 +4,9 @@ }, "responses": { "200": { - "headers": {}, + "headers": { + "code": "200" + }, "body": { "value": [ { @@ -52,7 +54,19 @@ "description": "Gets all the available operations on IoT Central Applications" } } - ] + ], + "nextLink": null + } + }, + "default": { + "description": "Error message returned for an unexpected response", + "headers": {}, + "body": { + "error": { + "code": "Error code", + "message": "Error message", + "target": "Error target" + } } } } diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json index 88b9479e2e79..52269cc2dafc 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json @@ -351,7 +351,53 @@ "200": { "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application name is available. If the name is not available, the body contains the reason.", "schema": { - "$ref": "#/definitions/AppNameAvailabilityInfo" + "$ref": "#/definitions/AppAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkSubdomainAvailability": { + "post": { + "tags": [ + "Apps" + ], + "description": "Check if an IoT Central application subdomain is available.", + "operationId": "Apps_CheckSubdomainAvailability", + "x-ms-examples": { + "Apps_SubdomainAvailability": { + "$ref": "./examples/Apps_CheckSubdomainAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the subdomain of the IoT Central application 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 Central application subdomain is available. If the subdomain is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/AppAvailabilityInfo" } }, "default": { @@ -537,22 +583,38 @@ }, "ErrorDetails": { "description": "Error details.", + "properties": { + "error": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "ErrorResponseBody": { + "description": "Details of error response.", "type": "object", "properties": { "code": { - "description": "The error code.", "type": "string", + "description": "The error code.", "readOnly": true }, "message": { - "description": "The error message.", "type": "string", + "description": "The error message.", "readOnly": true }, "target": { - "description": "The target of the particular error.", "type": "string", + "description": "The target of the particular error.", "readOnly": true + }, + "details": { + "type": "array", + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } } } }, @@ -638,15 +700,21 @@ "properties": { "name": { "description": "The name of the IoT Central application instance to check.", - "type": "string" + "type": "string", + "pattern": "^[a-z0-9-]{1,63}$" + }, + "type": { + "description": "The type of the IoT Central resource to query.", + "type": "string", + "default": "IoTApps" } }, "required": [ "name" ] }, - "AppNameAvailabilityInfo": { - "description": "The properties indicating whether a given IoT Central application name is available.", + "AppAvailabilityInfo": { + "description": "The properties indicating whether a given IoT Central application name or subdomain is available.", "type": "object", "properties": { "nameAvailable": { @@ -656,20 +724,13 @@ }, "reason": { "description": "The reason for unavailability.", - "enum": [ - "Invalid", - "AlreadyExists" - ], "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "AppNameUnavailabilityReason", - "modelAsString": false - } + "readOnly": true }, "message": { "description": "The detailed reason message.", - "type": "string" + "type": "string", + "readOnly": true } } } From 6a546714bd197f3fed60973dbf2316cc6e03cb11 Mon Sep 17 00:00:00 2001 From: Qingqing Date: Fri, 19 Oct 2018 14:06:48 -0700 Subject: [PATCH 029/464] Support two apiversion for container service (#4237) * add 2018-08-01-preview * modify readme to support 2 api version for python * change back multp-api, use new api * remove accessprofile and getaccessprofile api, add autoscaler and vmss datamodel * format change to enum * add osMC resource in the readme * modify the example json files * add listcredential api back * fix Go SDK codegen * correct typo and remove default for agentpooltype * change default tag to 2018-09-30-preview * fix Go SDK codegen for containerservices (#4296) * try to put both api in the 2018-08-preview tag * both api in same tag, not working, revert back * udpate tag to lastest version --- .../ManagedClustersCreate_Update.json | 143 ++ .../examples/ManagedClustersDelete.json | 12 + .../examples/ManagedClustersGet.json | 59 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 37 + .../examples/ManagedClustersList.json | 61 + .../ManagedClustersListByResourceGroup.json | 62 + ...edClustersListClusterCredentialResult.json | 20 + .../examples/ManagedClustersUpdateTags.json | 65 + .../2018-08-01-preview/managedClusters.json | 1461 +++++++++++++++++ .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.md | 18 +- 12 files changed, 1969 insertions(+), 2 deletions(-) create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..f5645a6680a1 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": { + }, + "enableRBAC": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..626b101f427e --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..03c3f667f094 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGet.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..dd57b6eb7d55 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..01ace046fdef --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + "1.8.1" + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + "1.8.1" + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json new file mode 100644 index 000000000000..dc874c60ffa6 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersList.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..f213e14f84b9 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..947ec13b2d86 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..1f6284f6f8bb --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json new file mode 100644 index 000000000000..7b8742583380 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json @@ -0,0 +1,1461 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2018-08-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets upgrade profile for a managed cluster.", + "description": "Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Gets clusteradmin credential of a managed cluster.", + "description": "Gets clusteradmin credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Gets clusteruser credential of a managed cluster.", + "description": "Gets clusteruser credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "description": "Gets the details of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "Parameters supplied to the Create or Update a Managed Cluster operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "description": "Updates a managed cluster with the specified tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "description": "Deletes the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Compute Operation Value Display." + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 1023, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfile": { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group." + }, + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the vnet's subnet identifier." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "Maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "maxCount":{ + "type": "integer", + "format": "int32", + "description": "Maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of nodes for auto-scaling" + }, + "enableAutoScaling":{ + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "type": { + "$ref": "#/definitions/AgentPoolType", + "description": "AgentPoolType represents types of agentpool" + } + }, + "required": [ + "name", + "vmSize", + "count" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType":{ + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true + }, + "description": "AgentPoolType represents types of agentpool" + }, + "ContainerServiceWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername", + "adminPassword" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true + }, + "description": "Network plugin used for building Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true + }, + "description": "Network policy used for building Kubernetes network." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + } + }, + "description": "Profile of network configuration." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "kubernetesVersion": { + "type": "string", + "description": "Version of Kubernetes specified when creating the managed cluster." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix specified when creating the managed cluster." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FDQN for the master pool." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Profile for Linux VMs in the container service cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "Profile of managed cluster add-on." + }, + "nodeResourceGroup": { + "readOnly": true, + "type": "string", + "description": "Name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "Profile of network configuration." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "Profile of Azure Active Directory configuration." + } + }, + "description": "Properties of the managed cluster." + }, + "OrchestratorProfile": { + "properties": { + "orchestratorType": { + "type": "string", + "description": "Orchestrator type." + }, + "orchestratorVersion": { + "type": "string", + "description": "Orchestrator version (major, minor, patch)." + } + }, + "required": [ + "orchestratorType", + "orchestratorVersion" + ], + "description": "Contains information about orchestrator." + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "name": { + "type": "string", + "description": "Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAADProfile": { + "properties": { + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "required": [ + "clientAppID", + "serverAppID" + ], + "description": "AADProfile specifies attributes for Azure Active Directory integration." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "Properties of upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "CredentialResults":{ + "properties": { + "kubeconfigs": { + "type" : "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + } + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name":{ + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/containerservices/resource-manager/readme.go.md b/specification/containerservices/resource-manager/readme.go.md index e16cb511ada5..15265b63ac8f 100644 --- a/specification/containerservices/resource-manager/readme.go.md +++ b/specification/containerservices/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-09-30-preview + - tag: package-2018-08-preview - tag: package-2018-03 - tag: package-2017-09 - tag: package-2017-08 @@ -29,6 +30,16 @@ namespace: containerservice output-folder: $(go-sdk-folder)/services/preview/containerservice/mgmt/2018-09-30-preview/containerservice ``` +### Tag: package-2018-08-preview and go + +These settings apply only when `--package-2018-08-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-08-preview' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/preview/containerservice/mgmt/2018-08-01-preview/containerservice +``` + ### Tag: package-2018-03 and go These settings apply only when `--tag=package-2018-03 --go` is specified on the command line. diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index fa3b702e8477..b183ed137293 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -34,7 +34,19 @@ These are the global settings for the ContainerServices API. ```yaml openapi-type: arm -tag: package-2018-09-30-preview +tag: package-2018-08-preview +``` + +### Tag: package-2018-08-preview + +These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08-preview' +input-file: +- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json +- Microsoft.ContainerService/stable/2017-07-01/containerService.json +- Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json +- Microsoft.ContainerService/stable/2017-09-30/location.json ``` ### Tag: package-2018-09-30-preview @@ -171,14 +183,16 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.containerservice package-name: azure-mgmt-containerservice - package-version: 4.3.0 + package-version: 4.3.1 clear-output-folder: true ``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true From 0f13c27a6127ab51187790450d80a2a69d864f36 Mon Sep 17 00:00:00 2001 From: Ian Ross Date: Fri, 19 Oct 2018 22:54:43 +0100 Subject: [PATCH 030/464] dedicatedhsm: fix invalid references in readme.md (#4242) Correct references to KeyVault in readme.md --- .../hardwaresecuritymodules/resource-manager/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index 663979be018a..3b81dbae6a45 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -22,7 +22,7 @@ To see additional help and options, run: ### Basic Information -These are the global settings for the KeyVault API. +These are the global settings for the Hardware Security Modules API. ``` yaml openapi-type: arm @@ -36,7 +36,7 @@ These settings apply only when `--tag=package-2018-10` is specified on the comma ``` yaml $(tag) == 'package-2018-10' input-file: -- Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/keyvault.json +- Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json ``` From 8c6f982d5f51cf9a173b4e098ae3f8b39d8d327d Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Fri, 19 Oct 2018 16:12:35 -0700 Subject: [PATCH 031/464] moved VNet, IpFilter rules and Kafka from 2018-preview to 2017 API version (#4246) --- .../stable/2017-04-01/EventHub.json | 710 +++++++++++++++--- .../EHNameSpaceIPFilterRuleListAll.json | 26 + ...EHNameSpaceIpFilterRuleCreateorUpdate.json | 30 + .../EHNameSpaceIpFilterRuleDelete.json | 13 + .../EHNameSpaceIpFilterRuleGet.json | 23 + .../EHNameSpaceIpFilterRuleUpdate.json | 30 + ...SpaceVirtualNetworkRuleCreateorUpdate.json | 26 + .../EHNameSpaceVirtualNetworkRuleDelete.json | 13 + .../EHNameSpaceVirtualNetworkRuleGet.json | 21 + .../EHNameSpaceVirtualNetworkRuleListAll.json | 24 + .../EHNameSpaceVirtualNetworkRuleupdate.json | 26 + 11 files changed, 827 insertions(+), 115 deletions(-) create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json index ff43617d3d09..a61419e0a5db 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json @@ -160,7 +160,7 @@ "description": "Lists the available Namespaces within a resource group.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -200,10 +200,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -260,10 +260,10 @@ "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -302,10 +302,10 @@ "description": "Gets the description of the specified namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -346,10 +346,10 @@ "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -404,10 +404,10 @@ "description": "Gets messaging plan for specified namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -444,10 +444,10 @@ "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -487,13 +487,13 @@ "description": "Creates or updates an AuthorizationRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -537,13 +537,13 @@ "description": "Deletes an AuthorizationRule for a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -578,13 +578,13 @@ "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -621,13 +621,13 @@ "description": "Gets the primary and secondary connection strings for the Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -664,13 +664,13 @@ "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -722,10 +722,10 @@ "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "name": "parameters", @@ -765,10 +765,10 @@ "description": "Gets all Alias(Disaster Recovery configurations)", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -808,13 +808,13 @@ "description": "Creates or updates a new Alias(Disaster Recovery configuration)", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "name": "parameters", @@ -861,13 +861,13 @@ "description": "Deletes an Alias(Disaster Recovery configuration)", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -899,13 +899,13 @@ "description": "Retrieves Alias(Disaster Recovery configuration) for primary or secondary namespace", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -942,13 +942,13 @@ "description": "This operation disables the Disaster Recovery and stops replicating changes from primary to secondary namespaces", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -982,13 +982,13 @@ "description": "envokes GEO DR failover and reconfigure the alias to point to the secondary namespace", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1022,13 +1022,13 @@ "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1068,16 +1068,16 @@ "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1114,16 +1114,16 @@ "description": "Gets the primary and secondary connection strings for the Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/aliasNameParameter" + "$ref": "#/parameters/AliasNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1160,10 +1160,10 @@ "description": "Gets all the Event Hubs in a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1209,13 +1209,13 @@ "description": "Creates or updates a new Event Hub as a nested resource within a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { "name": "parameters", @@ -1259,13 +1259,13 @@ "description": "Deletes an Event Hub from the specified Namespace and resource group.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1300,13 +1300,13 @@ "description": "Gets an Event Hubs description for the specified Event Hub.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1343,13 +1343,13 @@ "description": "Gets the authorization rules for an Event Hub.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1389,16 +1389,16 @@ "description": "Creates or updates an AuthorizationRule for the specified Event Hub.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -1442,16 +1442,16 @@ "description": "Gets an AuthorizationRule for an Event Hub by rule name.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1486,16 +1486,16 @@ "description": "Deletes an Event Hub AuthorizationRule.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1532,16 +1532,16 @@ "description": "Gets the ACS and SAS connection strings for the Event Hub.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1578,16 +1578,16 @@ "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/authorizationRuleNameParameter" + "$ref": "#/parameters/AuthorizationRuleNameParameter" }, { "name": "parameters", @@ -1633,16 +1633,16 @@ "description": "Creates or updates an Event Hubs consumer group as a nested resource within a Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/consumerGroupNameParameter" + "$ref": "#/parameters/ConsumerGroupNameParameter" }, { "name": "parameters", @@ -1686,16 +1686,16 @@ "description": "Deletes a consumer group from the specified Event Hub and resource group.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/consumerGroupNameParameter" + "$ref": "#/parameters/ConsumerGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1730,16 +1730,16 @@ "description": "Gets a description for the specified consumer group.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { - "$ref": "#/parameters/consumerGroupNameParameter" + "$ref": "#/parameters/ConsumerGroupNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1776,13 +1776,13 @@ "description": "Gets all the consumer groups in a Namespace. An empty feed is returned if no consumer group exists in the Namespace.", "parameters": [ { - "$ref": "#/parameters/resourceGroupNameParameter" + "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "$ref": "#/parameters/namespaceNameParameter" + "$ref": "#/parameters/NamespaceNameParameter" }, { - "$ref": "#/parameters/eventHubNameParameter" + "$ref": "#/parameters/EventHubNameParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1835,7 +1835,7 @@ "$ref": "#/parameters/SubscriptionIdParameter" }, { - "$ref": "#/parameters/skuNameParameter" + "$ref": "#/parameters/SkuNameParameter" } ], "responses": { @@ -1856,6 +1856,376 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListIPFilterRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" + } + }, + "description": "Gets a list of IP Filter rules for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully returned.", + "schema": { + "$ref": "#/definitions/IpFilterRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleCreate": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "The Namespace IpFilterRule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule created", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleDelete": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" + } + }, + "description": "Deletes an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace IpFilterRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleGet": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" + } + }, + "description": "Gets an IpFilterRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/IPFilterRuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule returned successfully.", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListVirtualNetworkRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" + } + }, + "description": "Gets a list of VirtualNetwork rules for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully returned.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The Namespace VirtualNetworkRule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule created", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleDelete": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" + } + }, + "description": "Deletes an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace VirtualNetworkRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" + } + }, + "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/VirtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule returned successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -1972,6 +2342,10 @@ "maximum": 20, "minimum": 0, "description": "Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." } }, "description": "Namespace properties supplied for create namespace operation." @@ -2604,6 +2978,94 @@ } ], "description": "Messaging Plan for the namespace" + }, + "IpFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Accept", + "Reject" + ], + "x-ms-enum": { + "name": "IPAction", + "modelAsString": true + } + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get IpFilterRules operation" + }, + "IpFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List IpFilter Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "VirtualNetworkRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "ARM ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get VirtualNetworkRules operation" + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Result of the List VirtualNetwork Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" + } + }, + "description": "The response from the List namespace operation." } }, "parameters": { @@ -2621,7 +3083,7 @@ "type": "string", "description": "Client API Version." }, - "resourceGroupNameParameter": { + "ResourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", "required": true, @@ -2631,7 +3093,7 @@ "x-ms-parameter-location": "method", "description": "Name of the resource group within the azure subscription." }, - "namespaceNameParameter": { + "NamespaceNameParameter": { "name": "namespaceName", "in": "path", "required": true, @@ -2641,7 +3103,7 @@ "x-ms-parameter-location": "method", "description": "The Namespace name" }, - "authorizationRuleNameParameter": { + "AuthorizationRuleNameParameter": { "name": "authorizationRuleName", "in": "path", "required": true, @@ -2650,7 +3112,7 @@ "x-ms-parameter-location": "method", "description": "The authorization rule name." }, - "eventHubNameParameter": { + "EventHubNameParameter": { "name": "eventHubName", "in": "path", "required": true, @@ -2659,7 +3121,7 @@ "x-ms-parameter-location": "method", "description": "The Event Hub name" }, - "aliasNameParameter": { + "AliasNameParameter": { "name": "alias", "in": "path", "required": true, @@ -2669,7 +3131,7 @@ "x-ms-parameter-location": "method", "description": "The Disaster Recovery configuration name" }, - "consumerGroupNameParameter": { + "ConsumerGroupNameParameter": { "name": "consumerGroupName", "in": "path", "required": true, @@ -2679,7 +3141,7 @@ "x-ms-parameter-location": "method", "description": "The consumer group name" }, - "skuNameParameter": { + "SkuNameParameter": { "name": "sku", "in": "path", "required": true, @@ -2708,6 +3170,24 @@ "minimum": 1, "maximum": 1000, "x-ms-parameter-location": "method" + }, + "IPFilterRuleNameParameter": { + "name": "ipFilterRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The IP Filter Rule name." + }, + "VirtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The Virtual Network Rule name." } } } \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json new file mode 100644 index 000000000000..58f7d161de90 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json new file mode 100644 index 000000000000..0021793cc4ad --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337", + "parameters": { + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json new file mode 100644 index 000000000000..4b921fa62918 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337" + }, + "responses": { + "200": { }, + "204": { } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json new file mode 100644 index 000000000000..30970870562b --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5232", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json new file mode 100644 index 000000000000..b7a5a6803a03 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-5849", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "ipFilterRuleName": "sdk-IPFilterRules-7337", + "parameters": { + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", + "name": "sdk-IPFilterRules-7337", + "type": "Microsoft.EventHub/Namespaces/IpFilterRules", + "properties": { + "ipMask": "13.78.143.246/32", + "action": "Accept", + "filterName": "sdk-IPFilterRules-7337" + } + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json new file mode 100644 index 000000000000..75d21c9265a5 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", + "parameters": { + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json new file mode 100644 index 000000000000..bd3dd401c8d3 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" + }, + "responses": { + "200": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json new file mode 100644 index 000000000000..6c05fa0cf72f --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json new file mode 100644 index 000000000000..d5ba67e22ce3 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json new file mode 100644 index 000000000000..2bf72dee2cf0 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "Subscription", + "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", + "parameters": { + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", + "name": "sdk-VirtualNetworkRules-9191", + "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", + "properties": { + "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" + } + } + } + } +} \ No newline at end of file From 6a18dba85784f7231edc79ba8b6a8679e0cf72f9 Mon Sep 17 00:00:00 2001 From: Tom FitzMacken Date: Sun, 21 Oct 2018 14:47:36 -0700 Subject: [PATCH 032/464] added to description of allowed characters for resource group name (#4297) * added to description of allowed characters for resource group name * changed description --- .../Microsoft.Resources/stable/2018-05-01/resources.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index 59f7d6482884..aeffab711b42 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -1022,7 +1022,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group to create or update.", + "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.", "pattern": "^[-\\w\\._\\(\\)]+$", "minLength": 1, "maxLength": 90 From 5f594f3fdc0e6acc8e7b4abef716f7433252e969 Mon Sep 17 00:00:00 2001 From: quintinb Date: Sun, 21 Oct 2018 17:55:41 -0400 Subject: [PATCH 033/464] Added missing discriminator property to MediaJobOutput (#4260) --- .../Microsoft.Media/stable/2018-01-01/MediaServices.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json index c77a8a7d8431..41e7886333ec 100644 --- a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json @@ -276,7 +276,12 @@ "description": "Details of JobOutput errors." }, "MediaJobOutput": { + "discriminator": "@odata.type", "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, "error": { "$ref": "#/definitions/MediaJobError", "description": "Gets the Job output error." From 2eb14e615b7bb7eff5398df577ae5a0d481699bf Mon Sep 17 00:00:00 2001 From: Sirajudeen Sahul Hameed Date: Mon, 22 Oct 2018 10:13:29 -0700 Subject: [PATCH 034/464] Adding provisionAfterExtensions property for extension sequencing (#4300) --- .../stable/2018-06-01/compute.json | 21 +++++++++++++++++++ .../stable/2018-10-01/compute.json | 21 +++++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index c2ff7a68849b..6c53984eae2b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -4618,6 +4618,13 @@ "instanceView": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView", "description": "The virtual machine extension instance view." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -4651,6 +4658,13 @@ "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -7067,6 +7081,13 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 6cd417649100..6191c5328b58 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -4618,6 +4618,13 @@ "instanceView": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView", "description": "The virtual machine extension instance view." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -4651,6 +4658,13 @@ "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -7082,6 +7096,13 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." From c6ba1af32134d86c761017eeaeb67141af4185f3 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Mon, 22 Oct 2018 10:21:22 -0700 Subject: [PATCH 035/464] Revert "Adding provisionAfterExtensions property for extension sequencing (#4300)" (#4304) This reverts commit 2eb14e615b7bb7eff5398df577ae5a0d481699bf. --- .../stable/2018-06-01/compute.json | 21 ------------------- .../stable/2018-10-01/compute.json | 21 ------------------- 2 files changed, 42 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index 6c53984eae2b..c2ff7a68849b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -4618,13 +4618,6 @@ "instanceView": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView", "description": "The virtual machine extension instance view." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -4658,13 +4651,6 @@ "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -7081,13 +7067,6 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 6191c5328b58..6cd417649100 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -4618,13 +4618,6 @@ "instanceView": { "$ref": "#/definitions/VirtualMachineExtensionInstanceView", "description": "The virtual machine extension instance view." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -4658,13 +4651,6 @@ "protectedSettings": { "type": "object", "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Extension." @@ -7096,13 +7082,6 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." - }, - "provisionAfterExtensions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." From 903552a0dfea9bbbe677286a20d88401037cba3e Mon Sep 17 00:00:00 2001 From: caoyihua Date: Tue, 23 Oct 2018 02:46:27 +0800 Subject: [PATCH 036/464] Add new storage endpoints in Fabric (#4255) --- .../preview/2018-10-01/Drive.json | 250 ++++++++++++++++++ .../preview/2018-10-01/StorageSubSystem.json | 213 +++++++++++++++ .../preview/2018-10-01/Volume.json | 231 ++++++++++++++++ .../2018-10-01/examples/Drive/Get.json | 38 +++ .../2018-10-01/examples/Drive/List.json | 41 +++ .../examples/StorageSubSystem/Get.json | 29 ++ .../examples/StorageSubSystem/List.json | 32 +++ .../2018-10-01/examples/Volume/Get.json | 33 +++ .../2018-10-01/examples/Volume/List.json | 36 +++ .../resource-manager/fabric/readme.md | 27 ++ 10 files changed, 930 insertions(+) create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Drive.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Volume.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/Get.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/List.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/Get.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/List.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/Get.json create mode 100644 specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/List.json diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Drive.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Drive.json new file mode 100644 index 000000000000..b9ed0827fcbc --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Drive.json @@ -0,0 +1,250 @@ +{ + "swagger": "2.0", + "info": { + "description": "Drive operation endpoints and objects.", + "title": "FabricAdminClient", + "version": "2018-10-01" + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/drives/{drive}": { + "get": { + "x-ms-examples": { + "Return the requested a storage drive.": { + "$ref": "./examples/Drive/Get.json" + } + }, + "tags": [ + "Drives" + ], + "description": "Return the requested a storage drive.", + "operationId": "Drives_Get", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "StorageSubSystem.json#/parameters/StorageSubSystemParameter" + }, + { + "$ref": "#/parameters/DriveParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Drive" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/drives": { + "get": { + "x-ms-examples": { + "Returns a list of all storage drives at a location.": { + "$ref": "./examples/Drive/List.json" + } + }, + "tags": [ + "Drives" + ], + "description": "Returns a list of all storage drives at a location.", + "operationId": "Drives_List", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "StorageSubSystem.json#/parameters/StorageSubSystemParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DriveList" + } + }, + "404": { + "description": "NOT FOUND" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Drive" + } + } + }, + "definitions": { + "Drive": { + "description": "Representation of a drive resource.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of a drive.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DriveModel" + } + }, + "allOf": [ + { + "$ref": "../2016-05-01/Fabric.json#/definitions/Resource" + } + ] + }, + "DriveModel": { + "description": "Properties of a drive.", + "type": "object", + "properties": { + "storageNode": { + "description": "Node that the drive is physically connected.", + "type": "string" + }, + "serialNumber": { + "description": "Serial number of the drive.", + "type": "string" + }, + "healthStatus": { + "description": "Health status of the drive.", + "type": "string" + }, + "operationalStatus": { + "description": "Operational status of the drive.", + "type": "string" + }, + "usage": { + "description": "Intended usage of the drive.", + "type": "string" + }, + "canPool": { + "description": "Indicate whether the drive can be added to the pool.", + "type": "boolean" + }, + "cannotPoolReason": { + "description": "Specify the reasons why the drive cannot be added to the pool.", + "type": "string" + }, + "physicalLocation": { + "description": "Indicate where the hardware is located.", + "type": "string" + }, + "model": { + "description": "Model of the drive.", + "type": "string" + }, + "mediaType": { + "description": "Media type of the drive.", + "type": "string" + }, + "capacityGB": { + "description": "Total capacity in GB of the drive.", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "Detailed description for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.", + "type": "string" + }, + "action": { + "description": "Detailed recommended action for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.", + "type": "string" + } + } + }, + "DriveList": { + "description": "Pageable list of storage drives.", + "type": "object", + "properties": { + "value": { + "description": "List of storage drives.", + "type": "array", + "items": { + "$ref": "#/definitions/Drive" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API Version.", + "required": true, + "type": "string", + "default": "2018-10-01" + }, + "DriveParameter": { + "name": "drive", + "description": "Name of the storage drive.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json new file mode 100644 index 000000000000..b715de11502e --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json @@ -0,0 +1,213 @@ +{ + "swagger": "2.0", + "info": { + "description": "Storage subsystem operation endpoints and objects.", + "title": "FabricAdminClient", + "version": "2018-10-01" + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}": { + "get": { + "x-ms-examples": { + "Return the requested storage subsystem.": { + "$ref": "./examples/StorageSubSystem/Get.json" + } + }, + "tags": [ + "StorageSubSystems" + ], + "description": "Return the requested storage subsystem.", + "operationId": "StorageSubSystems_Get", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "#/parameters/StorageSubSystemParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageSubSystem" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems": { + "get": { + "x-ms-examples": { + "Returns a list of all storage subsystems for a location.": { + "$ref": "./examples/StorageSubSystem/List.json" + } + }, + "tags": [ + "StorageSubSystems" + ], + "description": "Returns a list of all storage subsystems for a location.", + "operationId": "StorageSubSystems_List", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageSubSystemList" + } + }, + "404": { + "description": "NOT FOUND" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/StorageSubSystem" + } + } + }, + "definitions": { + "StorageSubSystem": { + "description": "Representation of a storage system resource.", + "type": "object", + "properties": { + "properties": { + "description": "All properties of a storage subsystem.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSubSystemModel" + } + }, + "allOf": [ + { + "$ref": "../2016-05-01/Fabric.json#/definitions/Resource" + } + ] + }, + "StorageSubSystemModel": { + "description": "All properties of a storage subsystem.", + "type": "object", + "properties": { + "totalCapacityGB": { + "description": "Total capacity in GB of the subsystem.", + "type": "integer", + "format": "int32" + }, + "remainingCapacityGB": { + "description": "Remaining capacity in GB of the subsystem.", + "type": "integer", + "format": "int32" + }, + "healthStatus": { + "description": "Health status of the subsystem.", + "type": "string" + }, + "operationalStatus": { + "description": "Operational status of the subsystem.", + "type": "string" + }, + "rebalanceStatus": { + "description": "Rebalance status of the subsystem.", + "type": "string" + } + } + }, + "StorageSubSystemList": { + "description": "Pageable list of storage systems.", + "type": "object", + "properties": { + "value": { + "description": "List of storage systems.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageSubSystem" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API Version.", + "required": true, + "type": "string", + "default": "2018-10-01" + }, + "StorageSubSystemParameter": { + "name": "storageSubSystem", + "description": "Name of the storage system.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Volume.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Volume.json new file mode 100644 index 000000000000..0927196ad10b --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/Volume.json @@ -0,0 +1,231 @@ +{ + "swagger": "2.0", + "info": { + "description": "Volume operation endpoints and objects.", + "title": "FabricAdminClient", + "version": "2018-10-01" + }, + "host": "adminmanagement.local.azurestack.external", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/volumes/{volume}": { + "get": { + "x-ms-examples": { + "Return the requested a storage volume.": { + "$ref": "./examples/Volume/Get.json" + } + }, + "tags": [ + "Volumes" + ], + "description": "Return the requested a storage volume.", + "operationId": "Volumes_Get", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "StorageSubSystem.json#/parameters/StorageSubSystemParameter" + }, + { + "$ref": "#/parameters/VolumeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Volume" + } + }, + "404": { + "description": "NOT FOUND" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnits/{scaleUnit}/storageSubSystems/{storageSubSystem}/volumes": { + "get": { + "x-ms-examples": { + "Returns a list of all storage volumes at a location.": { + "$ref": "./examples/Volume/List.json" + } + }, + "tags": [ + "Volumes" + ], + "description": "Returns a list of all storage volumes at a location.", + "operationId": "Volumes_List", + "parameters": [ + { + "$ref": "../2016-05-01/Fabric.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/LocationParameter" + }, + { + "$ref": "../2016-05-01/ScaleUnit.json#/parameters/ScaleUnitParameter" + }, + { + "$ref": "StorageSubSystem.json#/parameters/StorageSubSystemParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../2016-05-01/Fabric.json#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeList" + } + }, + "404": { + "description": "NOT FOUND" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/Volume" + } + } + }, + "definitions": { + "Volume": { + "description": "Representation of a volume resource.", + "type": "object", + "properties": { + "properties": { + "description": "Properties of a volume.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeModel" + } + }, + "allOf": [ + { + "$ref": "../2016-05-01/Fabric.json#/definitions/Resource" + } + ] + }, + "VolumeModel": { + "description": "Properties of a volume.", + "type": "object", + "properties": { + "totalCapacityGB": { + "description": "Total capacity in GB of the volume.", + "format": "int32", + "type": "integer" + }, + "remainingCapacityGB": { + "description": "Remaining capacity in GB of the volume.", + "format": "int32", + "type": "integer" + }, + "healthStatus": { + "description": "Health status of the volume.", + "type": "string" + }, + "operationalStatus": { + "description": "Operational status of the volume.", + "type": "string" + }, + "repairStatus": { + "description": "Repair status of the volume. Empty if no repair job running, something like 'Running, 90%' when repairing.", + "type": "string" + }, + "description": { + "description": "Detailed description for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.", + "type": "string" + }, + "action": { + "description": "Detailed recommended action for HealthStatus/OperationalStatus. Empty if HealthStatus/OperationalStatus is Healthy/Ok.", + "type": "string" + }, + "volumeLabel": { + "description": "Volume label.", + "type": "string" + } + } + }, + "VolumeList": { + "description": "Pageable list of storage volumes.", + "type": "object", + "properties": { + "value": { + "description": "List of storage volumes.", + "type": "array", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "nextLink": { + "description": "URI to the next page.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client API Version.", + "required": true, + "type": "string", + "default": "2018-10-01" + }, + "VolumeParameter": { + "name": "volume", + "description": "Name of the storage volume.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Authorization uses an Azure Active Directory OAuth2 flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/Get.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/Get.json new file mode 100644 index 000000000000..a9440efcf9b0 --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster", + "storageSubSystem": "S-Cluster.azurestack.local", + "drive": "14848052-5f5d-4206-97a5-2f7b1ed41705" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local/drives/fafadf46-ce35-8e64-aa57-8b0be39d7c64", + "name": "fafadf46-ce35-8e64-aa57-8b0be39d7c64", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/drives", + "location": "local", + "tags": {}, + "properties": { + "storageNode":"local/HC1n22r0409", + "serialNumber":"S2CXNAAH200330", + "healthStatus":"Healthy", + "operationalStatus":"OK", + "usage":"Journal", + "canPool":false, + "cannotPoolReason":"In a Pool", + "physicalLocation":"Slot 0", + "model":"MZ7KM1T6HAJM00D3", + "mediaType":"SSD", + "capacityGB":1490, + "description":"", + "action":"" + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/List.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/List.json new file mode 100644 index 000000000000..74a8ba0a0381 --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Drive/List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster", + "storageSubSystem": "S-Cluster.azurestack.local" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local/drives/fafadf46-ce35-8e64-aa57-8b0be39d7c64", + "name": "fafadf46-ce35-8e64-aa57-8b0be39d7c64", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/drives", + "location": "local", + "tags": {}, + "properties": { + "storageNode":"local/HC1n22r0409", + "serialNumber":"S2CXNAAH200330", + "healthStatus":"Healthy", + "operationalStatus":"OK", + "usage":"Journal", + "canPool":false, + "cannotPoolReason":"In a Pool", + "physicalLocation":"Slot 0", + "model":"MZ7KM1T6HAJM00D3", + "mediaType":"SSD", + "capacityGB":1490, + "description":"", + "action":"" + } + } + ] + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/Get.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/Get.json new file mode 100644 index 000000000000..65a3e946870b --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster", + "storageSubSystem": "S-Cluster.azurestack.local" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local", + "name": "S-Cluster.azurestack.local", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems", + "location": "local", + "tags": {}, + "properties": { + "totalCapacityGB":30797, + "remainingCapacityGB":30451, + "healthStatus":"Healthy", + "operationalStatus":"OK", + "rebalanceStatus":"" + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/List.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/List.json new file mode 100644 index 000000000000..faa95c9df171 --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/StorageSubSystem/List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local", + "name": "S-Cluster.azurestack.local", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems", + "location": "local", + "tags": {}, + "properties": { + "totalCapacityGB":30797, + "remainingCapacityGB":30451, + "healthStatus":"Healthy", + "operationalStatus":"OK", + "rebalanceStatus":"" + } + } + ] + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/Get.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/Get.json new file mode 100644 index 000000000000..9440458726d7 --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster", + "storageSubSystem": "S-Cluster.azurestack.local", + "volume": "28fbffa4" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local/volumes/05c1cbb7", + "name": "05c1cbb7", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/volumes", + "location": "local", + "tags": {}, + "properties": { + "totalCapacityGB":30797, + "remainingCapacityGB":30416, + "healthStatus":"Healthy", + "operationalStatus":"OK", + "repairStatus":"", + "description":"", + "action":"", + "volumeLabel":"SU1_Volume" + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/List.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/List.json new file mode 100644 index 000000000000..115d8ff470d4 --- /dev/null +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2018-10-01/examples/Volume/List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName" : "System.local", + "location": "local", + "scaleUnit": "S-Cluster", + "storageSubSystem": "S-Cluster.azurestack.local" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/36e98cad-c8a5-4580-bef7-af878a237908/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster/storageSubSystems/S-Cluster.azurestack.local/volumes/05c1cbb7", + "name": "05c1cbb7", + "type": "Microsoft.Fabric.Admin/fabricLocations/scaleUnits/storageSubSystems/volumes", + "location": "local", + "tags": {}, + "properties": { + "totalCapacityGB":30797, + "remainingCapacityGB":30416, + "healthStatus":"Healthy", + "operationalStatus":"OK", + "repairStatus":"", + "description":"", + "action":"", + "volumeLabel":"SU1_Volume" + } + } + ] + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/fabric/readme.md b/specification/azsadmin/resource-manager/fabric/readme.md index 5f705a27939e..3f94f6cf565d 100644 --- a/specification/azsadmin/resource-manager/fabric/readme.md +++ b/specification/azsadmin/resource-manager/fabric/readme.md @@ -52,6 +52,33 @@ input-file: - "Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json" ``` +### Tag: package-2018-10-01 + +These settings apply only when `--tag=package-2018-10-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10-01' +input-file: + - "Microsoft.Fabric.Admin/preview/2016-05-01/Fabric.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGateway.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/EdgeGatewayPool.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/FabricLocation.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/FileShare.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/InfraRoleInstance.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/IpPool.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/LogicalNetwork.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/StoragePool.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/StorageSystem.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/MacAddressPool.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnit.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnitNode.json" + - "Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json" + - "Microsoft.Fabric.Admin/preview/2018-10-01/Drive.json" + - "Microsoft.Fabric.Admin/preview/2018-10-01/StorageSubSystem.json" + - "Microsoft.Fabric.Admin/preview/2018-10-01/Volume.json" +``` + --- # Code Generation From b1063a32027da2b8b36242d2de124a6344f2bc58 Mon Sep 17 00:00:00 2001 From: Vipul Modi - MSFT Date: Mon, 22 Oct 2018 11:47:56 -0700 Subject: [PATCH 037/464] Swagger specification and examples for Service Fabric Mesh 2018-09-01-preview release. (#4292) --- .../examples/applications/create_update.json | 94 + .../examples/applications/delete.json | 15 + .../examples/applications/get.json | 30 + .../applications/list_byResourceGroup.json | 33 + .../applications/list_bySubscriptionId.json | 32 + .../examples/applications/services/get.json | 55 + .../examples/applications/services/list.json | 58 + .../replicas/codepackages/get_logs.json | 20 + .../applications/services/replicas/get.json | 77 + .../applications/services/replicas/list.json | 80 + .../examples/gateways/create_update.json | 205 + .../examples/gateways/delete.json | 15 + .../examples/gateways/get.json | 79 + .../gateways/list_byResourceGroup.json | 82 + .../gateways/list_bySubscriptionId.json | 81 + .../examples/networks/create_update.json | 54 + .../examples/networks/delete.json | 15 + .../examples/networks/get.json | 28 + .../networks/list_byResourceGroup.json | 31 + .../networks/list_bySubscriptionId.json | 30 + .../examples/secrets/create_update.json | 54 + .../examples/secrets/delete.json | 15 + .../examples/secrets/get.json | 28 + .../secrets/list_byResourceGroup.json | 31 + .../secrets/list_bySubscriptionId.json | 30 + .../examples/secrets/values/create.json | 44 + .../examples/secrets/values/delete.json | 16 + .../examples/secrets/values/get.json | 25 + .../examples/secrets/values/list.json | 38 + .../examples/secrets/values/list_value.json | 18 + .../examples/volumes/create_update.json | 64 + .../examples/volumes/delete.json | 15 + .../examples/volumes/get.json | 31 + .../volumes/list_byResourceGroup.json | 34 + .../volumes/list_bySubscriptionId.json | 33 + .../2018-09-01-preview/servicefabricmesh.json | 3954 +++++++++++++++++ .../resource-manager/readme.go.md | 9 + .../resource-manager/readme.md | 26 +- .../resource-manager/readme.ruby.md | 11 + 39 files changed, 5589 insertions(+), 1 deletion(-) create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json create mode 100644 specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json new file mode 100644 index 000000000000..e188c663b7a8 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/create_update.json @@ -0,0 +1,94 @@ +{ + "operationId": "Application_Create", + "description": "This example shows how to create or update a application resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication", + "applicationResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample application.", + "services": [ + { + "name": "helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1 + } + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Unknown", + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json new file mode 100644 index 000000000000..205e16efce73 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Application_Delete", + "description": "This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json new file mode 100644 index 000000000000..2f9a5185acb8 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/get.json @@ -0,0 +1,30 @@ +{ + "operationId": "Application_Get", + "description": "This example shows how to get a application resource. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json new file mode 100644 index 000000000000..2e50bf4aa84d --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_byResourceGroup.json @@ -0,0 +1,33 @@ +{ + "operationId": "Application_ListByResourceGroup", + "description": "This example shows how to list all application resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json new file mode 100644 index 000000000000..a56a76d0ff46 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/list_bySubscriptionId.json @@ -0,0 +1,32 @@ +{ + "operationId": "Application_ListBySubscriptionId", + "description": "This example shows how to list all application resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/applications", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication", + "name": "sampleApplication", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample application.", + "healthState": "Ok", + "serviceNames": [ + "helloWorldService" + ], + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json new file mode 100644 index 000000000000..cfa074561a1a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/get.json @@ -0,0 +1,55 @@ +{ + "operationId": "Service_Get", + "description": "This example shows how to get a service resource for a given application. If the service resource exists, its description is returned along with an OK (200) status code. If the service resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json new file mode 100644 index 000000000000..817b3a17f087 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/list.json @@ -0,0 +1,58 @@ +{ + "operationId": "Service_List", + "description": "This example shows how to list all services of a given application.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "helloWorldService", + "type": "Microsoft.ServiceFabricMesh/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/applications/sampleApplication/services/helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json new file mode 100644 index 000000000000..252b978ba6a0 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/codepackages/get_logs.json @@ -0,0 +1,20 @@ +{ + "operationId": "CodePackage_GetContainerLogs", + "description": "This example shows how to get logs from the container of service replica. If the container exists, the logs are returned with an OK (200) status code, otherwise an error is returned with an appropriate status code.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "6.4-preview", + "applicationResourceName": "sbzDocApp", + "serviceResourceName": "sbzDocService", + "replicaName": "0", + "codePackageName": "sbzDocCode" + }, + "responses": { + "200": { + "body": { + "content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n" + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json new file mode 100644 index 000000000000..7389c169983e --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/get.json @@ -0,0 +1,77 @@ +{ + "operationId": "ServiceReplica_Get", + "description": "This example shows how to get information about given replica of a service. If the replica exists, its description is returned along with an OK (200) status code. If the replica does not exist, an error is returned with an appropriate status code.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-09-01-privatepreview", + "applicationResourceName": "helloWorldApp", + "serviceResourceName": "helloWorldService", + "replicaName": "0" + }, + "responses": { + "200": { + "body": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json new file mode 100644 index 000000000000..50148c55f025 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/applications/services/replicas/list.json @@ -0,0 +1,80 @@ +{ + "operationId": "ServiceReplica_List", + "description": "This example shows how to list replicas of a service resources for a given application.", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "api-version": "2018-09-01-privatepreview", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + }, + "events": [ + { + "count": 3, + "firstTimestamp": "2018-04-05T22:37:20.9016844", + "lastTimestamp": "2018-04-06T06:36:06.0887046", + "name": "Created", + "message": "Container created and started.", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2018-04-06T06:34:00.6622454", + "lastTimestamp": "2018-04-06T06:34:00.6622454", + "name": "Stopped", + "message": "Container was stopped.", + "type": "Normal" + } + ] + } + } + ], + "networkRefs": [ + { + "name": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json new file mode 100644 index 000000000000..f623636e7819 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/create_update.json @@ -0,0 +1,205 @@ +{ + "operationId": "Gateway_Create", + "description": "This example shows how to create or update a gateway resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway", + "gatewayResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ] + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json new file mode 100644 index 000000000000..f5b6f1ddb8b7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Gateway_Delete", + "description": "This example shows how to delete an existing gateway resource. If the gateway resource exists and is deleted successfully, an empty response with 200 status code is returned. If the gateway resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json new file mode 100644 index 000000000000..64d47ec975df --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/get.json @@ -0,0 +1,79 @@ +{ + "operationId": "Gateway_Get", + "description": "This example shows how to get a gateway resource. If the gateway resource exists, its description is returned along with an OK (200) status code. If the gateway resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json new file mode 100644 index 000000000000..daab5de4a032 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_byResourceGroup.json @@ -0,0 +1,82 @@ +{ + "operationId": "Gateway_ListByResourceGroup", + "description": "This example shows how to list all gateway resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json new file mode 100644 index 000000000000..350701ab1b44 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/gateways/list_bySubscriptionId.json @@ -0,0 +1,81 @@ +{ + "operationId": "Gateway_ListBySubscriptionId", + "description": "This example shows how to list all gateway resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/gateways", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/gateways/sampleGateway", + "name": "sampleGateway", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "ipAddress": "192.168.1.1", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json new file mode 100644 index 000000000000..48b660c8af57 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/create_update.json @@ -0,0 +1,54 @@ +{ + "operationId": "Network_Create", + "description": "This example shows how to create or update a network resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork", + "networkResourceDescription": { + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16" + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json new file mode 100644 index 000000000000..cd3c9786f256 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Network_Delete", + "description": "This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json new file mode 100644 index 000000000000..e8704f6ac183 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/get.json @@ -0,0 +1,28 @@ +{ + "operationId": "Network_Get", + "description": "This example shows how to get a network resource. If the network resource exists, its description is returned along with an OK (200) status code. If the network resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json new file mode 100644 index 000000000000..616292b2b942 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_byResourceGroup.json @@ -0,0 +1,31 @@ +{ + "operationId": "Network_ListByResourceGroup", + "description": "This example shows how to list all network resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json new file mode 100644 index 000000000000..88ee368b5fcf --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/networks/list_bySubscriptionId.json @@ -0,0 +1,30 @@ +{ + "operationId": "Network_ListBySubscriptionId", + "description": "This example shows how to list all network resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/networks", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/networks/sampleNetwork", + "name": "sampleNetwork", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json new file mode 100644 index 000000000000..c3525487a294 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/create_update.json @@ -0,0 +1,54 @@ +{ + "operationId": "Secret_Create", + "description": "This example shows how to create or update a secret resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretResourceDescription": { + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!" + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json new file mode 100644 index 000000000000..a89e0f733d00 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Secret_Delete", + "description": "This example shows how to delete an existing secret resource. If the secret resource exists and is deleted successfully, an empty response with 200 status code is returned. If the secret resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json new file mode 100644 index 000000000000..e76e9a529def --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/get.json @@ -0,0 +1,28 @@ +{ + "operationId": "Secret_Get", + "description": "This example shows how to get a secret resource. If the secret resource exists, its description is returned along with an OK (200) status code. If the secret resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json new file mode 100644 index 000000000000..65461234ce69 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_byResourceGroup.json @@ -0,0 +1,31 @@ +{ + "operationId": "Secret_ListByResourceGroup", + "description": "This example shows how to list all secret resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json new file mode 100644 index 000000000000..428077057c95 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/list_bySubscriptionId.json @@ -0,0 +1,30 @@ +{ + "operationId": "Secret_ListBySubscriptionId", + "description": "This example shows how to list all secret resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/secrets", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString", + "name": "dbConnectionString", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json new file mode 100644 index 000000000000..a6f5a1c433b8 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/create.json @@ -0,0 +1,44 @@ +{ + "operationId": "SecretValue_Create", + "description": "This example shows how to add a new value of a secret resource; the secret value is provided as plaintext.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1", + "secretValueResourceDescription": { + "name": "v1", + "properties": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + }, + "responses": { + "200": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + }, + "201": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Updating", + "value": null + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json new file mode 100644 index 000000000000..73049985da4f --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/delete.json @@ -0,0 +1,16 @@ +{ + "operationId": "SecretValue_Delete", + "description": "This example shows how to delete a secret value. If the specified named value exists and is deleted successfully, an empty response with 200 status code is returned. If the specified named value does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json new file mode 100644 index 000000000000..21c1c187b1a0 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/get.json @@ -0,0 +1,25 @@ +{ + "operationId": "SecretValue_Get", + "description": "This example shows how to get the specified secret value resource. If the specified named value exists, its information is returned along with status code 200. The information does not include the value. To get the unecnrypted value use SecretValue_ListValue operation. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json new file mode 100644 index 000000000000..e1c83162d8a7 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list.json @@ -0,0 +1,38 @@ +{ + "operationId": "SecretValue_List", + "description": "This example shows how to list names of all values of a secret resource, not including their respective values.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v1", + "name": "v1", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + }, + { + "type": "secrets/values", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/secrets/dbConnectionString/values/v2", + "name": "v2", + "properties": { + "provisioningState": "Succeeded", + "value": null + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json new file mode 100644 index 000000000000..df2530b182cd --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/secrets/values/list_value.json @@ -0,0 +1,18 @@ +{ + "operationId": "SecretValue_ListValue", + "description": "This example shows how to get the unencrypted value of the secret. If the specified named value resource exists, its unencrypted value is returned along with status code 200. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json new file mode 100644 index 000000000000..26eae959a25f --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/create_update.json @@ -0,0 +1,64 @@ +{ + "operationId": "Volume_Create", + "description": "This example shows how to create or update a volume resource.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume", + "volumeResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + }, + "provider": "SFAzureFile" + }, + "tags": {}, + "location": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + }, + "201": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json new file mode 100644 index 000000000000..f4cee9a52f41 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "Volume_Delete", + "description": "This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exit, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json new file mode 100644 index 000000000000..fd4da47a9a43 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/get.json @@ -0,0 +1,31 @@ +{ + "operationId": "Volume_Get", + "description": "This example shows how to get a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json new file mode 100644 index 000000000000..2377230e774a --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_byResourceGroup.json @@ -0,0 +1,34 @@ +{ + "operationId": "Volume_ListByResourceGroup", + "description": "This example shows how to list all volume resources within a specified resource group.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "sbz_demo" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json new file mode 100644 index 000000000000..bc4c893d9def --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/examples/volumes/list_bySubscriptionId.json @@ -0,0 +1,33 @@ +{ + "operationId": "Volume_ListBySubscriptionId", + "description": "This example shows how to list all volume resources for a specified subscription.", + "parameters": { + "api-version": "2018-09-01-privatepreview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabricMesh/volumes", + "location": "EastUS", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/sbz_demo/providers/Microsoft.ServiceFabricMesh/volumes/sampleVolume", + "name": "sampleVolume", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "description": "Service Fabric Mesh sample volume.", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "shareName": "sharel" + }, + "provider": "SFAzureFile", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json new file mode 100644 index 000000000000..b9904d27b2c4 --- /dev/null +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json @@ -0,0 +1,3954 @@ +{ + "swagger": "2.0", + "info": { + "title": "SeaBreezeManagementClient", + "description": "APIs to deploy and manage resources to SeaBreeze.", + "version": "2018-09-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/providers/Microsoft.ServiceFabricMesh/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available operations.", + "description": "Lists all the available operations provided by Service Fabric SeaBreeze resource provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}": { + "put": { + "operationId": "Secret_Create", + "x-ms-examples": { + "CreateOrUpdateSecret": { + "$ref": "./examples/secrets/create_update.json" + } + }, + "summary": "Creates or updates a secret resource.", + "description": "Creates a secret resource with the specified name, description and properties. If a secret resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Secret_Get", + "x-ms-examples": { + "GetSecret": { + "$ref": "./examples/secrets/get.json" + } + }, + "summary": "Gets the secret resource with the given name.", + "description": "Gets the information about the secret resource with the given name. The information include the description and other properties of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Secret_Delete", + "x-ms-examples": { + "DeleteSecret": { + "$ref": "./examples/secrets/delete.json" + } + }, + "summary": "Deletes the secret resource.", + "description": "Deletes the secret resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified secret was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets": { + "get": { + "operationId": "Secret_ListByResourceGroup", + "x-ms-examples": { + "ListSecretsByResourceGroup": { + "$ref": "./examples/secrets/list_byResourceGroup.json" + } + }, + "summary": "Gets all the secret resources in a given resource group.", + "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/secrets": { + "get": { + "operationId": "Secret_ListBySubscription", + "x-ms-examples": { + "ListSecretsBySubscriptionId": { + "$ref": "./examples/secrets/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the secret resources in a given subscription.", + "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Secrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}": { + "put": { + "operationId": "SecretValue_Create", + "x-ms-examples": { + "CreateSecretValue": { + "$ref": "./examples/secrets/values/create.json" + } + }, + "summary": "Adds the specified value as a new version of the specified secret resource.", + "description": "Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "SecretValue_Get", + "x-ms-examples": { + "GetSecretValue": { + "$ref": "./examples/secrets/values/get.json" + } + }, + "summary": "Gets the specified secret value resource.", + "description": "Get the information about the specified named secret value resources. The information does not include the actual value of the secret.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "SecretValue_Delete", + "x-ms-examples": { + "DeleteSecretValue": { + "$ref": "./examples/secrets/values/delete.json" + } + }, + "summary": "Deletes the specified value of the named secret resource.", + "description": "Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified named secret value was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values": { + "get": { + "operationId": "SecretValue_List", + "x-ms-examples": { + "ListSecretValues": { + "$ref": "./examples/secrets/values/list.json" + } + }, + "summary": "List names of all values of the the specified secret resource.", + "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/secrets/{secretResourceName}/values/{secretValueResourceName}/list_value": { + "post": { + "operationId": "SecretValue_ListValue", + "x-ms-examples": { + "ListSecretValue": { + "$ref": "./examples/secrets/values/list_value.json" + } + }, + "summary": "Lists the specified value of the secret resource.", + "description": "Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "SecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValue" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes/{volumeResourceName}": { + "put": { + "operationId": "Volume_Create", + "x-ms-examples": { + "CreateOrUpdateVolume": { + "$ref": "./examples/volumes/create_update.json" + } + }, + "summary": "Creates or updates a volume resource.", + "description": "Creates a volume resource with the specified name, description and properties. If a volume resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Volume_Get", + "x-ms-examples": { + "GetVolume": { + "$ref": "./examples/volumes/get.json" + } + }, + "summary": "Gets the volume resource with the given name.", + "description": "Gets the information about the volume resource with the given name. The information include the description and other properties of the volume.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Volume_Delete", + "x-ms-examples": { + "DeleteVolume": { + "$ref": "./examples/volumes/delete.json" + } + }, + "summary": "Deletes the volume resource.", + "description": "Deletes the volume resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListByResourceGroup", + "x-ms-examples": { + "ListVolumesByResourceGroup": { + "$ref": "./examples/volumes/list_byResourceGroup.json" + } + }, + "summary": "Gets all the volume resources in a given resource group.", + "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/volumes": { + "get": { + "operationId": "Volume_ListBySubscription", + "x-ms-examples": { + "ListVolumesBySubscriptionId": { + "$ref": "./examples/volumes/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the volume resources in a given subscription.", + "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the volume.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Volumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkResourceName}": { + "put": { + "operationId": "Network_Create", + "x-ms-examples": { + "CreateOrUpdateNetwork": { + "$ref": "./examples/networks/create_update.json" + } + }, + "summary": "Creates or updates a network resource.", + "description": "Creates a network resource with the specified name, description and properties. If a network resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Network_Get", + "x-ms-examples": { + "GetNetwork": { + "$ref": "./examples/networks/get.json" + } + }, + "summary": "Gets the network resource with the given name.", + "description": "Gets the information about the network resource with the given name. The information include the description and other properties of the network.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Network_Delete", + "x-ms-examples": { + "DeleteNetwork": { + "$ref": "./examples/networks/delete.json" + } + }, + "summary": "Deletes the network resource.", + "description": "Deletes the network resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified network was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListByResourceGroup", + "x-ms-examples": { + "ListNetworksByResourceGroup": { + "$ref": "./examples/networks/list_byResourceGroup.json" + } + }, + "summary": "Gets all the network resources in a given resource group.", + "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks": { + "get": { + "operationId": "Network_ListBySubscription", + "x-ms-examples": { + "ListNetworksBySubscriptionId": { + "$ref": "./examples/networks/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the network resources in a given subscription.", + "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the network.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Networks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways/{gatewayResourceName}": { + "put": { + "operationId": "Gateway_Create", + "x-ms-examples": { + "CreateOrUpdateGateway": { + "$ref": "./examples/gateways/create_update.json" + } + }, + "summary": "Creates or updates a gateway resource.", + "description": "Creates a gateway resource with the specified name, description and properties. If a gateway resource with the same name exists, then it is updated with the specified description and properties. Use gateway resources to create a gateway for public connectivity for services within your application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Gateway_Get", + "x-ms-examples": { + "GetGateway": { + "$ref": "./examples/gateways/get.json" + } + }, + "summary": "Gets the gateway resource with the given name.", + "description": "Gets the information about the gateway resource with the given name. The information include the description and other properties of the gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Gateway_Delete", + "x-ms-examples": { + "DeleteGateway": { + "$ref": "./examples/gateways/delete.json" + } + }, + "summary": "Deletes the gateway resource.", + "description": "Deletes the gateway resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified gateway was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/gateways": { + "get": { + "operationId": "Gateway_ListByResourceGroup", + "x-ms-examples": { + "ListGatewaysByResourceGroup": { + "$ref": "./examples/gateways/list_byResourceGroup.json" + } + }, + "summary": "Gets all the gateway resources in a given resource group.", + "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/gateways": { + "get": { + "operationId": "Gateway_ListBySubscription", + "x-ms-examples": { + "ListGatewaysBySubscriptionId": { + "$ref": "./examples/gateways/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the gateway resources in a given subscription.", + "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the gateway.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Gateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}": { + "put": { + "operationId": "Application_Create", + "x-ms-examples": { + "CreateOrUpdateApplication": { + "$ref": "./examples/applications/create_update.json" + } + }, + "summary": "Creates or updates an application resource.", + "description": "Creates an application resource with the specified name, description and properties. If an application resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-sf-codegen": { + "Powershell": { + "skipGeneration": "true" + } + } + }, + "get": { + "operationId": "Application_Get", + "x-ms-examples": { + "GetApplication": { + "$ref": "./examples/applications/get.json" + } + }, + "summary": "Gets the application resource with the given name.", + "description": "Gets the information about the application resource with the given name. The information include the description and other properties of the application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "operationId": "Application_Delete", + "x-ms-examples": { + "DeleteApplication": { + "$ref": "./examples/applications/delete.json" + } + }, + "summary": "Deletes the application resource.", + "description": "Deletes the application resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListByResourceGroup", + "x-ms-examples": { + "ListApplicationsByResourceGroup": { + "$ref": "./examples/applications/list_byResourceGroup.json" + } + }, + "summary": "Gets all the application resources in a given resource group.", + "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/applications": { + "get": { + "operationId": "Application_ListBySubscription", + "x-ms-examples": { + "ListApplicationsBySubscriptionId": { + "$ref": "./examples/applications/list_bySubscriptionId.json" + } + }, + "summary": "Gets all the application resources in a given subscription.", + "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the application.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + } + ], + "tags": [ + "Applications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}": { + "get": { + "operationId": "Service_Get", + "x-ms-examples": { + "GetService": { + "$ref": "./examples/applications/services/get.json" + } + }, + "summary": "Gets the service resource with the given name.", + "description": "Gets the information about the service resource with the given name. The information include the description and other properties of the service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services": { + "get": { + "operationId": "Service_List", + "x-ms-examples": { + "ListServices": { + "$ref": "./examples/applications/services/list.json" + } + }, + "summary": "Lists all the service resources.", + "description": "Gets the information about all services of an application resource. The information include the description and other properties of the Service.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "Services" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}": { + "get": { + "operationId": "ServiceReplica_Get", + "x-ms-examples": { + "ReplicaGet": { + "$ref": "./examples/applications/services/replicas/get.json" + } + }, + "summary": "Gets the given replica of the service of an application.", + "description": "Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "ServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas": { + "get": { + "operationId": "ServiceReplica_List", + "x-ms-examples": { + "ReplicasGetAll": { + "$ref": "./examples/applications/services/replicas/list.json" + } + }, + "summary": "Gets replicas of a given service.", + "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "ServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/applications/{applicationResourceName}/services/{serviceResourceName}/replicas/{replicaName}/codePackages/{codePackageName}/logs": { + "get": { + "operationId": "CodePackage_GetContainerLogs", + "x-ms-examples": { + "GetContainerLogs": { + "$ref": "./examples/applications/services/replicas/codepackages/get_logs.json" + } + }, + "summary": "Gets the logs from the container.", + "description": "Gets the logs for the container of the specified code package of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResourceGroupNameRequiredPathParam" + }, + { + "$ref": "#/parameters/api-versionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "CodePackages" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "ResourceStatus": { + "description": "Status of the resource.", + "type": "string", + "enum": [ + "Unknown", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the resource status is unknown. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the resource is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the resource is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the resource is being created. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the resource is being deletd. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5." + } + ] + } + }, + "HealthState": { + "type": "string", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "AvailableOperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "Name of the operation provider." + }, + "resource": { + "type": "string", + "description": "Name of the resource on which the operation is available." + }, + "operation": { + "type": "string", + "description": "Name of the available operation." + }, + "description": { + "type": "string", + "description": "Description of the available operation." + } + }, + "description": "An operation available at the listed Azure resource provider." + }, + "ErrorModel": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorErrorModel", + "description": "Error model information" + } + }, + "description": "The error details.", + "required": [ + "error" + ] + }, + "ErrorErrorModel": { + "description": "Error model information", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string", + "description": "Error message." + }, + "innerError": { + "type": "string" + }, + "details": { + "type": "array", + "description": "List of error message details.", + "items": { + "$ref": "#/definitions/ErrorDetailsModel" + } + } + }, + "required": [ + "code" + ] + }, + "ErrorDetailsModel": { + "description": "Error model details information", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "description": "List of Service Fabric operations supported by the Microsoft.ServiceFabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric operations." + }, + "OperationResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of operations available at the listed Azure resource provider." + }, + "ProvisionedResourceProperties": { + "description": "Describes common properties of a provisioned resource.", + "properties": { + "provisioningState": { + "type": "string", + "description": "State of the resource.", + "readOnly": true + } + } + }, + "ProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ManagedProxyResource": { + "description": "The resource model definition for Azure Resource Manager proxy resource. It will have everything other than required location and tags. This proxy resource is explicitly created or updated by including it in the parent resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "Resource": { + "description": "The resource model definition for Azure Resource Manager resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}", + "x-ms-mutability": [ + "read" + ] + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource", + "x-ms-mutability": [ + "read" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.", + "x-ms-mutability": [ + "read" + ] + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for Azure Resource Manager tracked top-level resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + }, + "required": [ + "location" + ] + }, + "SecretKind": { + "type": "string", + "description": "Describes the kind of secret.", + "enum": [ + "inlinedValue" + ], + "x-ms-enum": { + "name": "SecretKind", + "modelAsString": true, + "values": [ + { + "value": "inlinedValue", + "description": "A simple secret resource whose plaintext value is provided by the user." + } + ] + } + }, + "SecretResourceProperties": { + "description": "Describes the properties of a secret resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretResourcePropertiesBase" + } + ], + "properties": { + "description": { + "description": "User readable description of the secret.", + "type": "string" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the secret." + }, + "contentType": { + "type": "string", + "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed." + } + } + }, + "InlinedValueSecretResourceProperties": { + "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.", + "allOf": [ + { + "$ref": "#/definitions/SecretResourceProperties" + } + ], + "x-ms-discriminator-value": "inlinedValue" + }, + "SecretResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a secret resource, including its kind.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/SecretKind", + "description": "Describes the kind of secret." + } + }, + "required": [ + "kind" + ] + }, + "SecretResourceDescription": { + "description": "This type describes a secret resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecretResourceProperties", + "description": "Describes the properties of a secret resource." + } + }, + "required": [ + "properties" + ] + }, + "SecretResourceDescriptionList": { + "description": "A pageable list of secret resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "SecretValue": { + "type": "object", + "description": "This type represents the unencrypted value of the secret.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueProperties": { + "type": "object", + "description": "This type describes properties of secret value resource.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueResourceProperties": { + "description": "This type describes properties of a secret value resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/SecretValueProperties" + } + ] + }, + "SecretValueResourceDescription": { + "description": "This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretValueResourceProperties", + "description": "This type describes properties of a secret value resource." + } + }, + "required": [ + "properties" + ] + }, + "SecretValueResourceDescriptionList": { + "description": "A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unecrypted value.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretValueResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "VolumeProperties": { + "description": "Describes properties of a volume resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the volume." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the volume." + }, + "provider": { + "$ref": "#/definitions/VolumeProvider", + "description": "Provider of the volume." + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProvider": { + "type": "string", + "description": "Describes the provider of the volume resource.", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true, + "values": [ + { + "value": "SFAzureFile", + "description": "Provides volumes that are backed by Azure Files." + } + ] + } + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "properties": { + "accountName": { + "description": "Name of the Azure storage account for the File Share.", + "type": "string" + }, + "accountKey": { + "description": "Access key of the Azure storage account for the File Share.", + "type": "string" + }, + "shareName": { + "description": "Name of the Azure Files file share that provides storage for the volume.", + "type": "string" + } + }, + "required": [ + "accountName", + "shareName" + ] + }, + "VolumeReference": { + "description": "Describes a reference to a volume resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume being referenced." + }, + "readOnly": { + "type": "boolean", + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "ApplicationScopedVolume": { + "description": "Describes a volume whose lifetime is scoped to the application's lifetime.", + "allOf": [ + { + "$ref": "#/definitions/VolumeReference" + } + ], + "properties": { + "creationParameters": { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters", + "description": "Describes parameters for creating application-scoped volumes." + } + }, + "required": [ + "creationParameters" + ] + }, + "ApplicationScopedVolumeCreationParameters": { + "description": "Describes parameters for creating application-scoped volumes.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/ApplicationScopedVolumeKind", + "description": "Specifies the application-scoped volume kind." + }, + "description": { + "description": "User readable description of the volume.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": { + "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks", + "allOf": [ + { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters" + } + ], + "properties": { + "sizeDisk": { + "description": "Volume size", + "type": "string", + "enum": [ + "Small", + "Medium", + "Large" + ], + "x-ms-enum": { + "name": "SizeTypes", + "modelAsString": true + } + } + }, + "required": [ + "sizeDisk" + ], + "x-ms-discriminator-value": "ServiceFabricVolumeDisk" + }, + "ApplicationScopedVolumeKind": { + "description": "Specifies the application-scoped volume kind.", + "type": "string", + "enum": [ + "ServiceFabricVolumeDisk" + ], + "x-ms-enum": { + "name": "ApplicationScopedVolumeKind", + "modelAsString": true, + "values": [ + { + "value": "ServiceFabricVolumeDisk", + "description": "Provides Service Fabric High Availability Volume Disk" + } + ] + } + }, + "VolumeResourceProperties": { + "description": "This type describes properties of a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/VolumeProperties" + } + ] + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeResourceProperties", + "description": "This type describes properties of a volume resource." + } + }, + "required": [ + "properties" + ] + }, + "VolumeResourceDescriptionList": { + "description": "A pageable list of volume resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VolumeResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "NetworkKind": { + "type": "string", + "description": "The type of a Service Fabric container network.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "NetworkKind", + "modelAsString": true, + "values": [ + { + "value": "Local", + "description": "Indicates a container network local to a single Service Fabric cluster. The value is 1." + } + ] + } + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourcePropertiesBase" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the network." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the network." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the network." + } + } + }, + "LocalNetworkResourceProperties": { + "description": "Information about a Service Fabric container network local to a single Service Fabric cluster.", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourceProperties" + } + ], + "x-ms-discriminator-value": "Local", + "properties": { + "networkAddressPrefix": { + "$ref": "#/definitions/NetworkAddressPrefix", + "description": "Address space for the local container network." + } + } + }, + "NetworkAddressPrefix": { + "type": "string", + "description": "Address space for a container network. This is expressed in CIDR notation." + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network" + }, + "endpointRefs": { + "description": "A list of endpoints that are exposed on this network.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointRef" + } + } + } + }, + "EndpointRef": { + "description": "Describes a reference to a service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint." + } + } + }, + "NetworkResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a network resource, including its kind.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/NetworkKind", + "description": "The type of a Service Fabric container network." + } + }, + "required": [ + "kind" + ] + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "properties" + ] + }, + "NetworkResourceDescriptionList": { + "description": "A pageable list of network resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "GatewayDestination": { + "description": "Describes destination endpoint for routing traffic.", + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Name of the service fabric Mesh application." + }, + "serviceName": { + "type": "string", + "description": "service that contains the endpoint." + }, + "endpointName": { + "type": "string", + "description": "name of the endpoint in the service." + } + }, + "required": [ + "applicationName", + "endpointName", + "serviceName" + ] + }, + "GatewayProperties": { + "description": "Describes properties of a gateway resource.", + "properties": { + "description": { + "description": "User readable description of the gateway.", + "type": "string" + }, + "sourceNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network the gateway should listen on for requests." + }, + "destinationNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network that the Application is using." + }, + "tcp": { + "description": "Configuration for tcp connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/TcpConfig" + } + }, + "http": { + "description": "Configuration for http connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpConfig" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the gateway." + }, + "ipAddress": { + "readOnly": true, + "type": "string", + "description": "IP address of the gateway. This is populated in the response and is ignored for incoming requests." + } + }, + "required": [ + "destinationNetwork", + "sourceNetwork" + ] + }, + "HttpConfig": { + "description": "Describes the http configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "hosts": { + "type": "array", + "description": "description for routing.", + "items": { + "$ref": "#/definitions/HttpHostConfig" + } + } + }, + "required": [ + "hosts", + "name", + "port" + ] + }, + "HttpHostConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http hostname config name." + }, + "routes": { + "type": "array", + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can hamdle general cases.", + "items": { + "$ref": "#/definitions/HttpRouteConfig" + } + } + }, + "required": [ + "name", + "routes" + ] + }, + "HttpRouteConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http route name." + }, + "match": { + "$ref": "#/definitions/HttpRouteMatchRule", + "description": "Describes a rule for http route matching." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "match", + "name" + ] + }, + "HttpRouteMatchHeader": { + "description": "Describes header information for http route matching.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of header to match in request." + }, + "value": { + "type": "string", + "description": "Value of header to match in request." + }, + "type": { + "type": "string", + "description": "how to match header value", + "enum": [ + "exact" + ], + "x-ms-enum": { + "name": "HeaderMatchType", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "HttpRouteMatchPath": { + "description": "Path to match for routing.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Uri path to match for request." + }, + "rewrite": { + "type": "string", + "description": "replacement string for matched part of the Uri." + }, + "type": { + "type": "string", + "description": "how to match value in the Uri", + "enum": [ + "prefix" + ], + "x-ms-enum": { + "name": "PathMatchType", + "modelAsString": true + } + } + }, + "required": [ + "type", + "value" + ] + }, + "HttpRouteMatchRule": { + "description": "Describes a rule for http route matching.", + "type": "object", + "properties": { + "path": { + "$ref": "#/definitions/HttpRouteMatchPath", + "description": "Path to match for routing." + }, + "headers": { + "type": "array", + "description": "headers and their values to match in request.", + "items": { + "$ref": "#/definitions/HttpRouteMatchHeader" + } + } + }, + "required": [ + "path" + ] + }, + "TcpConfig": { + "description": "Describes the tcp configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "tcp gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "name", + "port" + ] + }, + "GatewayResourceProperties": { + "description": "This type describes properties of a gateway resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/GatewayProperties" + } + ] + }, + "GatewayResourceDescription": { + "description": "This type describes a gateway resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayResourceProperties", + "description": "This type describes properties of a gateway resource." + } + }, + "required": [ + "properties" + ] + }, + "GatewayResourceDescriptionList": { + "description": "A pageable list of gateway resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ApplicationProperties": { + "description": "Describes properties of a application resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the application." + }, + "services": { + "type": "array", + "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + }, + "debugParams": { + "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment.", + "type": "string" + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the application." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application." + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." + } + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "allOf": [ + { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + ], + "x-ms-discriminator-value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva.", + "properties": { + "accountName": { + "description": "Azure Internal monitoring pipeline account.", + "type": "string" + }, + "namespace": { + "description": "Azure Internal monitoring pipeline account namespace.", + "type": "string" + }, + "maConfigUrl": { + "description": "Azure Internal monitoring agent configuration.", + "type": "string" + }, + "fluentdConfigUrl": { + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", + "type": "string" + } + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "properties": { + "sinks": { + "description": "List of supported sinks that can be referenced.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "defaultSinkRefs": { + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsRef": { + "description": "Reference to sinks in DiagnosticsDescription.", + "properties": { + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "sinkRefs": { + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsSinkKind": { + "type": "string", + "description": "The kind of DiagnosticsSink.", + "enum": [ + "Invalid", + "AzureInternalMonitoringPipeline" + ], + "x-ms-enum": { + "name": "DiagnosticsSinkKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva." + } + ] + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/DiagnosticsSinkKind", + "description": "The kind of DiagnosticsSink." + }, + "name": { + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", + "type": "string" + }, + "description": { + "description": "A description of the sink.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "ApplicationResourceProperties": { + "description": "This type describes properties of an application resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ApplicationProperties" + } + ] + }, + "ApplicationResourceDescription": { + "description": "This type describes an application resource.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties", + "description": "This type describes properties of an application resource." + } + }, + "required": [ + "properties" + ] + }, + "ApplicationResourceDescriptionList": { + "description": "A pageable list of application resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "AddRemoveReplicaScalingMechanism": { + "description": "Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMechanism" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AddRemoveReplica", + "properties": { + "minCount": { + "type": "integer", + "description": "Minimum number of containers (scale down won't be performed below this number)." + }, + "maxCount": { + "type": "integer", + "description": "Maximum number of containers (scale up won't be performed above this number)." + }, + "scaleIncrement": { + "type": "integer", + "description": "Each time auto scaling is performed, this number of containers will be added or removed." + } + }, + "required": [ + "minCount", + "maxCount", + "scaleIncrement" + ] + }, + "AutoScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMechanismKind", + "description": "The type of auto scaling mechanism." + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMechanismKind": { + "type": "string", + "description": "Enumerates the mechanisms for auto scaling.", + "enum": [ + "AddRemoveReplica" + ], + "x-ms-enum": { + "name": "AutoScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "AddRemoveReplica", + "description": "Indicates that scaling should be performed by adding or removing replicas." + } + ] + } + }, + "AutoScalingMetric": { + "type": "object", + "discriminator": "kind", + "description": "Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMetricKind", + "description": "The type of auto scaling metric" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMetricKind": { + "type": "string", + "description": "Enumerates the metrics that are used for triggering auto scaling.", + "enum": [ + "Resource" + ], + "x-ms-enum": { + "name": "AutoScalingMetricKind", + "modelAsString": true, + "values": [ + { + "value": "Resource", + "description": "Indicates that the metric is one of resources, like cpu or memory." + } + ] + } + }, + "AutoScalingPolicy": { + "description": "Describes the auto scaling policy", + "type": "object", + "properties": { + "name": { + "description": "The name of the auto scaling policy.", + "type": "string" + }, + "trigger": { + "$ref": "#/definitions/AutoScalingTrigger", + "description": "Determines when auto scaling operation will be invoked." + }, + "mechanism": { + "$ref": "#/definitions/AutoScalingMechanism", + "description": "The mechanism that is used to scale when auto scaling operation is invoked." + } + }, + "required": [ + "name", + "trigger", + "mechanism" + ] + }, + "AutoScalingResourceMetric": { + "description": "Describes the resource that is used for triggering auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMetric" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "Resource", + "properties": { + "name": { + "$ref": "#/definitions/AutoScalingResourceMetricName", + "description": "Name of the resource." + } + }, + "required": [ + "name" + ] + }, + "AutoScalingResourceMetricName": { + "type": "string", + "description": "Enumerates the resources that are used for triggering auto scaling.", + "enum": [ + "cpu", + "memoryInGB" + ], + "x-ms-enum": { + "name": "AutoScalingResourceMetricName", + "modelAsString": true, + "values": [ + { + "value": "cpu", + "description": "Indicates that the resource is CPU cores." + }, + { + "value": "memoryInGB", + "description": "Indicates that the resource is memory in GB." + } + ] + } + }, + "AutoScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing auto scaling operation.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingTriggerKind", + "description": "The type of auto scaling trigger" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingTriggerKind": { + "type": "string", + "description": "Enumerates the triggers for auto scaling.", + "enum": [ + "AverageLoad" + ], + "x-ms-enum": { + "name": "AutoScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AverageLoad", + "description": "Indicates that scaling should be performed based on average load of all replicas in the service." + } + ] + } + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "properties": { + "name": { + "description": "The name of the code package.", + "type": "string" + }, + "image": { + "description": "The Container image to use.", + "type": "string" + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Image registry credential." + }, + "entrypoint": { + "description": "Override for the default entry point in the container.", + "type": "string" + }, + "commands": { + "description": "Command array to execute within the container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in this container", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "settings": { + "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "labels": { + "description": "The labels to set in this container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + "endpoints": { + "description": "The endpoints exposed by this container.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "resources": { + "description": "The resources required by this container.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeRefs": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeReference" + } + }, + "volumes": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationScopedVolume" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + }, + "reliableCollectionsRefs": { + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliablecollectionsRef for more details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReliableCollectionsRef" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerEvent": { + "description": "A container event.", + "properties": { + "name": { + "type": "string", + "description": "The name of the container event." + }, + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "description": "Date/time of the first event." + }, + "lastTimestamp": { + "type": "string", + "description": "Date/time of the last event." + }, + "message": { + "type": "string", + "description": "The event message" + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "properties": { + "restartCount": { + "type": "integer", + "description": "The number of times the container has been restarted." + }, + "currentState": { + "$ref": "#/definitions/ContainerState", + "description": "Current container instance state." + }, + "previousState": { + "$ref": "#/definitions/ContainerState", + "description": "Previous container instance state." + }, + "events": { + "description": "The events of this container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerEvent" + } + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerState": { + "description": "The container state.", + "properties": { + "state": { + "type": "string", + "description": "The state of this container" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state started." + }, + "exitCode": { + "type": "string", + "description": "The container exit code." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state finished." + }, + "detailStatus": { + "description": "Human-readable status of this state.", + "type": "string" + } + } + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations." + } + }, + "required": [ + "server", + "username" + ] + }, + "OperatingSystemType": { + "type": "string", + "description": "The operation system required by the code in service.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "The required operating system is Linux." + }, + { + "value": "Windows", + "description": "The required operating system is Windows." + } + ] + } + }, + "ReliableCollectionsRef": { + "description": "Specifying this parameter adds support for reliable collections", + "properties": { + "name": { + "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string.", + "type": "string" + }, + "doNotPersistState": { + "description": "False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.", + "type": "boolean" + } + }, + "required": [ + "name" + ] + }, + "ResourceLimits": { + "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "CPU limits in cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + } + }, + "ResourceRequests": { + "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.", + "properties": { + "memoryInGB": { + "description": "The memory request in GB for this container.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "Requested number of CPU cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + }, + "required": [ + "memoryInGB", + "cpu" + ] + }, + "ResourceRequirements": { + "description": "This type describes the resource requirements for a container or a service.", + "properties": { + "requests": { + "$ref": "#/definitions/ResourceRequests", + "description": "Describes the requested resources for a given container." + }, + "limits": { + "$ref": "#/definitions/ResourceLimits", + "description": "Describes the maximum limits on the resources for a given container." + } + }, + "required": [ + "requests" + ] + }, + "ServiceProperties": { + "description": "Describes properties of a service resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the service." + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "autoScalingPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScalingPolicy" + }, + "description": "Auto scaling policies" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the service." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the service." + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy." + } + } + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "properties": { + "osType": { + "$ref": "#/definitions/OperatingSystemType", + "description": "The operation system required by the code in service." + }, + "codePackages": { + "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + "networkRefs": { + "type": "array", + "description": "The names of the private networks that this service needs to be part of.", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "osType", + "codePackages" + ] + }, + "Setting": { + "description": "Describes a setting for the container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "ServiceReplicaDescription": { + "description": "Describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + } + ], + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + }, + "required": [ + "replicaName" + ] + }, + "AverageLoadScalingTrigger": { + "description": "Describes the average load trigger used for auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingTrigger" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AverageLoad", + "properties": { + "metric": { + "$ref": "#/definitions/AutoScalingMetric", + "description": "Description of the metric that is used for scaling." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "Lower load threshold (if average load is below this threshold, service will scale down)." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "Upper load threshold (if average load is above this threshold, service will scale up)." + }, + "scaleIntervalInSeconds": { + "type": "integer", + "description": "Scale interval that indicates how often will this trigger be checked.", + "minimum": 60 + } + }, + "required": [ + "metric", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleIntervalInSeconds" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionedResourceProperties" + }, + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "$ref": "#/definitions/ServiceProperties" + } + ] + }, + "ServiceResourceDescription": { + "description": "This type describes a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "properties" + ] + }, + "ServiceResourceDescriptionList": { + "description": "A pageable list of service resources.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ServiceReplicaDescriptionList": { + "description": "A pageable list of service replicas.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceReplicaDescription" + }, + "description": "One page of the list." + }, + "nextLink": { + "type": "string", + "description": "URI to fetch the next page of the list." + } + } + }, + "ContainerLogs": { + "description": "Container logs.", + "properties": { + "content": { + "type": "string", + "description": "Container logs." + } + } + } + }, + "parameters": { + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package of the service." + }, + "api-versionRequiredQueryParam": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-09-01-preview" + ], + "default": "2018-09-01-preview", + "description": "The version of the API. This parameter is required and its value must be `2018-09-01-preview`.", + "required": true, + "x-ms-enum": { + "name": "2018-09-01-preview", + "modelAsString": true, + "values": [ + { + "value": "2018-09-01-preview", + "description": "The `2018-09-01-preview` version of the API." + } + ] + } + }, + "subscriptionIdRequiredPathParam": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier", + "required": true, + "type": "string" + }, + "ResourceGroupNameRequiredPathParam": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SecretResourceDescriptionRequiredBodyParam": { + "name": "secretResourceDescription", + "in": "body", + "description": "Description for creating a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "SecretResourceNameRequiredPathParam": { + "name": "secretResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource." + }, + "SecretValueResourceDescriptionRequiredBodyParam": { + "name": "secretValueResourceDescription", + "in": "body", + "description": "Description for creating a value of a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "SecretValueResourceNameRequiredPathParam": { + "name": "secretValueResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource value which is typically the version identifier for the value." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a Volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "VolumeResourceNameRequiredPathParam": { + "name": "volumeResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a Network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "NetworkResourceNameRequiredPathParam": { + "name": "networkResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "GatewayResourceDescriptionRequiredBodyParam": { + "name": "gatewayResourceDescription", + "in": "body", + "description": "Description for creating a Gateway resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "GatewayResourceNameRequiredPathParam": { + "name": "gatewayResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the gateway." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating a Application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ApplicationResourceNameRequiredPathParam": { + "name": "applicationResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ServiceResourceNameRequiredPathParam": { + "name": "serviceResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service." + }, + "ReplicaNameRequiredPathParam": { + "name": "replicaName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric replica name." + }, + "TailOptionalQueryParam": { + "name": "tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100." + } + } +} \ No newline at end of file diff --git a/specification/servicefabricmesh/resource-manager/readme.go.md b/specification/servicefabricmesh/resource-manager/readme.go.md index 1831a2d0dcda..7227f9545201 100644 --- a/specification/servicefabricmesh/resource-manager/readme.go.md +++ b/specification/servicefabricmesh/resource-manager/readme.go.md @@ -12,8 +12,17 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-09-01-preview - tag: package-2018-07-01-preview ``` +### Tag: package-2018-09-01-preview and go + +These settings apply only when `--tag=package-2018-09-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-preview/$(namespace) +``` ### Tag: package-2018-07-01-preview and go diff --git a/specification/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md index 65686bdaae12..93f5b287119a 100644 --- a/specification/servicefabricmesh/resource-manager/readme.md +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -28,7 +28,7 @@ Following are the settings for using this specification with [AutoRest](https:// title: ServiceFabricMeshManagementClient description: Service Fabric Mesh Management Client openapi-type: arm -tag: package-2018-07-01-preview +tag: package-2018-09-01-preview directive: - suppress: RequiredPropertiesMissingInResourceModel @@ -38,6 +38,15 @@ directive: - suppress: TrackedResourcePatchOperation reason: The patch operation is not implemented in the preview APIs. ``` +### Tag: package-2018-09-01-preview + +These settings apply only when `--tag=package-2018-09-01-preview` is specified on the command line. + + +``` yaml $(tag) == 'package-2018-09-01-preview' +input-file: +- Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json +``` ### Tag: package-2018-07-01-preview These settings apply only when `--tag=package-2018-07-01-preview` is specified on the command line. @@ -129,8 +138,23 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicefabricmesh ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-09-01-preview - tag: package-2018-07-01-preview ``` + +### Tag: package-2018-09-01-preview and java + +These settings apply only when `--tag=2018-09-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == '2018-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.servicefabricmesh.v2018_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/servicefabricmesh/resource-manager/v2018_09_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2018-07-01-preview and java These settings apply only when `--tag=2018-07-01-preview --java` is specified on the command line. diff --git a/specification/servicefabricmesh/resource-manager/readme.ruby.md b/specification/servicefabricmesh/resource-manager/readme.ruby.md index b0a04419da90..4533ed3a1110 100644 --- a/specification/servicefabricmesh/resource-manager/readme.ruby.md +++ b/specification/servicefabricmesh/resource-manager/readme.ruby.md @@ -13,9 +13,20 @@ ruby: ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2018-09-01-preview - tag: package-2018-07-01-preview ``` +### Tag: package-2018-09-01-preview and ruby + +These settings apply only when `--tag=package-2018-09-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(ruby) +namespace: "Azure::ServiceFabricMesh::Mgmt::V2018_09_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_service_fabric_mesh/lib +``` + ### Tag: package-2018-07-01-preview and ruby These settings apply only when `--tag=package-2018-07-01-preview --ruby` is specified on the command line. From 007434dae499b72cc21d877f8147bb0bf9c612ac Mon Sep 17 00:00:00 2001 From: RyanD1 Date: Mon, 22 Oct 2018 14:11:06 -0700 Subject: [PATCH 038/464] add armRoleReceiver to ActionGroup API and update API version to 2018-09-01 (#4268) * add armRoleReceiver to ActionGroup API and update API version to 2018-09-01 * add description --- .../stable/2018-09-01/actionGroups_API.json | 832 ++++++++++++++++++ .../examples/createOrUpdateActionGroup.json | 297 +++++++ .../examples/deleteActionGroup.json | 18 + .../2018-09-01/examples/enableReceiver.json | 21 + .../2018-09-01/examples/getActionGroup.json | 56 ++ .../2018-09-01/examples/listActionGroups.json | 86 ++ .../2018-09-01/examples/patchActionGroup.json | 62 ++ .../monitor/resource-manager/readme.md | 12 +- 8 files changed, 1378 insertions(+), 6 deletions(-) create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json create mode 100644 specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json new file mode 100644 index 000000000000..586975d5f55c --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json @@ -0,0 +1,832 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Action Groups API", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2018-09-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}": { + "put": { + "description": "Create a new action group or update an existing one.", + "operationId": "ActionGroups_CreateOrUpdate", + "x-ms-examples": { + "Create or update an action group": { + "$ref": "./examples/createOrUpdateActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "name": "actionGroup", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActionGroupResource" + }, + "description": "The action group to create or use for the update." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An existing action group was successfully updated.", + "schema": { + "$ref": "#/definitions/ActionGroupResource" + } + }, + "201": { + "description": "A new action group was successfully created.", + "schema": { + "$ref": "#/definitions/ActionGroupResource" + } + }, + "default": { + "description": "An error occurred and the action group could not be created or updated.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Get an action group.", + "operationId": "ActionGroups_Get", + "x-ms-examples": { + "Get an action group": { + "$ref": "./examples/getActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/ActionGroupResource" + } + }, + "default": { + "description": "An error occurred and the action group could not be retrieved. 404: The action group does not exist.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Delete an action group.", + "operationId": "ActionGroups_Delete", + "x-ms-examples": { + "Delete an action group": { + "$ref": "./examples/deleteActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The action group was successfully deleted." + }, + "204": { + "description": "The action group does not exist. It may have already been deleted." + }, + "default": { + "description": "An error occurred and the action group could not be deleted.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Updates an existing action group's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "ActionGroups_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "actionGroupPatch", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActionGroupPatchBody" + }, + "description": "Parameters supplied to the operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "An existing action group was successfully updated.", + "schema": { + "$ref": "#/definitions/ActionGroupResource" + } + } + }, + "x-ms-examples": { + "Patch an action group": { + "$ref": "./examples/patchActionGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.insights/actionGroups": { + "get": { + "description": "Get a list of all action groups in a subscription.", + "operationId": "ActionGroups_ListBySubscriptionId", + "x-ms-examples": { + "List action groups": { + "$ref": "./examples/listActionGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/ActionGroupList" + } + }, + "default": { + "description": "An error occurred and the list of action groups could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups": { + "get": { + "description": "Get a list of all action groups in a resource group.", + "operationId": "ActionGroups_ListByResourceGroup", + "x-ms-examples": { + "List action groups": { + "$ref": "./examples/listActionGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/ActionGroupList" + } + }, + "default": { + "description": "An error occurred and the list of action groups could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/actionGroups/{actionGroupName}/subscribe": { + "post": { + "description": "Enable a receiver in an action group. This changes the receiver's status from Disabled to Enabled. This operation is only supported for Email or SMS receivers.", + "operationId": "ActionGroups_EnableReceiver", + "x-ms-examples": { + "Enable the receiver": { + "$ref": "./examples/enableReceiver.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "name": "enableRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnableRequest" + }, + "description": "The receiver to re-enable." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The receiver was successfully enabled." + }, + "409": { + "description": "The receiver is already enabled in the action group." + }, + "default": { + "description": "An error occurred and the receiver could not be enabled, e.g.: 404: The action group was not found or no matching receiver was found in the action group.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "ActionGroupResource": { + "description": "An action group resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActionGroup", + "description": "The action groups properties of the resource." + } + } + }, + "ActionGroupList": { + "description": "A list of action groups.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ActionGroupResource" + }, + "description": "The list of action groups." + }, + "nextLink": { + "type": "string", + "description": "Provides the link to retrieve the next set of elements." + } + } + }, + "ActionGroup": { + "description": "An Azure action group.", + "properties": { + "groupShortName": { + "type": "string", + "maxLength": 12, + "description": "The short name of the action group. This will be used in SMS messages." + }, + "enabled": { + "type": "boolean", + "default": true, + "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its receivers will receive communications." + }, + "emailReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/EmailReceiver" + }, + "description": "The list of email receivers that are part of this action group." + }, + "smsReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/SmsReceiver" + }, + "description": "The list of SMS receivers that are part of this action group." + }, + "webhookReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/WebhookReceiver" + }, + "description": "The list of webhook receivers that are part of this action group." + }, + "itsmReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/ItsmReceiver" + }, + "description": "The list of ITSM receivers that are part of this action group." + }, + "azureAppPushReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureAppPushReceiver" + }, + "description": "The list of AzureAppPush receivers that are part of this action group." + }, + "automationRunbookReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRunbookReceiver" + }, + "description": "The list of AutomationRunbook receivers that are part of this action group." + }, + "voiceReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/VoiceReceiver" + }, + "description": "The list of voice receivers that are part of this action group." + }, + "logicAppReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/LogicAppReceiver" + }, + "description": "The list of logic app receivers that are part of this action group." + }, + "azureFunctionReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFunctionReceiver" + }, + "description": "The list of azure function receivers that are part of this action group." + }, + "armRoleReceivers": { + "type": "array", + "items": { + "$ref": "#/definitions/ArmRoleReceiver" + }, + "description": "The list of ARM role receivers that are part of this action group. Roles are Azure RBAC roles and only built-in roles are supported." + } + }, + "required": [ + "groupShortName", + "enabled" + ] + }, + "EmailReceiver": { + "description": "An email receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the email receiver. Names must be unique across all receivers within an action group." + }, + "emailAddress": { + "type": "string", + "description": "The email address of this receiver." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ReceiverStatus", + "description": "The receiver status of the e-mail." + } + }, + "required": [ + "name", + "emailAddress" + ] + }, + "SmsReceiver": { + "description": "An SMS receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the SMS receiver. Names must be unique across all receivers within an action group." + }, + "countryCode": { + "type": "string", + "description": "The country code of the SMS receiver." + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the SMS receiver." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ReceiverStatus", + "description": "The status of the receiver." + } + }, + "required": [ + "name", + "countryCode", + "phoneNumber" + ] + }, + "WebhookReceiver": { + "description": "A webhook receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the webhook receiver. Names must be unique across all receivers within an action group." + }, + "serviceUri": { + "type": "string", + "description": "The URI where webhooks should be sent." + } + }, + "required": [ + "name", + "serviceUri" + ] + }, + "ItsmReceiver": { + "description": "An Itsm receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the Itsm receiver. Names must be unique across all receivers within an action group." + }, + "workspaceId": { + "type": "string", + "description": "OMS LA instance identifier." + }, + "connectionId": { + "type": "string", + "description": "Unique identification of ITSM connection among multiple defined in above workspace." + }, + "ticketConfiguration": { + "type": "string", + "description": "JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well." + }, + "region": { + "type": "string", + "description": "Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope'" + } + }, + "required": [ + "name", + "workspaceId", + "connectionId", + "ticketConfiguration", + "region" + ] + }, + "AzureAppPushReceiver": { + "description": "The Azure mobile App push notification receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group." + }, + "emailAddress": { + "type": "string", + "description": "The email address registered for the Azure mobile app." + } + }, + "required": [ + "name", + "emailAddress" + ] + }, + "AutomationRunbookReceiver": { + "description": "The Azure Automation Runbook notification receiver.", + "properties": { + "automationAccountId": { + "type": "string", + "description": "The Azure automation account Id which holds this runbook and authenticate to Azure resource." + }, + "runbookName": { + "type": "string", + "description": "The name for this runbook." + }, + "webhookResourceId": { + "type": "string", + "description": "The resource id for webhook linked to this runbook." + }, + "isGlobalRunbook": { + "type": "boolean", + "description": "Indicates whether this instance is global runbook." + }, + "name": { + "type": "string", + "description": "Indicates name of the webhook." + }, + "serviceUri": { + "type": "string", + "description": "The URI where webhooks should be sent." + } + }, + "required": [ + "automationAccountId", + "runbookName", + "webhookResourceId", + "isGlobalRunbook" + ] + }, + "VoiceReceiver": { + "description": "A voice receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the voice receiver. Names must be unique across all receivers within an action group." + }, + "countryCode": { + "type": "string", + "description": "The country code of the voice receiver." + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the voice receiver." + } + }, + "required": [ + "name", + "countryCode", + "phoneNumber" + ] + }, + "LogicAppReceiver": { + "description": "A logic app receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the logic app receiver. Names must be unique across all receivers within an action group." + }, + "resourceId": { + "type": "string", + "description": "The azure resource id of the logic app receiver." + }, + "callbackUrl": { + "type": "string", + "description": "The callback url where http request sent to." + } + }, + "required": [ + "name", + "resourceId", + "callbackUrl" + ] + }, + "AzureFunctionReceiver": { + "description": "An azure function receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the azure function receiver. Names must be unique across all receivers within an action group." + }, + "functionAppResourceId": { + "type": "string", + "description": "The azure resource id of the function app." + }, + "functionName": { + "type": "string", + "description": "The function name in the function app." + }, + "httpTriggerUrl": { + "type": "string", + "description": "The http trigger url where http request sent to." + } + }, + "required": [ + "name", + "functionAppResourceId", + "functionName", + "httpTriggerUrl" + ] + }, + "ArmRoleReceiver": { + "description": "An arm role receiver.", + "properties": { + "name": { + "type": "string", + "description": "The name of the arm role receiver. Names must be unique across all receivers within an action group." + }, + "roleId": { + "type": "string", + "description": "The arm role id." + } + }, + "required": [ + "name", + "roleId" + ] + }, + "ReceiverStatus": { + "type": "string", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ReceiverStatus", + "modelAsString": false + }, + "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." + }, + "EnableRequest": { + "description": "Describes a receiver that should be resubscribed.", + "properties": { + "receiverName": { + "type": "string", + "description": "The name of the receiver to resubscribe." + } + }, + "required": [ + "receiverName" + ] + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ActionGroupPatchBody": { + "description": "An action group object for the body of patch operations.", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActionGroupPatch", + "description": "The action group settings for an update operation." + } + } + }, + "ActionGroupPatch": { + "description": "An Azure action group for patch operations.", + "properties": { + "enabled": { + "type": "boolean", + "default": true, + "description": "Indicates whether this action group is enabled. If an action group is not enabled, then none of its actions will be activated." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription Id." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ActionGroupNameParameter": { + "name": "actionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the action group.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json new file mode 100644 index 000000000000..5d79f314d84b --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json @@ -0,0 +1,297 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "actionGroupName": "SampleActionGroup", + "api-version": "2018-09-01", + "actionGroup": { + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com" + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ], + "itsmReceivers": [ + { + "name": "Sample itsm", + "workspaceId": "5def922a-3ed4-49c1-b9fd-05ec533819a3|55dfd1f8-7e59-4f89-bf56-4c82f5ace23c", + "connectionId": "a3b9076c-ce8e-434e-85b4-aff10cb3c8f1", + "ticketConfiguration": "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}", + "region": "westcentralus" + } + ], + "azureAppPushReceivers": [ + { + "name": "Sample azureAppPush", + "emailAddress": "johndoe@email.com" + } + ], + "automationRunbookReceivers": [ + { + "automationAccountId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest", + "runbookName": "Sample runbook", + "webhookResourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest/webhooks/Alert1510184037084", + "isGlobalRunbook": false, + "name": "testRunbook", + "serviceUri": "https://s13events.azure-automation.net/webhooks?token=iimE%2fD19Eg%2bvDy22yUMecIZY6Uiz%2bHfuQ67r8r1wY%2fI%3d" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "1234567890" + } + ], + "logicAppReceivers": [ + { + "name": "Sample logicApp", + "resourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/LogicApp/providers/Microsoft.Logic/workflows/testLogicApp", + "callbackUrl": "https://prod-27.northcentralus.logic.azure.com/workflows/68e572e818e5457ba898763b7db90877/triggers/manual/paths/invoke/azns/test?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=Abpsb72UYJxPPvmDo937uzofupO5r_vIeWEx7KVHo7w" + } + ], + "azureFunctionReceivers": [ + { + "name": "Sample azureFunction", + "functionAppResourceId": "/subscriptions/5def922a-3ed4-49c1-b9fd-05ec533819a3/resourceGroups/aznsTest/providers/Microsoft.Web/sites/testFunctionApp", + "functionName": "HttpTriggerCSharp1", + "httpTriggerUrl": "https://testfunctionapp.azurewebsites.net/api/HttpTriggerCSharp1?code=4CopFfiXqUQC8dvIM7F53J7tIU3Gy9QQIG/vKAXMe2avhHqK3/jVYw==" + } + ], + "armRoleReceivers": [ + { + "name": "Sample armRole", + "roleId": "8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled" + } + ], + "smsReceivers":[ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers":[ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ], + "itsmReceivers": [ + { + "name": "Sample itsm", + "workspaceId": "5def922a-3ed4-49c1-b9fd-05ec533819a3|55dfd1f8-7e59-4f89-bf56-4c82f5ace23c", + "connectionId": "a3b9076c-ce8e-434e-85b4-aff10cb3c8f1", + "ticketConfiguration": "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}", + "region": "westcentralus" + } + ], + "azureAppPushReceivers": [ + { + "name": "Sample azureAppPush", + "emailAddress": "johndoe@email.com" + } + ], + "automationRunbookReceivers": [ + { + "automationAccountId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest", + "runbookName": "Sample runbook", + "webhookResourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest/webhooks/Alert1510184037084", + "isGlobalRunbook": false, + "name": "testRunbook", + "serviceUri": "https://s13events.azure-automation.net/webhooks?token=iimE%2fD19Eg%2bvDy22yUMecIZY6Uiz%2bHfuQ67r8r1wY%2fI%3d" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "1234567890" + } + ], + "logicAppReceivers": [ + { + "name": "Sample logicApp", + "resourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/LogicApp/providers/Microsoft.Logic/workflows/testLogicApp", + "callbackUrl": "https://prod-27.northcentralus.logic.azure.com/workflows/68e572e818e5457ba898763b7db90877/triggers/manual/paths/invoke/azns/test?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=Abpsb72UYJxPPvmDo937uzofupO5r_vIeWEx7KVHo7w" + } + ], + "azureFunctionReceivers": [ + { + "name": "Sample azureFunction", + "functionAppResourceId": "/subscriptions/5def922a-3ed4-49c1-b9fd-05ec533819a3/resourceGroups/aznsTest/providers/Microsoft.Web/sites/testFunctionApp", + "functionName": "HttpTriggerCSharp1", + "httpTriggerUrl": "https://testfunctionapp.azurewebsites.net/api/HttpTriggerCSharp1?code=4CopFfiXqUQC8dvIM7F53J7tIU3Gy9QQIG/vKAXMe2avhHqK3/jVYw==" + } + ], + "armRoleReceivers": [ + { + "name": "Sample armRole", + "roleId": "8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled" + } + ], + "smsReceivers":[ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers":[ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ], + "itsmReceivers": [ + { + "name": "Sample itsm", + "workspaceId": "5def922a-3ed4-49c1-b9fd-05ec533819a3|55dfd1f8-7e59-4f89-bf56-4c82f5ace23c", + "connectionId": "a3b9076c-ce8e-434e-85b4-aff10cb3c8f1", + "ticketConfiguration": "{\"PayloadRevision\":0,\"WorkItemType\":\"Incident\",\"UseTemplate\":false,\"WorkItemData\":\"{}\",\"CreateOneWIPerCI\":false}", + "region": "westcentralus" + } + ], + "azureAppPushReceivers": [ + { + "name": "Sample azureAppPush", + "emailAddress": "johndoe@email.com" + } + ], + "automationRunbookReceivers": [ + { + "automationAccountId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest", + "runbookName": "Sample runbook", + "webhookResourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/runbookTest/providers/Microsoft.Automation/automationAccounts/runbooktest/webhooks/Alert1510184037084", + "isGlobalRunbook": false, + "name": "testRunbook", + "serviceUri": "https://s13events.azure-automation.net/webhooks?token=iimE%2fD19Eg%2bvDy22yUMecIZY6Uiz%2bHfuQ67r8r1wY%2fI%3d" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "1234567890" + } + ], + "logicAppReceivers": [ + { + "name": "Sample logicApp", + "resourceId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/LogicApp/providers/Microsoft.Logic/workflows/testLogicApp", + "callbackUrl": "https://prod-27.northcentralus.logic.azure.com/workflows/68e572e818e5457ba898763b7db90877/triggers/manual/paths/invoke/azns/test?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=Abpsb72UYJxPPvmDo937uzofupO5r_vIeWEx7KVHo7w" + } + ], + "azureFunctionReceivers": [ + { + "name": "Sample azureFunction", + "functionAppResourceId": "/subscriptions/5def922a-3ed4-49c1-b9fd-05ec533819a3/resourceGroups/aznsTest/providers/Microsoft.Web/sites/testFunctionApp", + "functionName": "HttpTriggerCSharp1", + "httpTriggerUrl": "https://testfunctionapp.azurewebsites.net/api/HttpTriggerCSharp1?code=4CopFfiXqUQC8dvIM7F53J7tIU3Gy9QQIG/vKAXMe2avhHqK3/jVYw==" + } + ], + "armRoleReceivers": [ + { + "name": "Sample armRole", + "roleId": "8e3af657-a8ff-443c-a75c-2fe8c4bcb635" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json new file mode 100644 index 000000000000..3d7edcf8ebb6 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "actionGroupName": "SampleActionGroup", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "headers": {}, + "body": null + }, + "204": { + "headers": {}, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json new file mode 100644 index 000000000000..c57300b58fe7 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "actionGroupName": "SampleActionGroup", + "api-version": "2018-08-01", + "enableRequest": { + "receiverName": "John Doe's mobile" + } + }, + "responses": { + "200": { + "headers": {}, + "body": null + }, + "409": { + "headers": {}, + "body": null + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json new file mode 100644 index 000000000000..6aa11ec2bdfc --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "actionGroupName": "SampleActionGroup", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Disabled" + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890", + "status": "Disabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json new file mode 100644 index 000000000000..cbce7c57b919 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "api-version": "2018-03801" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Disabled" + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890", + "status": "Disabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ] + } + }, + { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup2", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup2", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample2", + "enabled": false, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + } + ], + "smsReceivers": [ + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json new file mode 100644 index 000000000000..fe9df4fec5f0 --- /dev/null +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "187f412d-1758-44d9-b052-169e2564721d", + "resourceGroupName": "Default-NotificationRules", + "actionGroupName": "SampleActionGroup", + "api-version": "2018-08-01", + "actionGroupPatch": { + "tags": { "key1": "value1", "key2": "value2" }, + "properties": { + "enabled": false + } + } + }, + "responses": { + "200": { + "headers": { }, + "body": { + "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/Default-NotificationRules/providers/microsoft.insights/actionGroups/SampleActionGroup", + "type": "Microsoft.Insights/ActionGroups", + "name": "SampleActionGroup", + "location": "Global", + "tags": { "key1": "value1", "key2": "value2" }, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled" + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled" + } + ], + "smsReceivers":[ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers":[ + { + "name": "Sample webhook", + "serviceUri": "http://www.example.com/webhook" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 606b438cfd24..149a54c3ee94 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -45,7 +45,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json - microsoft.insights/stable/2015-04-01/activityLogs_API.json - microsoft.insights/stable/2015-04-01/eventCategories_API.json @@ -72,7 +72,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json - microsoft.insights/stable/2015-04-01/activityLogs_API.json - microsoft.insights/stable/2015-04-01/eventCategories_API.json @@ -99,7 +99,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json - microsoft.insights/stable/2015-04-01/activityLogs_API.json - microsoft.insights/stable/2015-04-01/eventCategories_API.json @@ -124,7 +124,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json - microsoft.insights/stable/2015-04-01/activityLogs_API.json - microsoft.insights/stable/2015-04-01/eventCategories_API.json @@ -148,7 +148,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json - microsoft.insights/stable/2015-04-01/activityLogs_API.json - microsoft.insights/stable/2015-04-01/eventCategories_API.json @@ -172,7 +172,7 @@ input-file: - microsoft.insights/stable/2016-03-01/logProfiles_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2017-04-01/actionGroups_API.json +- microsoft.insights/stable/2018-09-01/actionGroups_API.json - microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json ``` From 15095b486206899c2ec77d2abddbaee9480021e3 Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Mon, 22 Oct 2018 16:12:46 -0700 Subject: [PATCH 039/464] StorageSync ResourceProvider : Bug Fix to change parameter name (#4308) * Bug Fix to change parameter name * fix Go SDK codegen for preview package --- .../Microsoft.StorageSync/preview/2018-10-01/storagesync.json | 2 +- .../Microsoft.StorageSync/stable/2018-07-01/storagesync.json | 2 +- specification/storagesync/resource-manager/readme.go.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index 7f848db71e8f..620d1729af82 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -2595,7 +2595,7 @@ "type": "object", "description": "Trigger Rollover Request.", "properties": { - "certificateData": { + "serverCertificate": { "type": "string", "description": "Certificate Data" } diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json index 697277d2e5d1..4a401cee54b1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json @@ -2595,7 +2595,7 @@ "type": "object", "description": "Trigger Rollover Request.", "properties": { - "certificateData": { + "serverCertificate": { "type": "string", "description": "Certificate Data" } diff --git a/specification/storagesync/resource-manager/readme.go.md b/specification/storagesync/resource-manager/readme.go.md index c6d9ce18c085..b163834fbbb8 100644 --- a/specification/storagesync/resource-manager/readme.go.md +++ b/specification/storagesync/resource-manager/readme.go.md @@ -24,7 +24,7 @@ These settings apply only when `--tag=package-2018-10-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-10-01' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-10-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-10-01/$(namespace) ``` ### Tag: package-2018-07-01 and go From 9c1fe12b46cd05f44ed40a9e4bc25205cc343667 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Tue, 23 Oct 2018 08:59:23 -0700 Subject: [PATCH 040/464] Fix key-vault data plane TypeScript output path (#4310) --- specification/keyvault/data-plane/readme.typescript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/keyvault/data-plane/readme.typescript.md b/specification/keyvault/data-plane/readme.typescript.md index a105718d64f5..7e44f87cb64f 100644 --- a/specification/keyvault/data-plane/readme.typescript.md +++ b/specification/keyvault/data-plane/readme.typescript.md @@ -7,7 +7,7 @@ Please also specify `--typescript-sdks-folder= Date: Tue, 23 Oct 2018 19:43:36 +0100 Subject: [PATCH 041/464] StorageDataLake: fix invalid readme input file (#4302) The error introduced is an ARM requirement. --- .../storage/data-plane/Microsoft.StorageDataLake/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md index d34d381b0442..b149e3ccbb03 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md @@ -38,7 +38,7 @@ These settings apply only when `--tag=package-2018-06-preview` is specified on t ``` yaml $(tag) == 'package-2018-06-preview' input-file: -- Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json +- preview/2018-06-17/DataLakeStorage.json ``` --- From b0d02f9b39c7c88ff5741f495405762a0853f905 Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Tue, 23 Oct 2018 12:51:30 -0700 Subject: [PATCH 042/464] added missing namespace Migrate API reported in ARMs Fundamental dashboard (#4254) --- .../NameSpaces/SBNamespaceMigrate.json | 14 ++++ .../stable/2017-04-01/servicebus.json | 78 ++++++++++++++++++- 2 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNamespaceMigrate.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNamespaceMigrate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNamespaceMigrate.json new file mode 100644 index 000000000000..ea2bd96d69c4 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/SBNamespaceMigrate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-41", + "resourceGroupName": "ResourceGroup", + "api-version": "2017-04-01", + "subscriptionId": "SubscriptionId", + "parameters": { + "targetNamespaceType": "EventHub" + } + }, + "responses": { + "200": { } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json index 4a88c5bfbfd9..18d0e5ec573b 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json @@ -692,6 +692,52 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/migrate": { + "post": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Migrate", + "x-ms-examples": { + "NameSpaceUpdate": { "$ref": "./examples/NameSpaces/SBNamespaceMigrate.json" } + }, + "description": "This operation Migrate the given namespace to provided name type", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SBNamespaceMigrate" + }, + "description": "Parameters supplied to migrate namespace type." + } + ], + "responses": { + "200": { + "description": "Migrate Namepsace type is successful." + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/disasterRecoveryConfigs/CheckNameAvailability": { "post": { "tags": [ @@ -2948,7 +2994,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { "get": { "tags": [ "Namespaces" @@ -3521,6 +3567,30 @@ ], "description": "SKU of the namespace." }, + "SBNamespaceMigrate": { + "type": "object", + "properties": { + "targetNamespaceType": { + "type": "string", + "description": "Type of namespaces", + "enum": [ + "Messaging", + "NotificationHub", + "Mixed", + "EventHub", + "Relay" + ], + "x-ms-enum": { + "name": "NameSpaceType", + "modelAsString": false + } + } + }, + "required": [ + "targetNamespaceType" + ], + "description": "Namespace Migrate Object" + }, "SBAuthorizationRuleListResult": { "properties": { "value": { @@ -4709,7 +4779,7 @@ }, "description": "The result of the List migrationConfigurations operation." }, - "IpFilterRule": { + "IpFilterRule": { "properties": { "properties": { "x-ms-client-flatten": true, @@ -4936,7 +5006,7 @@ "maximum": 1000, "x-ms-parameter-location": "method" }, - "IPFilterRuleNameParameter": { + "IPFilterRuleNameParameter": { "name": "ipFilterRuleName", "in": "path", "required": true, @@ -4955,4 +5025,4 @@ "description": "The Virtual Network Rule name." } } -} \ No newline at end of file +} From 631e5b54ffb75b648b8673ddf242b1bea16585f9 Mon Sep 17 00:00:00 2001 From: Francisco Gamino Date: Tue, 23 Oct 2018 12:52:10 -0700 Subject: [PATCH 043/464] Reverting change: Replacing PartialSync for IncrementalSync for sync type and updating examples. (#4303) --- .../getAllSourceControlSyncJobs.json | 10 +++++----- .../sourceControlSyncJob/getSourceControlSyncJob.json | 2 +- .../2017-05-15-preview/sourceControlSyncJob.json | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json index be52a3096653..21dad207b764 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getAllSourceControlSyncJobs.json @@ -19,7 +19,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync" + "syncType": "PartialSync" } }, { @@ -30,7 +30,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync" + "syncType": "PartialSync" } }, { @@ -41,7 +41,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync" + "syncType": "PartialSync" } }, { @@ -52,7 +52,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync" + "syncType": "PartialSync" } }, { @@ -63,7 +63,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync" + "syncType": "PartialSync" } } ] diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json index 50626a991164..1d4ae7f66a8f 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/sourceControlSyncJob/getSourceControlSyncJob.json @@ -18,7 +18,7 @@ "provisioningState": "Completed", "startTime": "2017-03-28T23:14:27.903+00:00", "endTime": "2017-03-28T23:14:28.903+00:00", - "syncType": "IncrementalSync", + "syncType": "PartialSync", "exception": "" } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json index a9240b8fe2d0..c5479ea3938a 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json @@ -327,7 +327,7 @@ "type": "string", "description": "The sync type.", "enum": [ - "IncrementalSync", + "PartialSync", "FullSync" ], "x-ms-enum": { @@ -411,7 +411,7 @@ "type": "string", "description": "The sync type.", "enum": [ - "IncrementalSync", + "PartialSync", "FullSync" ], "x-ms-enum": { From 605dd0c1f1cb5f5d10c657fd160104c5bc3508f3 Mon Sep 17 00:00:00 2001 From: Jemal Abdulkadir Date: Tue, 23 Oct 2018 15:54:18 -0700 Subject: [PATCH 044/464] Swagger change for pre and post script (#4298) * Swagger change for Pre and post script * fixing semantic and model validation error * fixing the Required filed * changing the capitalization on the description * fixing the model validation error * addressing PR feedback * fix description --- .../createSoftwareUpdateConfiguration.json | 415 +++++++++++------- .../getSoftwareUpdateConfigurationByName.json | 142 +++--- .../listSoftwareUpdateConfigurations.json | 190 +++++--- .../listSoftwareUpdateConfigurationsByVm.json | 150 ++++--- ...wareUpdateConfigurationMachineRunById.json | 59 +-- ...oftwareUpdateConfigurationMachineRuns.json | 108 ++--- ...reUpdateConfigurationMachineRunsByRun.json | 110 ++--- ...getSoftwareUpdateConfigurationRunById.json | 60 +-- ...FailedSoftwareUpdateConfigurationRuns.json | 122 ++--- .../listSoftwareUpdateConfigurationRuns.json | 120 ++--- .../softwareUpdateConfiguration.json | 45 +- ...softwareUpdateConfigurationMachineRun.json | 4 + .../softwareUpdateConfigurationRun.json | 48 +- 13 files changed, 972 insertions(+), 601 deletions(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json index 1b37f1f0f922..b6893335255c 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json @@ -1,177 +1,274 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationName": "testpatch", - "api-version": "2017-05-15-preview", - "parameters": { - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "duration": "PT2H0M", - "windows": { - "excludedKbNumbers": [ - "168934", - "168973" - ], - "includedUpdateClassifications": "Critical", - "rebootSetting": "IfRequired" - }, - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ], - "targets":[ - { - "azureQueries": - { - "scope":[ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" - ], - "tagSettings":{ - "tags":[ - { - "tag1": ["tag1Value1", "tag1Value2", "tag1Value3"] - }, - { - "tag2": ["tag2Value1", "tag2Value2", "tag2Value3"] - } - ], - "filterOperator" : "All" - }, - "locations":[ - "Japan East", - "UK South" - ] - } - } - ] - }, - "scheduleInfo": { - "frequency": "Hour", - "startTime": "2017-10-19T12:22:57+00:00", - "timeZone": "America/Los_Angeles", - "interval": 1, - "expiryTime": "2018-11-09T11:22:57+00:00", - "advancedSchedule": { - "weekDays": [ - "Monday", - "Thursday" + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationName": "testpatch", + "api-version": "2017-05-15-preview", + "parameters": { + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "duration": "PT2H0M", + "windows": { + "excludedKbNumbers": [ + "168934", + "168973" + ], + "includedUpdateClassifications": "Critical", + "rebootSetting": "IfRequired" + }, + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ], + "targets": [ + { + "azureQueries": { + "scope": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" + ], + "tagSettings": { + "tags": [ + { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" ] - } + }, + { + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + } + ], + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] } + } + ] + }, + "scheduleInfo": { + "frequency": "Hour", + "startTime": "2017-10-19T12:22:57+00:00", + "timeZone": "America/Los_Angeles", + "interval": 1, + "expiryTime": "2018-11-09T11:22:57+00:00", + "advancedSchedule": { + "weekDays": [ + "Monday", + "Thursday" + ] } + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + } } + } }, "responses": { - "200": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + "200": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" + "tag2": [ + "tag2Value1", + "tag2Value2" ] + }, + "filterOperator": "All" }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles", - "advancedSchedule": {} - }, - "provisioningState": "Provisioning", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "createdBy": "adam@contoso.com", - "lastModifiedBy": "adam@contoso.com", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + "locations": [ + "Japan East", + "UK South" + ] + } + ] + }, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles", + "advancedSchedule": {} + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" } - } - }, - "201": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "provisioningState": "Provisioning", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "createdBy": "adam@contoso.com", + "lastModifiedBy": "adam@contoso.com", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" + "tag2": [ + "tag2Value1", + "tag2Value2" ] + }, + "filterOperator": "All" }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles" - }, - "provisioningState": "Provisioning", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + "locations": [ + "Japan East", + "UK South" + ] + } + ] + }, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles" + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" } - } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "provisioningState": "Provisioning", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } } + } } -} + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json index 3b696f9a7712..bc5ccd66bbce 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/getSoftwareUpdateConfigurationByName.json @@ -1,63 +1,99 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationName": "mypatch", - "api-version": "2017-05-15-preview", - "body": {} + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationName": "mypatch", + "api-version": "2017-05-15-preview", + "body": {} }, "responses": { - "200": { - "headers": {}, - "body": { - "name": "testpatch", - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical", - "excludedKbNumbers": [ - "168934", - "168973" - ] - }, - "linux": {}, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + "200": { + "headers": {}, + "body": { + "name": "testpatch", + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurations/testpatch", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical", + "excludedKbNumbers": [ + "168934", + "168973" + ] + }, + "linux": {}, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" + "tag2": [ + "tag2Value1", + "tag2Value2" ] + }, + "filterOperator": "All" }, - "scheduleInfo": { - "description": "", - "startTime": "2017-10-19T12:22:00-07:00", - "startTimeOffsetMinutes": -420.0, - "expiryTime": "2018-11-09T11:22:00-08:00", - "expiryTimeOffsetMinutes": -480.0, - "isEnabled": true, - "nextRun": "2017-10-19T12:22:00-07:00", - "nextRunOffsetMinutes": -420.0, - "interval": 1, - "frequency": "Week", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", - "timeZone": "America/Los_Angeles" - }, - "provisioningState": "Provisioning", - "createdBy": "eve@contoso.com", - "error": {}, - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + "locations": null + } + ] + }, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ] + }, + "scheduleInfo": { + "description": "", + "startTime": "2017-10-19T12:22:00-07:00", + "startTimeOffsetMinutes": -420, + "expiryTime": "2018-11-09T11:22:00-08:00", + "expiryTimeOffsetMinutes": -480, + "isEnabled": true, + "nextRun": "2017-10-19T12:22:00-07:00", + "nextRunOffsetMinutes": -420, + "interval": 1, + "frequency": "Week", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.5233333+00:00", + "timeZone": "America/Los_Angeles" + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" } - } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "provisioningState": "Provisioning", + "createdBy": "eve@contoso.com", + "error": {}, + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00" + } } + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json index 27d30b99b6e7..a92de0375eb2 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurations.json @@ -1,69 +1,143 @@ { "parameters": { - "subscriptionId": "1a7d4044-286c-4acb-969a-96639265bf2e", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "api-version": "2017-05-15-preview", - "body": {} + "subscriptionId": "1a7d4044-286c-4acb-969a-96639265bf2e", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "api-version": "2017-05-15-preview", + "body": {} }, "responses": { - "200": { - "value": [ - { - "name": "testpatch-01", - "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates", - "excludedKbNumbers": null - }, - "linux": null, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": null + "200": { + "value": [ + { + "name": "testpatch-01", + "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates", + "excludedKbNumbers": null + }, + "linux": null, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" + ], + "tag2": [ + "tag2Value1", + "tag2Value2" + ] }, - "frequency": "Week", - "startTime": "2017-10-19T12:22:00-07:00", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00", - "provisioningState": "Succeeded", - "nextRun": "2017-10-23T12:22:00-07:00" + "filterOperator": "All" + }, + "locations": null } + ] + }, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": null + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "frequency": "Week", + "startTime": "2017-10-19T12:22:00-07:00", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00", + "provisioningState": "Succeeded", + "nextRun": "2017-10-23T12:22:00-07:00" + } + }, + { + "name": "testpatch-02", + "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical, FeaturePack", + "excludedKbNumbers": null }, - { - "name": "testpatch-02", - "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical, FeaturePack", - "excludedKbNumbers":null - }, - "linux": null, - "duration": "PT2H30M", - "azureVirtualMachines": [ - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-04", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06" - ], - "nonAzureComputerNames": null + "linux": null, + "targets": { + "azureQueries": [ + { + "scope": [ + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d/resourceGroups/a-stasku-rg0", + "/subscriptions/422b6c61-95b0-4213-b3be-7282315df71d" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2" + ], + "tag2": [ + "tag2Value1", + "tag2Value2" + ] }, - "frequency": "Hour", - "startTime": "2018-05-05T12:26:00-07:00", - "creationTime": "2017-08-11T21:52:02.7733333+00:00", - "lastModifiedTime": "2017-08-11T21:52:22.88+00:00", - "provisioningState": "Succeeded", - "nextRun":"2018-05-05T12:26:00-07:00" + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South"] } + ] + }, + "duration": "PT2H30M", + "azureVirtualMachines": [ + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-04", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06" + ], + "nonAzureComputerNames": null + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null } - ] - } + }, + "frequency": "Hour", + "startTime": "2018-05-05T12:26:00-07:00", + "creationTime": "2017-08-11T21:52:02.7733333+00:00", + "lastModifiedTime": "2017-08-11T21:52:22.88+00:00", + "provisioningState": "Succeeded", + "nextRun": "2018-05-05T12:26:00-07:00" + } + } + ] + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json index d81e1f72aace..153c968b29a4 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/listSoftwareUpdateConfigurationsByVm.json @@ -1,70 +1,94 @@ { "parameters": { - "subscriptionId": "1a7d4044-286c-4acb-969a-96639265bf2e", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "$filter": "properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')", - "api-version": "2017-05-15-preview", - "body": {} + "subscriptionId": "1a7d4044-286c-4acb-969a-96639265bf2e", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "$filter": "properties/updateConfiguration/azureVirtualMachines/any(m: m eq '/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01')", + "api-version": "2017-05-15-preview", + "body": {} }, "responses": { - "200": { - "value": [ - { - "name": "testpatch-01", - "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates", - "excludedKbNumbers": null - }, - "linux": null, - "duration": "PT2H", - "azureVirtualMachines": [ - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": null - }, - "frequency": "Week", - "startTime": "2017-10-19T12:22:00-07:00", - "creationTime": "2017-10-19T18:54:50.5233333+00:00", - "lastModifiedTime": "2017-10-19T18:54:50.68+00:00", - "provisioningState": "Succeeded", - "nextRun": "2017-10-23T12:22:00-07:00" - } + "200": { + "value": [ + { + "name": "testpatch-01", + "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-01", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical, Security, UpdateRollup, FeaturePack, ServicePack, Definition, Tools, Updates", + "excludedKbNumbers": null }, - { - "name": "testpatch-02", - "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02", - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "windows": { - "includedUpdateClassifications": "Critical, FeaturePack", - "excludedKbNumbers":null - }, - "linux": null, - "duration": "PT2H30M", - "azureVirtualMachines": [ - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05", - "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06" - ], - "nonAzureComputerNames": null - }, - "frequency": "Hour", - "startTime": "2018-05-05T12:26:00-07:00", - "creationTime": "2017-08-11T21:52:02.7733333+00:00", - "lastModifiedTime": "2017-08-11T21:52:22.88+00:00", - "provisioningState": "Succeeded", - "nextRun":"2018-05-05T12:26:00-07:00" - } + "linux": null, + "duration": "PT2H", + "azureVirtualMachines": [ + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" + ], + "nonAzureComputerNames": null + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null + } + }, + "frequency": "Week", + "startTime": "2017-10-19T12:22:00-07:00", + "creationTime": "2017-10-19T18:54:50.5233333+00:00", + "lastModifiedTime": "2017-10-19T18:54:50.68+00:00", + "provisioningState": "Succeeded", + "nextRun": "2017-10-23T12:22:00-07:00" + } + }, + { + "name": "testpatch-02", + "id": "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/Mo-Resources-WCUS/providers/Microsoft.Automation/automationAccounts/Mo-AAA-WCUS/softwareUpdateConfigurations/testpatch-02", + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "windows": { + "includedUpdateClassifications": "Critical, FeaturePack", + "excludedKbNumbers": null + }, + "linux": null, + "duration": "PT2H30M", + "azureVirtualMachines": [ + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-05", + "/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-06" + ], + "nonAzureComputerNames": null + }, + "tasks": { + "preTask": { + "source": "HelloWorld", + "parameters": { + "COMPUTERNAME": "Computer1" + } + }, + "postTask": { + "source": "GetCache", + "parameters": null } - ] - } + }, + "frequency": "Hour", + "startTime": "2018-05-05T12:26:00-07:00", + "creationTime": "2017-08-11T21:52:02.7733333+00:00", + "lastModifiedTime": "2017-08-11T21:52:22.88+00:00", + "provisioningState": "Succeeded", + "nextRun": "2018-05-05T12:26:00-07:00" + } + } + ] + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json index 75ac22a300b2..d889f35cf7fb 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/getSoftwareUpdateConfigurationMachineRunById.json @@ -1,34 +1,37 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationMachineRunId": "ca440719-34a4-4234-a1a9-3f84faf7788f", - "api-version": "2017-05-15-preview" + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationMachineRunId": "ca440719-34a4-4234-a1a9-3f84faf7788f", + "api-version": "2017-05-15-preview" }, "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", - "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", - "properties": { - "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", - "targetComputerType": "AzureVirtualMachines", - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "osType": "Windows", - "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", - "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", - "startTime": "2017-10-23T02:33:30.7484961+00:00", - "endTime": "2017-10-23T02:33:36.4166667+00:00", - "configuredDuration": "PT2H", - "job": {}, - "creationTime": "2017-10-23T02:33:30.7484961+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" - } - } + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", + "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", + "properties": { + "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", + "targetComputerType": "AzureVirtualMachines", + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "osType": "Windows", + "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", + "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", + "startTime": "2017-10-23T02:33:30.7484961+00:00", + "endTime": "2017-10-23T02:33:36.4166667+00:00", + "configuredDuration": "PT2H", + "job": {}, + "error": {}, + "creationTime": "2017-10-23T02:33:30.7484961+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" + } } + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json index 1225c18f2745..ce59f83b6504 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRuns.json @@ -1,58 +1,64 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "api-version": "2017-05-15-preview" + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "api-version": "2017-05-15-preview" }, "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", - "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", - "properties": { - "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", - "targetComputerType": "AzureVirtualMachines", - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "osType": "Windows", - "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", - "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", - "startTime": "2017-10-23T02:33:30.7484961+00:00", - "endTime": "2017-10-23T02:33:36.4166667+00:00", - "configuredDuration": "PT2H", - "job": {}, - "creationTime": "2017-10-23T02:33:30.7484961+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" - } - }, - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f", - "name": "ca440719-34a4-4234-a1a9-3f84faf7789f", - "properties": { - "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2", - "targetComputerType": "AzureVirtualMachines", - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "osType": "Windows", - "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", - "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", - "startTime": "2017-10-23T02:33:30.7484961+00:00", - "endTime": "2017-10-23T02:33:36.4166667+00:00", - "configuredDuration": "PT2H", - "job": {}, - "creationTime": "2017-10-23T02:33:30.7484961+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" - } - } - ], - "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", + "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", + "properties": { + "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", + "targetComputerType": "AzureVirtualMachines", + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "osType": "Windows", + "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", + "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", + "startTime": "2017-10-23T02:33:30.7484961+00:00", + "endTime": "2017-10-23T02:33:36.4166667+00:00", + "configuredDuration": "PT2H", + "job": {}, + "error": {}, + "creationTime": "2017-10-23T02:33:30.7484961+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" } + }, + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f", + "name": "ca440719-34a4-4234-a1a9-3f84faf7789f", + "properties": { + "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2", + "targetComputerType": "AzureVirtualMachines", + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "osType": "Windows", + "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", + "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", + "startTime": "2017-10-23T02:33:30.7484961+00:00", + "endTime": "2017-10-23T02:33:36.4166667+00:00", + "configuredDuration": "PT2H", + "job": {}, + "error": {}, + "creationTime": "2017-10-23T02:33:30.7484961+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json index 21853f34bb82..455d1d50389c 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationMachineRun/listSoftwareUpdateConfigurationMachineRunsByRun.json @@ -1,59 +1,65 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "$filter": "$filter=properties/correlationId%20eq%200b943e57-44d3-4f05-898c-6e92aa617e59", - "api-version": "2017-05-15-preview" + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "$filter": "$filter=properties/correlationId%20eq%200b943e57-44d3-4f05-898c-6e92aa617e59", + "api-version": "2017-05-15-preview" }, "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", - "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", - "properties": { - "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", - "targetComputerType": "AzureVirtualMachines", - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "osType": "Windows", - "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", - "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", - "startTime": "2017-10-23T02:33:30.7484961+00:00", - "endTime": "2017-10-23T02:33:36.4166667+00:00", - "configuredDuration": "PT2H", - "job": {}, - "creationTime": "2017-10-23T02:33:30.7484961+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" - } - }, - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f", - "name": "ca440719-34a4-4234-a1a9-3f84faf7789f", - "properties": { - "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2", - "targetComputerType": "AzureVirtualMachines", - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "osType": "Windows", - "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", - "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", - "startTime": "2017-10-23T02:33:30.7484961+00:00", - "endTime": "2017-10-23T02:33:36.4166667+00:00", - "configuredDuration": "PT2H", - "job": {}, - "creationTime": "2017-10-23T02:33:30.7484961+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" - } - } - ], - "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7788f", + "name": "ca440719-34a4-4234-a1a9-3f84faf7788f", + "properties": { + "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm", + "targetComputerType": "AzureVirtualMachines", + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "osType": "Windows", + "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", + "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", + "startTime": "2017-10-23T02:33:30.7484961+00:00", + "endTime": "2017-10-23T02:33:36.4166667+00:00", + "configuredDuration": "PT2H", + "job": {}, + "error": {}, + "creationTime": "2017-10-23T02:33:30.7484961+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" } + }, + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationMachineRuns/ca440719-34a4-4234-a1a9-3f84faf7789f", + "name": "ca440719-34a4-4234-a1a9-3f84faf7789f", + "properties": { + "targetComputer": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Compute/virtualMachines/myvm2", + "targetComputerType": "AzureVirtualMachines", + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "osType": "Windows", + "correlationId": "0b943e57-44d3-4f05-898c-6e92aa617e59", + "sourceComputerId": "3d3f24bf-7037-424e-bfba-aae3b9752f8e", + "startTime": "2017-10-23T02:33:30.7484961+00:00", + "endTime": "2017-10-23T02:33:36.4166667+00:00", + "configuredDuration": "PT2H", + "job": {}, + "error": {}, + "creationTime": "2017-10-23T02:33:30.7484961+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:34:32.4366667+00:00" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" } + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json index a6cdaee78604..bce1e51d32a0 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/getSoftwareUpdateConfigurationRunById.json @@ -1,31 +1,41 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationRunId": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "api-version": "2017-05-15-preview" + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationRunId": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "api-version": "2017-05-15-preview" }, "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "properties": { - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "configuredDuration": "PT2H", - "osType": "Windows", - "startTime": "2017-10-23T02:30:36.2401233+00:00", - "endTime": "2017-10-23T02:30:42.8466667+00:00", - "computerCount": 1, - "failedCount": 0, - "creationTime": "2017-10-23T02:30:36.2401233+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" - } - } + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "properties": { + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "tasks": { + "preTask": { + "jobId": "be430e9e-2290-462e-8f86-686407c35fab", + "source": "preRunbook", + "status": "Completed" + }, + "postTask": null + }, + "configuredDuration": "PT2H", + "osType": "Windows", + "startTime": "2017-10-23T02:30:36.2401233+00:00", + "endTime": "2017-10-23T02:30:42.8466667+00:00", + "computerCount": 1, + "failedCount": 0, + "creationTime": "2017-10-23T02:30:36.2401233+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" + } } + } } -} \ No newline at end of file + } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json index 8bb7f46ba4b8..3f1814250a17 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listFailedSoftwareUpdateConfigurationRuns.json @@ -1,54 +1,74 @@ { - "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationRunId": "a2c7c4b8-55d6-4505-bea7-756e93b18a35", - "$filter": "properties/status%20eq%20'Failed'", - "api-version": "2017-05-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "properties": { - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Failed", - "configuredDuration": "PT2H", - "osType": "Windows", - "startTime": "2017-10-23T02:30:36.2401233+00:00", - "endTime": "2017-10-23T02:30:42.8466667+00:00", - "computerCount": 1, - "failedCount": 0, - "creationTime": "2017-10-23T02:30:36.2401233+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" - } - }, - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8", - "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8", - "properties": { - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Failed", - "configuredDuration": "PT2H", - "osType": "Windows", - "startTime": "2017-10-23T01:33:01.8818952+00:00", - "endTime": "2017-10-23T01:33:08.1133333+00:00", - "computerCount": 1, - "failedCount": 0, - "creationTime": "2017-10-23T01:33:01.8818952+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T01:34:03.94+00:00" - } - } - ], - "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" - } - } + "parameters": { + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationRunId": "a2c7c4b8-55d6-4505-bea7-756e93b18a35", + "$filter": "properties/status%20eq%20'Failed'", + "api-version": "2017-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "properties": { + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Failed", + "configuredDuration": "PT2H", + "osType": "Windows", + "startTime": "2017-10-23T02:30:36.2401233+00:00", + "endTime": "2017-10-23T02:30:42.8466667+00:00", + "computerCount": 1, + "failedCount": 0, + "tasks": { + "preTask": { + "jobId": "be430e9e-2290-462e-8f86-686407c35fab", + "source": "preRunbook", + "status": "Completed" + }, + "postTask": null + }, + "creationTime": "2017-10-23T02:30:36.2401233+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" + } + }, + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8", + "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8", + "properties": { + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Failed", + "configuredDuration": "PT2H", + "osType": "Windows", + "startTime": "2017-10-23T01:33:01.8818952+00:00", + "endTime": "2017-10-23T01:33:08.1133333+00:00", + "computerCount": 1, + "failedCount": 0, + "tasks": { + "preTask": { + "jobId": "be430e9e-2290-462e-8f86-686407c35fab", + "source": "preRunbook", + "status": "Completed" + }, + "postTask": null + }, + "creationTime": "2017-10-23T01:33:01.8818952+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T01:34:03.94+00:00" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" + } } + } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json index e66e2fac6e4c..77477441b4fa 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfigurationRun/listSoftwareUpdateConfigurationRuns.json @@ -1,53 +1,73 @@ { - "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationRunId": "a2c7c4b8-55d6-4505-bea7-756e93b18a35", - "api-version": "2017-05-15-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", - "properties": { - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "configuredDuration": "PT2H", - "osType": "Windows", - "startTime": "2017-10-23T02:30:36.2401233+00:00", - "endTime": "2017-10-23T02:30:42.8466667+00:00", - "computerCount": 1, - "failedCount": 0, - "creationTime": "2017-10-23T02:30:36.2401233+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" - } - }, - { - "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8", - "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8", - "properties": { - "softwareUpdateConfiguration": { "name": "mypatch" }, - "status": "Succeeded", - "configuredDuration": "PT2H", - "osType": "Windows", - "startTime": "2017-10-23T01:33:01.8818952+00:00", - "endTime": "2017-10-23T01:33:08.1133333+00:00", - "computerCount": 1, - "failedCount": 0, - "creationTime": "2017-10-23T01:33:01.8818952+00:00", - "lastModifiedBy": "", - "lastModifiedTime": "2017-10-23T01:34:03.94+00:00" - } - } - ], - "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" - } - } + "parameters": { + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationRunId": "a2c7c4b8-55d6-4505-bea7-756e93b18a35", + "api-version": "2017-05-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "name": "2bd77cfa-2e9c-41b4-a45b-684a77cfeca9", + "properties": { + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "configuredDuration": "PT2H", + "osType": "Windows", + "startTime": "2017-10-23T02:30:36.2401233+00:00", + "endTime": "2017-10-23T02:30:42.8466667+00:00", + "computerCount": 1, + "failedCount": 0, + "tasks": { + "preTask": { + "jobId": "be430e9e-2290-462e-8f86-686407c35fab", + "source": "preRunbook", + "status": "Completed" + }, + "postTask": null + }, + "creationTime": "2017-10-23T02:30:36.2401233+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T02:31:39.3966667+00:00" + } + }, + { + "id": "/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/myaccount/softwareUpdateConfigurationRuns/5dabff55-9812-4a58-af16-b0cb1d9384e8", + "name": "5dabff55-9812-4a58-af16-b0cb1d9384e8", + "properties": { + "softwareUpdateConfiguration": { + "name": "mypatch" + }, + "status": "Succeeded", + "configuredDuration": "PT2H", + "osType": "Windows", + "startTime": "2017-10-23T01:33:01.8818952+00:00", + "endTime": "2017-10-23T01:33:08.1133333+00:00", + "computerCount": 1, + "failedCount": 0, + "tasks": { + "preTask": { + "jobId": "be430e9e-2290-462e-8f86-686407c35fab", + "source": "preRunbook", + "status": "Completed" + }, + "postTask": null + }, + "creationTime": "2017-10-23T01:33:01.8818952+00:00", + "lastModifiedBy": "", + "lastModifiedTime": "2017-10-23T01:34:03.94+00:00" + } + } + ], + "nextLink": "https://management.azure.com:443/subscriptions/1a7d4044-286c-4acb-969a-96639265bf2e/resourceGroups/mygroup/providers/Microsoft.Automation/automationAccounts/stas-wcus/softwareUpdateConfigurationRuns?api-version=2017-05-15-preview&_=1508725900015&$skip=100" + } } + } } \ No newline at end of file diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json index 590bdc9328fa..53ee14a4786c 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json @@ -324,19 +324,19 @@ "readOnly": true }, "error": { - "description": "detailes of provisioning error", + "description": "Details of provisioning error", "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" }, "creationTime": { "type": "string", - "description": "Creation time of theresource, which only appears in the response.", + "description": "Creation time of the resource, which only appears in the response.", "format": "date-time", "x-nullable": false, "readOnly": true }, "createdBy": { "type": "string", - "description": "createdBy property, which only appears in the response.", + "description": "CreatedBy property, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { @@ -348,8 +348,12 @@ }, "lastModifiedBy": { "type": "string", - "description": "lastModifiedBy property, which only appears in the response.", + "description": "LastModifiedBy property, which only appears in the response.", "readOnly": true + }, + "tasks": { + "description": "Tasks information for the Software update configuration.", + "$ref": "#/definitions/softwareUpdateConfigurationTasks" } }, "required": [ @@ -357,6 +361,37 @@ "scheduleInfo" ] }, + "softwareUpdateConfigurationTasks": { + "type": "object", + "description": "Task properties of the software update configuration.", + "properties": { + "preTask": { + "description": "Pre task properties.", + "$ref": "#/definitions/taskProperties" + }, + "postTask": { + "description": "Post task properties.", + "$ref": "#/definitions/taskProperties" + } + } + }, + "taskProperties": { + "type": "object", + "description": "Task properties of the software update configuration.", + "properties": { + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Gets or sets the parameters of the task." + }, + "source": { + "type": "string", + "description": "Gets or sets the name of the runbook." + } + } + }, "WindowsProperties": { "type": "object", "description": "Windows specific update configuration.", @@ -781,7 +816,7 @@ "description": "Subscription or Resource Group ARM Id." } }, - "location": { + "locations": { "type": "array", "description": "List of locations to scope the query to.", "items": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json index 1c0d900ede66..f50ae709bc78 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json @@ -294,6 +294,10 @@ "type": "string", "description": "lastModifiedBy property, which only appears in the response.", "readOnly": true + }, + "error": { + "description": "detailes of provisioning error", + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } }, diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json index 5154a99912ea..9285acfd9912 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json @@ -7,7 +7,7 @@ "name": "Mohamed Enein" }, "version": "2017-05-15-preview", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, @@ -143,7 +143,7 @@ "in": "query", "required": false, "type": "string", - "description": "number of entries you skip before returning results" + "description": "Number of entries you skip before returning results" }, { "name": "$top", @@ -207,7 +207,7 @@ }, "configuredDuration": { "type": "string", - "description": "configured duration for the software update configuration run.", + "description": "Configured duration for the software update configuration run.", "readOnly": true }, "osType": { @@ -219,7 +219,7 @@ "type": "string", "format": "date-time", "x-nullable": false, - "description": "Etart time of the software update configuration run.", + "description": "Start time of the software update configuration run.", "readOnly": true }, "endTime": { @@ -248,7 +248,7 @@ }, "createdBy": { "type": "string", - "description": "createdBy property, which only appears in the response.", + "description": "CreatedBy property, which only appears in the response.", "readOnly": true }, "lastModifiedTime": { @@ -260,8 +260,44 @@ }, "lastModifiedBy": { "type": "string", - "description": "lastModifiedBy property, which only appears in the response.", + "description": "LastModifiedBy property, which only appears in the response.", "readOnly": true + }, + "tasks": { + "description": "Software update configuration tasks triggered in this run", + "$ref": "#/definitions/softareUpdateConfigurationRunTasks" + } + } + }, + "softareUpdateConfigurationRunTasks": { + "description": "Software update configuration run tasks model.", + "type": "object", + "properties": { + "preTask": { + "description": "Pre task properties.", + "$ref": "#/definitions/softareUpdateConfigurationRunTaskProperties" + }, + "postTask": { + "description": "Post task properties.", + "$ref": "#/definitions/softareUpdateConfigurationRunTaskProperties" + } + } + }, + "softareUpdateConfigurationRunTaskProperties": { + "type": "object", + "description": "Task properties of the software update configuration.", + "properties": { + "status": { + "type": "string", + "description": "The status of the task." + }, + "source": { + "type": "string", + "description": "The name of the source of the task." + }, + "jobId": { + "type": "string", + "description": "The job id of the task." } } }, From d05e47d4c24303b34f50cee52702ebf921497f97 Mon Sep 17 00:00:00 2001 From: promoisha Date: Tue, 23 Oct 2018 16:29:55 -0700 Subject: [PATCH 045/464] enableHttpCorrelationHeaders property is added to the Diagnostic entity (#4248) --- .../preview/2018-06-01-preview/apimdiagnostics.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json index 396d6a0f5903..9f2383a28c83 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json @@ -485,6 +485,10 @@ "backend": { "$ref": "#/definitions/PipelineDiagnosticSettings", "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Backend" + }, + "enableHttpCorrelationHeaders": { + "type": "boolean", + "description": "Whether to process Correlation Headers coming to Api Management Service. Only applicable to Application Insights diagnostics. Default is true." } }, "required": [ From 2d3df54dc72c6a04647b3741f9ee2ed0032f3808 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Thu, 25 Oct 2018 00:32:58 +0800 Subject: [PATCH 046/464] fixed spelling mistake (#4313) --- .../preview/2017-03-01-preview/longTermRetention.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json index 8049cf5fefca..84520a0b08bd 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json @@ -561,7 +561,7 @@ "type": "string" }, "monthlyRetention": { - "description": "The montly retention policy for an LTR backup in an ISO 8601 format.", + "description": "The monthly retention policy for an LTR backup in an ISO 8601 format.", "type": "string" }, "yearlyRetention": { From b3376ed914f181fdb07706d52586710f444b43df Mon Sep 17 00:00:00 2001 From: chlahav Date: Wed, 24 Oct 2018 20:28:01 +0300 Subject: [PATCH 047/464] Azure Security Center - Adding support for Python, TypeScript and Node.js (#4301) --- .../security/resource-manager/readme.md | 12 +++++++++ .../resource-manager/readme.nodejs.md | 14 ++++++++++ .../resource-manager/readme.python.md | 27 +++++++++++++++++++ .../resource-manager/readme.typescript.md | 12 +++++++++ 4 files changed, 65 insertions(+) create mode 100644 specification/security/resource-manager/readme.nodejs.md create mode 100644 specification/security/resource-manager/readme.python.md create mode 100644 specification/security/resource-manager/readme.typescript.md diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index ee6e112ca887..5d00ac9166d9 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -81,3 +81,15 @@ csharp: ## Go See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Node.js + +See configuration in [readme.nodejs.md](./readme.nodejs.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) \ No newline at end of file diff --git a/specification/security/resource-manager/readme.nodejs.md b/specification/security/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..17123a077d9d --- /dev/null +++ b/specification/security/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-security + output-folder: $(node-sdks-folder)/lib/services/securityManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/security/resource-manager/readme.python.md b/specification/security/resource-manager/readme.python.md new file mode 100644 index 000000000000..a542fe6d005a --- /dev/null +++ b/specification/security/resource-manager/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: azure.mgmt.security + package-name: azure-mgmt-security + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-security/azure/mgmt/security +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-security +``` diff --git a/specification/security/resource-manager/readme.typescript.md b/specification/security/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..690791cbd881 --- /dev/null +++ b/specification/security/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-security" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-security" + generate-metadata: true +``` From 70a6f20a9ae48d919e1265f2094c67960e029518 Mon Sep 17 00:00:00 2001 From: msxzq <44255871+msxzq@users.noreply.github.com> Date: Thu, 25 Oct 2018 01:45:35 +0800 Subject: [PATCH 048/464] Revert "Swagger changes for connectors: Google AdWords, Oracle Service Cloud, OData, Rest Service, Dynamics AX and support for wildcardPath. (#4258)" (#4309) This reverts commit c7b860297ddf53c1f9ef501583c824fdd00cbc40. --- .../2018-06-01/entityTypes/Dataset.json | 126 +------ .../2018-06-01/entityTypes/LinkedService.json | 329 +----------------- .../2018-06-01/entityTypes/Pipeline.json | 73 +--- 3 files changed, 21 insertions(+), 507 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 1e26ca5e9325..e2ab56cec7a8 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -337,10 +337,6 @@ "type": "object", "description": "The prefix filter for the S3 object name. Type: string (or Expression with resultType string)." }, - "wildcardPath": { - "type": "object", - "description": "The path of the S3 object with wildcard supported. Type: string (or Expression with resultType string)." - }, "version": { "type": "object", "description": "The version for the S3 object. Type: string (or Expression with resultType string)." @@ -393,10 +389,6 @@ "type": "object", "description": "The name of the Azure Blob. Type: string (or Expression with resultType string)." }, - "wildcardPath": { - "type": "object", - "description": "The whole path include file name of the Azure Blob storage with wildcard supported. Type: string (or Expression with resultType string)." - }, "format": { "description": "The format of the Azure Blob storage.", "$ref": "#/definitions/DatasetStorageFormat" @@ -616,38 +608,6 @@ } } }, - "DynamicsAXResourceDataset": { - "x-ms-discriminator-value": "DynamicsAXResource", - "description": "The path of the Dynamics AX OData entity.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Dynamics AX OData resource dataset properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DynamicsAXResourceDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DynamicsAXResourceDatasetTypeProperties": { - "description": "Dynamics AX OData resource dataset properties.", - "properties": { - "path": { - "type": "string", - "description": "The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "path" - ] - }, "AzureDataLakeStoreDataset": { "x-ms-discriminator-value": "AzureDataLakeStoreFile", "description": "Azure Data Lake Store dataset.", @@ -683,15 +643,14 @@ "description": "The format of the Data Lake Store.", "$ref": "#/definitions/DatasetStorageFormat" }, - "wildcardPath": { - "type": "object", - "description": "The whole path include file name in the Azure Data Lake Store with wildcard supported. Type: string (or Expression with resultType string)." - }, "compression": { "description": "The data compression method used for the item(s) in the Azure Data Lake Store.", "$ref": "#/definitions/DatasetCompression" } - } + }, + "required": [ + "folderPath" + ] }, "FileShareDataset": { "x-ms-discriminator-value": "FileShare", @@ -724,10 +683,6 @@ "type": "object", "description": "The name of the on-premises file system. Type: string (or Expression with resultType string)." }, - "wildcardPath": { - "type": "object", - "description": "The whole path include file name of the on-premises file system with wildcard supported. Type: string (or Expression with resultType string)." - }, "format": { "description": "The format of the files.", "$ref": "#/definitions/DatasetStorageFormat" @@ -835,18 +790,6 @@ "tableName" ] }, - "OracleServiceCloudObjectDataset" : { - "x-ms-discriminator-value": "OracleServiceCloudObject", - "description": "Oracle Service Cloud dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, "AzureMySqlTableDataset": { "x-ms-discriminator-value": "AzureMySqlTable", "description": "The Azure MySQL database dataset.", @@ -1147,51 +1090,6 @@ } } }, - "RestServiceDataset": { - "x-ms-discriminator-value": "RestResource", - "description": "A Rest service dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - "typeProperties": { - "description": "Properties specific to this dataset type.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RestServiceDatasetTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "RestServiceDatasetTypeProperties": { - "description": "Properties specific to this dataset type.", - "properties": { - "relativeUrl": { - "type": "object", - "description": "The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string)." - }, - "requestMethod": { - "type": "object", - "description": "The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string)." - }, - "requestBody": { - "type": "object", - "description": "The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string)." - }, - "additionalHeaders": { - "type": "object", - "description": "The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string)." - }, - "paginationRules": { - "description": "The pagination rules to compose next page requests.", - "type": "object" - } - } - }, "AmazonMWSObjectDataset" : { "x-ms-discriminator-value": "AmazonMWSObject", "description": "Amazon Marketplace Web Service dataset.", @@ -1253,20 +1151,8 @@ } }, "EloquaObjectDataset" : { - "x-ms-discriminator-value": "EloquaObject", - "description": "Eloqua server dataset.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Dataset" - } - ], - "properties": { - } - }, - "GoogleAdWordsObjectDataset" : { - "x-ms-discriminator-value": "GoogleAdWordsObject", - "description": "Google AdWords service dataset.", + "x-ms-discriminator-value": "EloquaObject", + "description": "Eloqua server dataset.", "type": "object", "allOf": [ { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 8fc15ddd557a..b893ab4f12a0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -459,8 +459,8 @@ "description": "The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0." }, "serviceUri": { - "type": "object", - "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." + "type": "object", + "description": "The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string)." }, "organizationName": { "type": "object", @@ -497,58 +497,6 @@ "username" ] }, - "DynamicsAXLinkedService": { - "x-ms-discriminator-value": "DynamicsAX", - "description": "Dynamics AX linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Dynamics AX linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/DynamicsAXLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "DynamicsAXLinkedServiceTypeProperties": { - "description": "Dynamics AX linked service properties.", - "properties": { - "url": { - "type": "object", - "description": "The URL of Dynamics AX OData API. Type: string (or Expression with resultType string)." - }, - "tenant": { - "type": "object", - "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." - }, - "servicePrincipalId": { - "type": "object", - "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." - }, - "aadResourceId": { - "type": "object", - "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." - }, - "servicePrincipalKey": { - "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "encryptedCredential": { - "type": "object", - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string (or Expression with resultType string)." - } - }, - "required": [ - "url" - ] - }, "HDInsightLinkedService": { "x-ms-discriminator-value": "HDInsight", "description": "HDInsight linked service.", @@ -681,64 +629,6 @@ "connectionString" ] }, - "OracleServiceCloudLinkedService": { - "x-ms-discriminator-value": "OracleServiceCloud", - "description": "Oracle Service Cloud linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Oracle Service Cloud linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/OracleServiceCloudLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "OracleServiceCloudLinkedServiceTypeProperties": { - "description": "Oracle Service Cloud linked service properties.", - "properties": { - "host": { - "description": "The URL of the Oracle Service Cloud instance.", - "type": "object" - }, - "username": { - "description": "The user name that you use to access Oracle Service Cloud server.", - "type": "object" - }, - "password": { - "description": "The password corresponding to the user name that you provided in the username key.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "useEncryptedEndpoints": { - "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", - "type": "object" - }, - "useHostVerification": { - "description": "Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", - "type": "object" - }, - "usePeerVerification": { - "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean).", - "type": "object" - }, - "encryptedCredential": { - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", - "type": "object" - } - }, - "required": [ - "host", - "username", - "password" - ] - }, "AzureMySqlLinkedService": { "x-ms-discriminator-value": "AzureMySql", "description": "Azure MySQL database linked service.", @@ -1216,11 +1106,8 @@ "description": "Type of authentication used to connect to the OData service.", "type": "string", "enum": [ - "Anonymous", "Basic", - "Windows", - "AadServicePrincipal", - "ManagedServiceIdentity" + "Anonymous" ], "x-ms-enum": { "name": "ODataAuthenticationType", @@ -1235,50 +1122,13 @@ "description": "Password of the OData service.", "$ref": "../datafactory.json#/definitions/SecretBase" }, - "tenant": { - "type": "object", - "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string)." - }, - "servicePrincipalId": { - "type": "object", - "description": "Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string)." - }, - "aadResourceId": { - "type": "object", - "description": "Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string)." - }, - "aadServicePrincipalCredentialType": { - "description": "Specify the credential type (key or cert) is used for service principal.", - "type": "string", - "enum": [ - "ServicePrincipalKey", - "ServicePrincipalCert" - ], - "x-ms-enum": { - "name": "ODataAadServicePrincipalCredentialType", - "modelAsString": true - } - }, - "servicePrincipalKey": { - "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "servicePrincipalEmbeddedCert": { - "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "servicePrincipalEmbeddedCertPassword": { - "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." } }, "required": [ - "url", - "authenticationType" + "url" ] }, "WebLinkedService": { @@ -1926,85 +1776,6 @@ "url" ] }, - "RestServiceLinkedService": { - "x-ms-discriminator-value": "RestService", - "description": "Rest Service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Rest Service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RestServiceLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "RestServiceLinkedServiceTypeProperties": { - "description": "Rest Service linked service properties.", - "properties": { - "url": { - "description": "The base URL of the REST service.", - "type": "object" - }, - "enableServerCertificateValidation": { - "type": "object", - "description": "Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean)." - }, - "authenticationType": { - "description": "Type of authentication used to connect to the REST service.", - "type": "string", - "enum": [ - "Anonymous", - "Basic", - "AadServicePrincial", - "ManagedServiceIdentity" - ], - "x-ms-enum": { - "name": "RestServiceAuthenticationType", - "modelAsString": true - } - }, - "userName": { - "description": "The user name used in Basic authentication type.", - "type": "object" - }, - "password": { - "description": "The password used in Basic authentication type.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "servicePrincipalId": { - "description": "The application’s client ID used in AadServicePrincipal authentication type.", - "type": "object" - }, - "servicePrincipalKey": { - "description": "The application’s key used in AadServicePrincipal authentication type.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "tenant": { - "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.", - "type": "object" - }, - "aadResourceId": { - "description": "The resource you are requesting authorization to use.", - "type": "object" - }, - "encryptedCredential": { - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", - "type": "object" - } - }, - "required": [ - "url", - "authenticationType" - ] - }, "FtpServerLinkedService": { "x-ms-discriminator-value": "FtpServer", "description": "A FTP server Linked Service.", @@ -2509,9 +2280,9 @@ "required": [ "typeProperties" ] - }, - "EloquaLinkedServiceTypeProperties": { - "description": "Eloqua server linked service properties.", + }, + "EloquaLinkedServiceTypeProperties": { + "description": "Eloqua server linked service properties.", "properties": { "endpoint": { "description": "The endpoint of the Eloqua server. (i.e. eloqua.example.com)", @@ -2537,96 +2308,14 @@ "description": "Specifies whether to verify the identity of the server when connecting over SSL. The default value is true.", "type": "object" }, - "encryptedCredential": { - "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", - "type": "object" - } - }, - "required": [ - "endpoint", - "username" - ] - }, - "GoogleAdWordsLinkedService": { - "x-ms-discriminator-value": "GoogleAdWords", - "description": "Google Awords service linked service.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/LinkedService" - } - ], - "properties": { - "typeProperties": { - "description": "Google AdWords service linked service properties.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/GoogleAdWordsLinkedServiceTypeProperties" - } - }, - "required": [ - "typeProperties" - ] - }, - "GoogleAdWordsLinkedServiceTypeProperties": { - "description": "Google AdWords service linked service properties.", - "properties": { - "clientCustomerID": { - "description": "The Client customer ID of the AdWords account that you want to fetch report data for.", - "type": "object" - }, - "developerToken":{ - "description": "The developer token associated with the manager account that you use to grant access to the AdWords API.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "authenticationType": { - "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", - "type": "string", - "enum": [ - "ServiceAuthentication", - "UserAuthentication" - ], - "x-ms-enum": { - "name": "GoogleAdWordsAuthenticationType", - "modelAsString": true - } - }, - "refreshToken": { - "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "clientId": { - "description": "The client id of the google application used to acquire the refresh token.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "clientSecret": { - "description": "The client secret of the google application used to acquire the refresh token.", - "$ref": "../datafactory.json#/definitions/SecretBase" - }, - "email": { - "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", - "type": "object" - }, - "keyFilePath": { - "description": "The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR.", - "type": "object" - }, - "trustedCertPath": { - "description": "The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR.", - "type": "object" - }, - "useSystemTrustStore": { - "description": "Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.", - "type": "object" - }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } }, "required": [ - "clientCustomerID", - "developerToken", - "authenticationType" + "endpoint", + "username" ] }, "GoogleBigQueryLinkedService": { 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 1ca8adb3f12f..24fdecaf29ea 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 @@ -384,21 +384,6 @@ } } }, - "DynamicsAXSource": { - "description": "A copy activity Dynamics AX source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, "RelationalSource": { "description": "A copy activity source for various relational databases.", "type": "object", @@ -610,21 +595,6 @@ } } }, - "OracleServiceCloudSource": { - "description": "A copy activity Oracle Service Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, "WebSource": { "description": "A copy activity source for web page table.", "type": "object", @@ -715,25 +685,6 @@ } } }, - "RestServiceSource": { - "description": "A copy activity Rest service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "httpRequestTimeout": { - "type": "object", - "description": "The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - }, - "requestInterval": { - "type": "object", - "description": "The time to await before sending next page request. Default value: 00:00:01. Type: string (or Expression with resultType string), pattern: ((\\d+)\\.)?(\\d\\d):(60|([0-5][0-9])):(60|([0-5][0-9]))." - } - } - }, "AmazonMWSSource": { "description": "A copy activity Amazon Marketplace Web Service source.", "type": "object", @@ -808,24 +759,9 @@ "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." } } - }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } }, - "GoogleAdWordsSource": { - "description": "A copy activity Google AdWords service source.", + "EloquaSource": { + "description": "A copy activity Eloqua server source.", "type": "object", "allOf": [ { @@ -1248,7 +1184,10 @@ "description": "Stored procedure parameter type.", "$ref": "#/definitions/StoredProcedureParameterType" } - } + }, + "required": [ + "value" + ] }, "StoredProcedureParameterType": { "description": "Stored procedure parameter type.", From 1a18642a1392eb51e6a2d2b941a53c75bf00f8f9 Mon Sep 17 00:00:00 2001 From: chlahav Date: Wed, 24 Oct 2018 21:02:39 +0300 Subject: [PATCH 049/464] Azure Security Center - Adding code generation attributes (#4315) --- specification/security/resource-manager/readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 5d00ac9166d9..c7fe5ac06716 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -61,6 +61,9 @@ This is not used by Autorest itself. ```yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node ``` ## C From ec1de75b7b9cbadaee7f5401241ba84930581551 Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Wed, 24 Oct 2018 13:24:04 -0700 Subject: [PATCH 050/464] Change Host name from swagger (#4317) --- .../Microsoft.StorageSync/2017-06-05-preview/storagesync.json | 2 +- .../Microsoft.StorageSync/preview/2018-10-01/storagesync.json | 2 +- .../Microsoft.StorageSync/stable/2018-04-02/storagesync.json | 2 +- .../Microsoft.StorageSync/stable/2018-07-01/storagesync.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json index 08433c1f1f36..8173b4765fea 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json @@ -8,7 +8,7 @@ "name": "StorageSyncManagementClient" } }, - "host": "azure.microsoft.com", + "host": "management.azure.com", "schemes": [ "https" ], diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index 620d1729af82..fdf5225bbcde 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -8,7 +8,7 @@ "name": "StorageSyncManagementClient" } }, - "host": "azure.microsoft.com", + "host": "management.azure.com", "schemes": [ "https" ], diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json index f2343e2ae384..35081af77fa1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json @@ -8,7 +8,7 @@ "name": "StorageSyncManagementClient" } }, - "host": "azure.microsoft.com", + "host": "management.azure.com", "schemes": [ "https" ], diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json index 4a401cee54b1..6feff0373787 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json @@ -8,7 +8,7 @@ "name": "StorageSyncManagementClient" } }, - "host": "azure.microsoft.com", + "host": "management.azure.com", "schemes": [ "https" ], From 5ed70a2b9c9f34d56e7886e3aa8fac40c9b60eae Mon Sep 17 00:00:00 2001 From: binuj <32344026+binuj@users.noreply.github.com> Date: Wed, 24 Oct 2018 14:33:35 -0700 Subject: [PATCH 051/464] Add missing files resource management options for Schema migration scenario. Add support for MongoDb migration scenario. Iter2: Fixed Files_Delete example to include fileName parameter (#4240) --- .../2018-07-15-preview/datamigration.json | 311 +++++++++ .../definitions/Common.json | 18 + .../2018-07-15-preview/definitions/Files.json | 104 +++ .../MigrateSchemaSqlServerSqlDbTask.json | 4 + .../definitions/MongoDbTasks.json | 609 ++++++++++++++++++ .../definitions/Projects.json | 2 + .../2018-07-15-preview/definitions/Tasks.json | 68 ++ .../examples/Files_CreateOrUpdate.json | 41 ++ .../examples/Files_Delete.json | 18 + .../examples/Files_Get.json | 26 + .../examples/Files_List.json | 41 ++ .../examples/Files_Read.json | 20 + .../examples/Files_ReadWrite.json | 20 + .../examples/Files_Update.json | 29 + 14 files changed, 1311 insertions(+) create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_CreateOrUpdate.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Delete.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Get.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_List.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Read.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_ReadWrite.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Update.json diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json index d8e18f5e0b9e..1a5e8201b4df 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json @@ -1165,6 +1165,299 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/files": { + "get": { + "summary": "Get files in a project", + "description": "The project resource is a nested resource representing a stored migration project. This method returns a list of files owned by a project resource.", + "tags": [ + "File resource", + "Standard operation", + "GET" + ], + "operationId": "Files_List", + "x-ms-examples": { + "Files_List": { "$ref": "./examples/Files_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List of files", + "schema": { + "$ref": "./definitions/Files.json#/definitions/FileList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/files/{fileName}": { + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/fileName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "get": { + "summary": "Get file information", + "description": "The files resource is a nested, proxy-only resource representing a file stored under the project resource. This method retrieves information about a file.", + "tags": [ + "File resource", + "Standard operation", + "GET" + ], + "operationId": "Files_Get", + "x-ms-examples": { + "Files_List": { "$ref": "./examples/Files_Get.json" } + }, + "responses": { + "200": { + "description": "A file resource", + "schema": { + "$ref": "./definitions/Files.json#/definitions/ProjectFile" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "put": { + "summary": "Create a file resource", + "description": "The PUT method creates a new file or updates an existing one.", + "tags": [ + "Fie resource", + "Standard operation", + "PUT" + ], + "operationId": "Files_CreateOrUpdate", + "x-ms-examples": { + "Files_CreateOrUpdate": { "$ref": "./examples/Files_CreateOrUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/projectFile" + } + ], + "responses": { + "200": { + "description": "File updated", + "schema": { + "$ref": "./definitions/Files.json#/definitions/ProjectFile" + } + }, + "201": { + "description": "File created", + "schema": { + "$ref": "./definitions/Files.json#/definitions/ProjectFile" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "delete": { + "summary": "Delete file", + "description": "This method deletes a file.", + "tags": [ + "File resource", + "Standard operation", + "DELETE" + ], + "operationId": "Files_Delete", + "x-ms-examples": { + "Files_Delete": { "$ref": "./examples/Files_Delete.json" } + }, + "responses": { + "200": { + "description": "File resource deleted" + }, + "204": { + "description": "Not found" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + }, + "patch": { + "summary": "Update a file", + "description": "This method updates an existing file.", + "tags": [ + "File resource", + "Standard operation", + "PATCH" + ], + "operationId": "Files_Update", + "x-ms-examples": { + "Files_Update": { "$ref": "./examples/Files_Update.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/projectFile" + } + ], + "responses": { + "200": { + "description": "File resource updated", + "schema": { + "$ref": "./definitions/Files.json#/definitions/ProjectFile" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/files/{fileName}/read": { + "post": { + "summary": "Request storage information for downloading the file content", + "description": "This method is used for requesting storage information using which contents of the file can be downloaded.", + "tags": [ + "File resource", + "Standard operation", + "POST" + ], + "operationId": "Files_Read", + "x-ms-examples": { + "Files_List": { "$ref": "./examples/Files_Read.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/fileName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "An object describing how to access the file content", + "schema": { + "$ref": "./definitions/Files.json#/definitions/FileStorageInfo" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/projects/{projectName}/files/{fileName}/readwrite": { + "post": { + "summary": "Request information for reading and writing file content.", + "description": "This method is used for requesting information for reading and writing the file content.", + "tags": [ + "File resource", + "Standard operation", + "POST" + ], + "operationId": "Files_ReadWrite", + "x-ms-examples": { + "Files_List": { "$ref": "./examples/Files_ReadWrite.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/groupName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/projectName" + }, + { + "$ref": "#/parameters/fileName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "An object describing how to access the file content", + "schema": { + "$ref": "./definitions/Files.json#/definitions/FileStorageInfo" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./definitions/Common.json#/definitions/ApiError" + } + } + } + } } }, "parameters": { @@ -1296,6 +1589,24 @@ "$ref": "./definitions/Commands.json#/definitions/CommandProperties" }, "x-ms-parameter-location": "method" + }, + "projectFile": { + "name": "parameters", + "description": "Information about the file", + "in": "body", + "required": true, + "schema": { + "$ref": "./definitions/Files.json#/definitions/ProjectFile" + }, + "x-ms-parameter-location": "method" + }, + "fileName": { + "name": "fileName", + "description": "Name of the File", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json index a8cc6b2fcb37..25a341d55f38 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json @@ -265,6 +265,24 @@ "modelAsString": true } }, + "MongoDbConnectionInfo": { + "type": "object", + "description": "Describes a connection to a MongoDB data source", + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "properties": { + "connectionString": { + "type": "string", + "description": "A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties" + } + }, + "required": [ + "connectionString" + ] + }, "SqlConnectionInfo": { "x-ms-discriminator-value": "SqlConnectionInfo", "type": "object", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json new file mode 100644 index 000000000000..06a51036440a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json @@ -0,0 +1,104 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Data Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ProjectFileProperties": { + "type": "object", + "description": "Base class for file properties.", + "properties": { + "extension": { + "description": "Optional File extension. If submitted it should not have a leading period and must match the extension from filePath.", + "type": "string" + }, + "filePath": { + "description": "Relative path of this file resource. This property can be set when creating or updating the file resource.", + "type": "string" + }, + "lastModified": { + "description": "Modification DateTime.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "mediaType": { + "description": "File content type. This propery can be modified to reflect the file content type.", + "type": "string" + }, + "size": { + "description": "File size.", + "type": "integer", + "format": "int64", + "readOnly": true + } + } + }, + "ProjectFile": { + "type": "object", + "description": "A file resource", + "properties": { + "etag": { + "type": "string", + "description": "HTTP strong entity tag value. This is ignored if submitted." + }, + "properties": { + "description": "Custom file properties", + "$ref": "#/definitions/ProjectFileProperties" + } + }, + "allOf": [ + { + "$ref": "./Common.json#/definitions/Resource" + } + ] + }, + "FileList": { + "type": "object", + "description": "OData page of files", + "properties": { + "value": { + "type": "array", + "description": "List of files", + "items": { + "$ref": "#/definitions/ProjectFile" + } + }, + "nextLink": { + "type": "string", + "description": "URL to load the next page of files" + } + } + }, + "FileStorageInfo": { + "type": "object", + "description": "File storage information.", + "x-ms-discriminator-value": "Unknown", + "properties": { + "uri": { + "description": "A URI that can be used to access the file content.", + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json index 398fb8200bef..1fbe91ebb8a2 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json @@ -66,6 +66,10 @@ "type": "object", "description": "Database input for migrate schema Sql Server to Azure SQL Server scenario", "properties": { + "name": { + "type": "string", + "description": "Name of source database" + }, "targetDatabaseName": { "type": "string", "description": "Name of target database" diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json new file mode 100644 index 000000000000..6056ff1e75df --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json @@ -0,0 +1,609 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Data Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MongoDbCancelCommand": { + "x-ms-discriminator-value": "cancel", + "type": "object", + "description": "Properties for the command that cancels a migration in whole or in part", + "properties": { + "input": { + "$ref": "#/definitions/MongoDbCommandInput", + "description": "Command input" + } + }, + "allOf": [ + { + "$ref": "Commands.json#/definitions/CommandProperties" + } + ] + }, + "MongoDbClusterInfo": { + "type": "object", + "description": "Describes a MongoDB data source", + "properties": { + "databases": { + "type": "array", + "items": { + "$ref": "#/definitions/MongoDbDatabaseInfo" + }, + "description": "A list of non-system databases in the cluster" + }, + "supportsSharding": { + "type": "boolean", + "description": "Whether the cluster supports sharded collections" + }, + "type": { + "type": "string", + "description": "The type of data source", + "enum": [ + "BlobContainer", + "CosmosDb", + "MongoDb" + ], + "x-ms-enum": { + "name": "MongoDbClusterType", + "modelAsString": true + } + }, + "version": { + "type": "string", + "description": "The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer." + } + }, + "required": [ + "databases", + "supportsSharding", + "type", + "version" + ] + }, + "MongoDbCollectionInfo": { + "type": "object", + "description": "Describes a supported collection within a MongoDB database", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the database containing the collection" + }, + "isCapped": { + "type": "boolean", + "description": "Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer)" + }, + "isSystemCollection": { + "type": "boolean", + "description": "Whether the collection is system collection" + }, + "isView": { + "type": "boolean", + "description": "Whether the collection is a view of another collection" + }, + "shardKey": { + "$ref": "#/definitions/MongoDbShardKeyInfo", + "description": "The shard key on the collection, or null if the collection is not sharded" + }, + "supportsSharding": { + "type": "boolean", + "description": "Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary." + }, + "viewOf": { + "type": "string", + "description": "The name of the collection that this is a view of, if IsView is true" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MongoDbObjectInfo" + } + ], + "required": [ + "databaseName", + "isCapped", + "isSystemCollection", + "isView", + "supportsSharding" + ] + }, + "MongoDbCollectionProgress": { + "x-ms-discriminator-value": "Collection", + "type": "object", + "description": "Describes the progress of a collection", + "allOf": [ + { + "$ref": "#/definitions/MongoDbProgress" + } + ] + }, + "MongoDbCollectionSettings": { + "type": "object", + "description": "Describes how an individual MongoDB collection should be migrated", + "properties": { + "canDelete": { + "type": "boolean", + "description": "Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true." + }, + "shardKey": { + "$ref": "#/definitions/MongoDbShardKeySetting" + }, + "targetRUs": { + "type": "integer", + "format": "int32", + "description": "The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets." + } + } + }, + "MongoDbCommandInput": { + "type": "object", + "description": "Describes the input to the 'cancel' and 'restart' MongoDB migration commands", + "properties": { + "objectName": { + "type": "string", + "description": "The qualified name of a database or collection to act upon, or null to act upon the entire migration" + } + } + }, + "MongoDbDatabaseInfo": { + "type": "object", + "description": "Describes a database within a MongoDB data source", + "properties": { + "collections": { + "type": "array", + "items": { + "$ref": "#/definitions/MongoDbCollectionInfo" + }, + "description": "A list of supported collections in a MongoDB database" + }, + "supportsSharding": { + "type": "boolean", + "description": "Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MongoDbObjectInfo" + } + ], + "required": [ + "collections", + "supportsSharding" + ] + }, + "MongoDbDatabaseProgress": { + "x-ms-discriminator-value": "Database", + "type": "object", + "description": "Describes the progress of a database", + "properties": { + "collections": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MongoDbCollectionProgress" + }, + "description": "The progress of the collections in the database. The keys are the unqualified names of the collections" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MongoDbProgress" + } + ] + }, + "MongoDbDatabaseSettings": { + "type": "object", + "description": "Describes how an individual MongoDB database should be migrated", + "properties": { + "collections": { + "type": "object", + "description": "The collections on the source database to migrate to the target. The keys are the unqualified names of the collections.", + "additionalProperties": { + "$ref": "#/definitions/MongoDbCollectionSettings" + } + }, + "targetRUs": { + "type": "integer", + "format": "int32", + "description": "The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets." + } + }, + "required": [ + "collections" + ] + }, + "MongoDbError": { + "type": "object", + "description": "Describes an error or warning that occurred during a MongoDB migration", + "properties": { + "code": { + "type": "string", + "description": "The non-localized, machine-readable code that describes the error or warning" + }, + "count": { + "type": "integer", + "format": "int32", + "description": "The number of times the error or warning has occurred" + }, + "message": { + "type": "string", + "description": "The localized, human-readable message that describes the error or warning" + }, + "type": { + "type": "string", + "description": "The type of error or warning", + "enum": [ + "Error", + "ValidationError", + "Warning" + ], + "x-ms-enum": { + "name": "MongoDbErrorType", + "modelAsString": true + } + } + } + }, + "MongoDbFinishCommand": { + "x-ms-discriminator-value": "restart", + "type": "object", + "description": "Properties for the command that finishes a migration in whole or in part", + "properties": { + "input": { + "$ref": "#/definitions/MongoDbFinishCommandInput", + "description": "Command input" + } + }, + "allOf": [ + { + "$ref": "Commands.json#/definitions/CommandProperties" + } + ] + }, + "MongoDbFinishCommandInput": { + "type": "object", + "description": "Describes the input to the 'finish' MongoDB migration command", + "properties": { + "immediate": { + "type": "boolean", + "description": "If true, replication for the affected objects will be stopped immediately. If false, the migrator will finish replaying queued events before finishing the replication." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MongoDbCommandInput" + } + ], + "required": [ + "immediate" + ] + }, + "MongoDbMigrationSettings": { + "type": "object", + "description": "Describes how a MongoDB data migration should be performed", + "properties": { + "boostRUs": { + "type": "integer", + "format": "int32", + "description": "The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets." + }, + "databases": { + "type": "object", + "description": "The databases on the source cluster to migrate to the target. The keys are the names of the databases.", + "additionalProperties": { + "$ref": "#/definitions/MongoDbDatabaseSettings" + } + }, + "replication": { + "type": "string", + "description": "Describes how changes will be replicated from the source to the target. The default is OneTime.", + "enum": [ + "Disabled", + "OneTime", + "Continuous" + ], + "x-ms-enum": { + "name": "MongoDbReplication", + "modelAsString": true + } + }, + "source": { + "$ref": "./Common.json#/definitions/MongoDbConnectionInfo", + "description": "Settings used to connect to the source cluster" + }, + "target": { + "$ref": "./Common.json#/definitions/MongoDbConnectionInfo", + "description": "Settings used to connect to the target cluster" + }, + "throttling": { + "$ref": "#/definitions/MongoDbThrottlingSettings", + "description": "Settings used to limit the resource usage of the migration" + } + }, + "required": [ + "databases", + "source", + "target" + ] + }, + "MongoDbProgress": { + "type": "object", + "description": "Base class for MongoDB migration outputs", + "properties": { + "bytesCopied": { + "type": "integer", + "format": "int64", + "description": "The number of document bytes copied during the Copying stage" + }, + "documentsCopied": { + "type": "integer", + "format": "int64", + "description": "The number of documents copied during the Copying stage" + }, + "elapsedTime": { + "type": "string", + "description": "The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)" + }, + "errors": { + "type": "object", + "description": "The errors and warnings that have occurred for the current object. The keys are the error codes.", + "additionalProperties": { + "$ref": "#/definitions/MongoDbError" + } + }, + "eventsPending": { + "type": "integer", + "format": "int64", + "description": "The number of oplog events awaiting replay" + }, + "eventsReplayed": { + "type": "integer", + "format": "int64", + "description": "The number of oplog events replayed so far" + }, + "lastEventTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last oplog event received, or null if no oplog event has been received yet" + }, + "lastReplayTime": { + "type": "string", + "format": "date-time", + "description": "The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet" + }, + "name": { + "type": "string", + "description": "The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null." + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null." + }, + "resultType": { + "type": "string", + "description": "The type of progress object", + "enum": [ + "Migration", + "Database", + "Collection" + ] + }, + "state": { + "type": "string", + "enum": [ + "NotStarted", + "ValidatingInput", + "Initializing", + "Restarting", + "Copying", + "InitialReplay", + "Replaying", + "Finalizing", + "Complete", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "MongoDbMigrationState", + "modelAsString": true + } + }, + "totalBytes": { + "type": "integer", + "format": "int64", + "description": "The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown" + }, + "totalDocuments": { + "type": "integer", + "format": "int64", + "description": "The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown" + } + }, + "required": [ + "bytesCopied", + "documentsCopied", + "elapsedTime", + "errors", + "eventsPending", + "eventsReplayed", + "resultType", + "state", + "totalBytes", + "totalDocuments" + ], + "discriminator": "ResultType" + }, + "MongoDbMigrationProgress": { + "x-ms-discriminator-value": "Migration", + "type": "object", + "description": "Describes the progress of the overall migration", + "properties": { + "databases": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MongoDbDatabaseProgress" + }, + "description": "The progress of the databases in the migration. The keys are the names of the databases" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MongoDbProgress" + } + ] + }, + "MongoDbObjectInfo": { + "type": "object", + "description": "Describes a database or collection within a MongoDB data source", + "properties": { + "averageDocumentSize": { + "type": "integer", + "format": "int64", + "description": "The average document size, or -1 if the average size is unknown" + }, + "dataSize": { + "type": "integer", + "format": "int64", + "description": "The estimated total data size, in bytes, or -1 if the size is unknown." + }, + "documentCount": { + "type": "integer", + "format": "int64", + "description": "The estimated total number of documents, or -1 if the document count is unknown" + }, + "name": { + "type": "string", + "description": "The unqualified name of the database or collection" + }, + "qualifiedName": { + "type": "string", + "description": "The qualified name of the database or collection. For a collection, this is the database-qualified name." + } + }, + "required": [ + "averageDocumentSize", + "dataSize", + "documentCount", + "name", + "qualifiedName" + ] + }, + "MongoDbRestartCommand": { + "x-ms-discriminator-value": "restart", + "type": "object", + "description": "Properties for the command that restarts a migration in whole or in part", + "properties": { + "input": { + "$ref": "#/definitions/MongoDbCommandInput", + "description": "Command input" + } + }, + "allOf": [ + { + "$ref": "Commands.json#/definitions/CommandProperties" + } + ] + }, + "MongoDbShardKeyField": { + "type": "object", + "description": "Describes a field reference within a MongoDB shard key", + "properties": { + "name": { + "type": "string", + "description": "The name of the field" + }, + "order": { + "type": "string", + "description": "The field ordering", + "enum": [ + "Forward", + "Reverse", + "Hashed" + ], + "x-ms-enum": { + "name": "MongoDbShardKeyOrder", + "modelAsString": true + } + } + }, + "required": [ + "name", + "order" + ] + }, + "MongoDbShardKeyInfo": { + "type": "object", + "description": "Describes a MongoDB shard key", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/MongoDbShardKeyField" + }, + "description": "The fields within the shard key" + }, + "isUnique": { + "type": "boolean", + "description": "Whether the shard key is unique" + } + }, + "required": [ + "fields", + "isUnique" + ] + }, + "MongoDbShardKeySetting": { + "type": "object", + "description": "Describes a MongoDB shard key", + "properties": { + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/MongoDbShardKeyField" + }, + "description": "The fields within the shard key" + }, + "isUnique": { + "type": "boolean", + "description": "Whether the shard key is unique" + } + }, + "required": [ + "fields", + "isUnique" + ] + }, + "MongoDbThrottlingSettings": { + "type": "object", + "description": "Specifies resource limits for the migration", + "properties": { + "minFreeCpu": { + "type": "integer", + "format": "int32", + "description": "The percentage of CPU time that the migrator will try to avoid using, from 0 to 100" + }, + "minFreeMemoryMb": { + "type": "integer", + "format": "int32", + "description": "The number of megabytes of RAM that the migrator will try to avoid using" + }, + "maxParallelism": { + "type": "integer", + "format": "int32", + "description": "The maximum number of work items (e.g. collection copies) that will be processed in parallel" + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json index ba96f67550ab..65f74e959cc8 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json @@ -117,6 +117,7 @@ "SQL", "MySQL", "PostgreSql", + "MongoDb", "Unknown" ], "x-ms-enum": { @@ -132,6 +133,7 @@ "SQLMI", "AzureDbForMySql", "AzureDbForPostgreSql", + "MongoDb", "Unknown" ], "x-ms-enum": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json index c1240937907b..7a27c3a1a67a 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json @@ -101,6 +101,29 @@ } } }, + "ConnectToMongoDbTaskProperties": { + "x-ms-discriminator-value": "Connect.MongoDb", + "type": "object", + "description": "Properties for the task that validates the connection to and provides information about a MongoDB server", + "properties": { + "input": { + "$ref": "./Common.json#/definitions/MongoDbConnectionInfo" + }, + "output": { + "type": "array", + "description": "An array containing a single MongoDbClusterInfo object", + "items": { + "$ref": "./MongoDbTasks.json#/definitions/MongoDbClusterInfo" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, "ConnectToSourceSqlServerTaskProperties": { "x-ms-discriminator-value": "ConnectToSource.SqlServer", "type": "object", @@ -293,6 +316,28 @@ } ] }, + "MigrateMongoDbTaskProperties": { + "x-ms-discriminator-value": "Migrate.MongoDb", + "type": "object", + "description": "Properties for the task that migrates data between MongoDB data sources", + "properties": { + "input": { + "$ref": "./MongoDbTasks.json#/definitions/MongoDbMigrationSettings" + }, + "output": { + "type": "array", + "items": { + "$ref": "./MongoDbTasks.json#/definitions/MongoDbProgress" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, "MigrateSqlServerSqlMITaskProperties": { "x-ms-discriminator-value": "Migrate.SqlServer.AzureSqlDbMI", "type": "object", @@ -461,6 +506,29 @@ } ] }, + "ValidateMongoDbTaskProperties": { + "x-ms-discriminator-value": "Validate.MongoDb", + "type": "object", + "description": "Properties for the task that validates a migration between MongoDB data sources", + "properties": { + "input": { + "$ref": "./MongoDbTasks.json#/definitions/MongoDbMigrationSettings" + }, + "output": { + "type": "array", + "description": "An array containing a single MongoDbMigrationProgress object", + "items": { + "$ref": "./MongoDbTasks.json#/definitions/MongoDbMigrationProgress" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, "GetTdeCertificatesSqlTaskProperties": { "x-ms-discriminator-value": "GetTDECertificates.Sql", "type": "object", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_CreateOrUpdate.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_CreateOrUpdate.json new file mode 100644 index 000000000000..2ab0397d37fe --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_CreateOrUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview", + "parameters": { + "properties": { + "filePath": "DmsSdkFilePath/DmsSdkFile.sql" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "extension": "sql", + "filePath": "DmsSdkFilePath/DmsSdkFile.sql" + }, + "etag": "C2WE6C3yt2I0hunjpjzffY8LhTLqrJZHJ20gkuq2ZOA=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/x114d023d8", + "name": "x114d023d8", + "type": "Microsoft.DataMigration/services/projects/files" + } + }, + "201": { + "body": { + "properties": { + "extension": "sql", + "filePath": "DmsSdkFilePath/DmsSdkFile.sql" + }, + "etag": "C2WE6C3yt2I0hunjpjzffY8LhTLqrJZHJ20gkuq2ZOA=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/x114d023d8", + "name": "x114d023d8", + "type": "Microsoft.DataMigration/services/projects/files" + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Delete.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Delete.json new file mode 100644 index 000000000000..5963acb6412f --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Get.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Get.json new file mode 100644 index 000000000000..a6abd1a4a774 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "extension": "sql", + "filePath": "SchemaInput/DmsSdkFile.sql", + "lastModified": "2018-08-15T20:01:33+00:00", + "mediaType": "text/plain", + "size": 51835 + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/x114d023d8", + "name": "x114d023d8", + "type": "Microsoft.DataMigration/services/projects/files" + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_List.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_List.json new file mode 100644 index 000000000000..d64409ef7034 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "api-version": "2018-07-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "extension": "sql", + "filePath": "SchemaInput/DmsSdkFile.sql", + "lastModified": "2018-08-15T20:01:33+00:00", + "mediaType": "text/plain", + "size": 51835 + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/x114d023d8", + "name": "x114d023d8", + "type": "Microsoft.DataMigration/services/projects/files" + }, + { + "properties": { + "extension": "sql", + "filePath": "7daf055f-82b0-483e-9da0-4244b4eaa9b0/AdventureWorks2008.sql", + "lastModified": "2018-10-05T16:51:03+00:00", + "mediaType": "text/plain", + "size": 910278 + }, + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/pfpu7fxqcpziyg2h3qj2vb7d8jpbbg7p", + "name": "pfpu7fxqcpziyg2h3qj2vb7d8jpbbg7p", + "type": "Microsoft.DataMigration/services/projects/files" + } + ] + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Read.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Read.json new file mode 100644 index 000000000000..c495e97dfb6e --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Read.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://dmssdkservicestorage.blob.core.windows.net/dmssdkservicecontainer/_rpfiles/dmssdkproject/pfpu7fxqcpziyg2h3qj2vb7d8jpbbg7p?sv=2016-05-31&sr=b&sig=sassignature&se=2018-10-05T18%3A21%3A42Z&sp=r", + "headers": { + "x-ms-blob-type": "BlockBlob" + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_ReadWrite.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_ReadWrite.json new file mode 100644 index 000000000000..505998cb37f1 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_ReadWrite.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview" + }, + "responses": { + "200": { + "body": { + "uri": "https://dmssdkservicestorage.blob.core.windows.net/dmssdkservicecontainer/_rpfiles/dmssdkproject/pfpu7fxqcpziyg2h3qj2vb7d8jpbbg7p?sv=2016-05-31&sr=b&sig=sassignature&se=2018-10-05T18%3A21%3A42Z&sp=racwd", + "headers": { + "x-ms-blob-type": "BlockBlob" + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Update.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Update.json new file mode 100644 index 000000000000..f11671d8586a --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/examples/Files_Update.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "fc04246f-04c5-437e-ac5e-206a19e7193f", + "groupName": "DmsSdkRg", + "serviceName": "DmsSdkService", + "projectName": "DmsSdkProject", + "fileName": "x114d023d8", + "api-version": "2018-07-15-preview", + "parameters": { + "properties": { + "filePath": "DmsSdkFilePath/DmsSdkFile.sql" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "extension": "sql", + "filePath": "DmsSdkFilePath/DmsSdkFile.sql" + }, + "etag": "C2WE6C3yt2I0hunjpjzffY8LhTLqrJZHJ20gkuq2ZOA=", + "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/projects/DmsSdkProject/files/x114d023d8", + "name": "x114d023d8", + "type": "Microsoft.DataMigration/services/projects/files" + } + } + } +} \ No newline at end of file From a0adc0909601325bf3f3c21f5a4b884f896e9876 Mon Sep 17 00:00:00 2001 From: hari-bodicherla <43284966+hari-bodicherla@users.noreply.github.com> Date: Wed, 24 Oct 2018 14:56:16 -0700 Subject: [PATCH 052/464] Added Reimage API support for ephemeral os disks in single VM (#4299) * Added diffDiskSettings property as part of Swagger changes needed for Ephemeral VM\VMSS * updated comment * updated swagger specs for diffdisksettings property * updated swagger spec comments for diff disk settings [property * added example to create Diff OS disk scaleset * updated 2018-10-01 version specs with diffdisk property * added example file for creating VM with diffdisksettings property * updated swagger changes for reimage operation in single vm * update examples * udpated examples * fixed validation errors --- .../stable/2018-06-01/compute.json | 103 +++++++++++++++++- .../LogAnalyticsRequestRateByInterval.json | 6 +- .../LogAnalyticsThrottledRequests.json | 6 +- .../examples/ReimageVirtualMachine.json | 17 +++ .../VMScaleSetExtensionRollingUpgrade.json | 6 - .../stable/2018-10-01/compute.json | 103 +++++++++++++++++- .../LogAnalyticsRequestRateByInterval.json | 6 +- .../LogAnalyticsThrottledRequests.json | 6 +- .../examples/ReimageVirtualMachine.json | 17 +++ .../VMScaleSetExtensionRollingUpgrade.json | 6 - 10 files changed, 238 insertions(+), 38 deletions(-) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ReimageVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ReimageVirtualMachine.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index c2ff7a68849b..8f2567920268 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -2137,6 +2137,60 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { "post": { "tags": [ @@ -3202,13 +3256,13 @@ "description": "The name of the VM scale set." }, { - "name": "vmInstanceIDs", + "name": "vmScaleSetReimageInput", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" }, - "description": "A list of virtual machine instance IDs from the VM scale set." + "description": "Parameters for Reimaging VM ScaleSet." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3516,6 +3570,15 @@ "type": "string", "description": "The instance ID of the virtual machine." }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -4851,6 +4914,15 @@ ], "description": "The List Usages operation response." }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specified whether to reimage temp disk. Default value: false." + } + }, + "description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true." + }, "VirtualMachineCaptureParameters": { "properties": { "vhdPrefix": { @@ -7300,6 +7372,31 @@ ], "description": "Describes a Virtual Machine Scale Set." }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, "VirtualMachineScaleSetUpdate": { "properties": { "sku": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json index 75a6ffa2affc..220d13819906 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsRequestRateByInterval.json @@ -14,13 +14,9 @@ "responses": { "200": { "body": { - "startTime": "2018-01-30T17:54:14.8806951-08:00", - "endTime": "2018-01-30T17:54:17.5832413-08:00", - "status": "Succeeded", "properties": { "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" - }, - "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } } }, "202": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json index 5607d80641cb..1d94418a5062 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/LogAnalyticsThrottledRequests.json @@ -14,13 +14,9 @@ "responses": { "200": { "body": { - "startTime": "2018-01-30T17:54:14.8806951-08:00", - "endTime": "2018-01-30T17:54:17.5832413-08:00", - "status": "Succeeded", "properties": { "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" - }, - "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } } }, "202": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ReimageVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ReimageVirtualMachine.json new file mode 100644 index 000000000000..0cfb15923b24 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ReimageVirtualMachine.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-06-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": { + }, + "202": { + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VMScaleSetExtensionRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VMScaleSetExtensionRollingUpgrade.json index 4d865f9883b4..3acda5563f69 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VMScaleSetExtensionRollingUpgrade.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VMScaleSetExtensionRollingUpgrade.json @@ -7,12 +7,6 @@ }, "responses": { "200": { - "body": { - "startTime": "2017-12-16T16:01:37.8958419-07:00", - "endTime": "2017-12-16T18:10:11.2897717-07:00", - "status": "Succeeded", - "name": "289dbc84-3c84-4a86-9e40-bbd4d61edcaf" - } }, "202": { } diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 6cd417649100..b0115f09d8f5 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -2137,6 +2137,60 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { "post": { "tags": [ @@ -3202,13 +3256,13 @@ "description": "The name of the VM scale set." }, { - "name": "vmInstanceIDs", + "name": "vmScaleSetReimageInput", "in": "body", "required": false, "schema": { - "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" }, - "description": "A list of virtual machine instance IDs from the VM scale set." + "description": "Parameters for Reimaging VM ScaleSet." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3516,6 +3570,15 @@ "type": "string", "description": "The instance ID of the virtual machine." }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -4866,6 +4929,15 @@ ], "description": "The List Usages operation response." }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specified whether to reimage temp disk. Default value: false." + } + }, + "description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true." + }, "VirtualMachineCaptureParameters": { "properties": { "vhdPrefix": { @@ -7315,6 +7387,31 @@ ], "description": "Describes a Virtual Machine Scale Set." }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, "VirtualMachineScaleSetUpdate": { "properties": { "sku": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsRequestRateByInterval.json index 586cc00b6395..6a8ec46f8b21 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsRequestRateByInterval.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsRequestRateByInterval.json @@ -14,13 +14,9 @@ "responses": { "200": { "body": { - "startTime": "2018-01-30T17:54:14.8806951-08:00", - "endTime": "2018-01-30T17:54:17.5832413-08:00", - "status": "Succeeded", "properties": { "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" - }, - "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } } }, "202": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsThrottledRequests.json index c71492cdb319..ca5f9bec8d1e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsThrottledRequests.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/LogAnalyticsThrottledRequests.json @@ -14,13 +14,9 @@ "responses": { "200": { "body": { - "startTime": "2018-01-30T17:54:14.8806951-08:00", - "endTime": "2018-01-30T17:54:17.5832413-08:00", - "status": "Succeeded", "properties": { "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" - }, - "name": "8eb1169a-5cf9-46b1-aadf-41e4f60692df" + } } }, "202": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ReimageVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ReimageVirtualMachine.json new file mode 100644 index 000000000000..6f4247dd00b5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ReimageVirtualMachine.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": { + }, + "202": { + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VMScaleSetExtensionRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VMScaleSetExtensionRollingUpgrade.json index f01e62f35086..f73791f7c578 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VMScaleSetExtensionRollingUpgrade.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VMScaleSetExtensionRollingUpgrade.json @@ -7,12 +7,6 @@ }, "responses": { "200": { - "body": { - "startTime": "2017-12-16T16:01:37.8958419-07:00", - "endTime": "2017-12-16T18:10:11.2897717-07:00", - "status": "Succeeded", - "name": "289dbc84-3c84-4a86-9e40-bbd4d61edcaf" - } }, "202": { } From cdf0d9e205f2f1bd0138cf14ef645daab5971734 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Wed, 24 Oct 2018 15:36:45 -0700 Subject: [PATCH 053/464] ACS multiapi for Python (#4322) --- .../resource-manager/readme.md | 73 +++++++++++-------- .../resource-manager/readme.python.md | 69 ++++++++++++++++++ 2 files changed, 112 insertions(+), 30 deletions(-) create mode 100644 specification/containerservices/resource-manager/readme.python.md diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index b183ed137293..ea89f9b475bd 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -102,6 +102,47 @@ input-file: - Microsoft.ContainerService/stable/2017-07-01/containerService.json ``` +### Tag: package-2018-08-preview-only + +These settings apply only when `--tag=package-2018-08-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08-preview-only' +input-file: +- Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json +``` + +### Tag: package-2018-09-preview-only + +These settings apply only when `--tag=package-2018-09-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-preview-only' +input-file: +- Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json +``` + +### Tag: package-2018-03-only + +These settings apply only when `--tag=package-2018-03-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-03-only' +input-file: +- Microsoft.ContainerService/stable/2018-03-31/managedClusters.json +``` + +### Tag: package-2017-07-only-extended + +These settings apply only when `--tag=package-2017-07-only-extended` is specified on the command line. + +This tag is special, since it brings together two API version that belongs +to the same operation group, since Python does not know how to handle +multi-api operation group for now. + +``` yaml $(tag) == 'package-2017-07-only-extended' +input-file: +- Microsoft.ContainerService/stable/2017-07-01/containerService.json +- Microsoft.ContainerService/stable/2017-09-30/location.json +``` + ### Tag: package-2017-08-only These settings apply only when `--tag=package-2017-08-only` is specified on the command line. @@ -160,6 +201,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + after_scripts: + - python ./scripts/multiapi_init_gen.py azure-mgmt-containerservice - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js @@ -169,36 +212,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_service'] ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.containerservice - package-name: azure-mgmt-containerservice - package-version: 4.3.1 - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-containerservice -``` - ## Go See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/containerservices/resource-manager/readme.python.md b/specification/containerservices/resource-manager/readme.python.md new file mode 100644 index 000000000000..a4a2ac91c8c3 --- /dev/null +++ b/specification/containerservices/resource-manager/readme.python.md @@ -0,0 +1,69 @@ +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-containerservice + clear-output-folder: true + no-namespace-folders: true +``` + +### Python multi-api + +Generate all API versions currently shipped for this package + +```yaml $(python) && $(multiapi) +batch: + - tag: package-2018-09-preview-only + - tag: package-2018-08-preview-only + - tag: package-2018-03-only + - tag: package-2017-07-only-extended +``` + +### Tag: package-2018-09-preview-only and python + +These settings apply only when `--tag=package-2018-09-preview-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2018_09_30_preview + output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_09_30_preview +``` + +### Tag: package-2018-08-preview-only and python + +These settings apply only when `--tag=package-2018-08-preview-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-08-preview-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2018_08_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_08_01_preview +``` + +### Tag: package-2018-03-only and python + +These settings apply only when `--tag=package-2018-03-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2018_03_31 + output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice/v2018_03_31 +``` + +### Tag: package-2017-07-only-extended and python + +These settings apply only when `--tag=package-2017-07-only-extended --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-07-only-extended' && $(python) +python: + namespace: azure.mgmt.containerservice.v2017_07_01 + output-folder: $(python-sdks-folder)/azure-mgmt-containerservice/azure/mgmt/containerservice/v2017_07_01 +``` From eefa0eb081c8ab7c3abc45824c3cdbe0a6cb9606 Mon Sep 17 00:00:00 2001 From: parisa-naeimi <38113090+parisa-naeimi@users.noreply.github.com> Date: Thu, 25 Oct 2018 11:04:33 -0700 Subject: [PATCH 054/464] Introducing Marketplaces at Management Group Level (#4327) --- .../stable/2018-10-01/consumption.json | 135 ++++++++++++++++++ .../MarketplacesByManagementGroupList.json | 84 +++++++++++ ...yManagementGroup_ListForBillingPeriod.json | 85 +++++++++++ 3 files changed, 304 insertions(+) create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroupList.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json index 41211e47e0c8..42e436acd126 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json @@ -2701,6 +2701,141 @@ } } } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListByManagementGroup", + "description": "Lists the marketplace records for all subscriptions belonging to a management group scope by current billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesList": { + "$ref": "./examples/MarketplacesByManagementGroupList.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}/providers/Microsoft.Consumption/marketplaces": { + "get": { + "tags": [ + "Marketplaces" + ], + "x-ms-odata": "#/definitions/Marketplace", + "operationId": "Marketplaces_ListForBillingPeriodByManagementGroup", + "description": "Lists the marketplace records for all subscriptions belonging to a management group scope by specified billing period. Marketplaces are available via this API only for May 1, 2014 or later.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "MarketplacesListForBillingPeriod": { + "$ref": "./examples/MarketplacesByManagementGroup_ListForBillingPeriod.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter marketplaces by properties/usageEnd (Utc time), properties/usageStart (Utc time), properties/resourceGroup, properties/instanceName or properties/instanceId. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N marketplaces.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "$ref": "#/parameters/billingPeriodNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/MarketplacesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } } }, "definitions": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroupList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroupList.json new file mode 100644 index 000000000000..9e1558f60f58 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroupList.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "managementGroupId": "managementGroupForTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-10-13T00:00:00Z", + "usageEnd": "2018-10-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json new file mode 100644 index 000000000000..331d145a2f0e --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/examples/MarketplacesByManagementGroup_ListForBillingPeriod.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "managementGroupId": "managementGroupForTest", + "billingPeriodName": "201808" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId1", + "name": "marketplacesId1", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account1", + "additionalProperties": "additionalProperties", + "costCenter": "Center1", + "departmentName": "Department1", + "billingPeriodId": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Billing/billingPeriods/201808", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared1", + "instanceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared1", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "00000000-0000-0000-0000-000000000000", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "00000000-0000-0000-0000-000000000000", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "00000000-0000-0000-0000-000000000000", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + }, + { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201808/providers/Microsoft.Consumption/marketplaces/marketplaceId2", + "name": "marketplacesId2", + "type": "Microsoft.Consumption/marketPlaces", + "tags": { + "env": "newcrp", + "dev": "tools" + }, + "properties": { + "accountName": "Account2", + "additionalProperties": "additionalProperties", + "costCenter": "Center2", + "departmentName": "Department2", + "billingPeriodId": "/subscriptions/11111111-1111-1111-1111-111111111111/providers/Microsoft.Billing/billingPeriods/201810", + "usageStart": "2018-08-13T00:00:00Z", + "usageEnd": "2018-08-13T23:59:59Z", + "instanceName": "shared2", + "instanceId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/Default-Web-eastasia/providers/Microsoft.Web/sites/shared2", + "currency": "USD", + "consumedQuantity": 0.00328, + "pretaxCost": 0.67, + "isEstimated": false, + "meterId": "11111111-1111-1111-1111-111111111111", + "offerName": "offer1", + "resourceGroup": "TEST", + "orderNumber": "11111111-1111-1111-1111-111111111111", + "publisherName": "xyz", + "planName": "plan2", + "resourceRate": 0.24, + "subscriptionGuid": "11111111-1111-1111-1111-111111111111", + "subscriptionName": "azure subscription", + "unitOfMeasure": "10 Hours", + "isRecurringCharge": false + } + } + ] + } + } + } +} \ No newline at end of file From f47b6a29ccd5492b51b4cb4aca1a63cac948f69a Mon Sep 17 00:00:00 2001 From: michimune Date: Thu, 25 Oct 2018 13:34:09 -0700 Subject: [PATCH 055/464] Fix network trace API REST format (#4295) * Add networkTrace resource and APIs * Add examples of network trace APIs * Add x-ms-examples to network trace APIs * Fix file name typo of GetWebSiteNetworkTraces.json * Fix syntax error in examples/GetWebSiteNetworkTraces.json * Fix more validation errors * Fix StopWebSiteNetworkTrace.json * Fix network trace APIs * Fix network trace API REST format * Fix operationIds * Fix operation Ids --- .../stable/2018-02-01/WebApps.json | 504 ++++++++++++++++++ .../GetWebSiteNetworkTraceOperationV2.json | 29 + 2 files changed, 533 insertions(+) create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index a568c9ef584c..08e0da54a7e8 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -5403,6 +5403,126 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperationV2.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": { "post": { "tags": [ @@ -12779,6 +12899,140 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTraceOperationSlotV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get the current status of a network trace operation for a site": { + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "description": "Gets a named operation for a network trace capturing (or deployment slot, if specified).", + "operationId": "WebApps_GetNetworkTracesSlotV2", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "description": "GUID of the operation.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get NetworkTraces for a site": { + "$ref": "./examples/GetWebSiteNetworkTraces.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": { "post": { "tags": [ @@ -14933,6 +15187,90 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Start capturing network packets for the site.", + "operationId": "WebApps_StartNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": { "post": { "tags": [ @@ -14973,6 +15311,54 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopNetworkTraceSlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "The name of the slot for this web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": { "post": { "tags": [ @@ -16413,6 +16799,83 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Start capturing network packets for the site.", + "description": "Start capturing network packets for the site.", + "operationId": "WebApps_StartNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "name": "durationInSeconds", + "in": "query", + "description": "The duration to keep capturing in seconds.", + "type": "integer", + "format": "int32" + }, + { + "name": "maxFrameLength", + "in": "query", + "description": "The maximum frame length in bytes (Optional).", + "type": "integer", + "format": "int32" + }, + { + "name": "sasUrl", + "in": "query", + "description": "The Blob URL to store capture file.", + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } + } + }, + "202": { + "description": "Operation is in progress.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/Operation" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Start a new network trace operation for a site": { + "$ref": "./examples/StartWebSiteNetworkTraceOperation.json" + } + }, + "x-ms-long-running-operation": true + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": { "post": { "tags": [ @@ -16446,6 +16909,47 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace": { + "post": { + "tags": [ + "WebApps" + ], + "summary": "Stop ongoing capturing network packets for the site.", + "description": "Stop ongoing capturing network packets for the site.", + "operationId": "WebApps_StopNetworkTrace", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "The name of the web app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Stopped." + }, + "204": { + "description": "Stopped." + } + }, + "x-ms-examples": { + "Stop a currently running network trace operation for a site": { + "$ref": "./examples/StopWebSiteNetworkTrace.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": { "post": { "tags": [ diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json new file mode 100644 index 000000000000..0921bcd01c37 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "name": "SampleApp", + "slot": "Production", + "operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d", + "api-version": "2018-02-01" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" + }, + "body": { } + } + } +} \ No newline at end of file From 0133d2a96996fb1d85958f501f6c4357bfcb4ff3 Mon Sep 17 00:00:00 2001 From: Alex Lee Date: Fri, 26 Oct 2018 10:15:55 -0700 Subject: [PATCH 056/464] Add Vnet resource for Microsoft.DBforMariaDB (#4337) --- .../VirtualNetworkRulesCreateOrUpdate.json | 40 +++ .../examples/VirtualNetworkRulesDelete.json | 20 ++ .../preview/2018-06-01-preview/mariadb.json | 267 +++++++++++++++++- 3 files changed, 325 insertions(+), 2 deletions(-) create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesCreateOrUpdate.json create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesDelete.json diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesCreateOrUpdate.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesCreateOrUpdate.json new file mode 100644 index 000000000000..f53ee5aec0d0 --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesCreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMariaDB/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMariaDB/servers/vnet-test-svr/virtualNetworkRules/vnet-firewall-rule", + "name": "vnet-firewall-rule", + "type": "Microsoft.DBforMariaDB/servers/virtualNetworkRules", + "properties": { + "ignoreMissingVnetServiceEndpoint": false, + "virtualNetworkSubnetId": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.Network/virtualNetworks/testvnet/subnets/testsubnet" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesDelete.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesDelete.json new file mode 100644 index 000000000000..d42649fe262c --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/VirtualNetworkRulesDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", + "resourceGroupName": "TestGroup", + "serverName": "vnet-test-svr", + "virtualNetworkRuleName": "vnet-firewall-rule", + "api-version": "2018-06-01-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json index b208105a7399..8997bd3b1c8c 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json @@ -458,6 +458,193 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules/{virtualNetworkRuleName}": { + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Gets a virtual network rule.", + "operationId": "VirtualNetworkRules_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Creates or updates an existing virtual network rule.", + "operationId": "VirtualNetworkRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested virtual Network Rule Resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + ], + "responses": { + "200": { + "description": "Successfully updated a virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 400 NullVirtualNetworkSubnetId - The Virtual Network Subnet Id is null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VirtualNetworkRuleNotEnabled - Azure SQL Server Virtual Network Rule feature is not enabled\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created a virtual network rule.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create or update a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesCreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Deletes the virtual network rule with the given name.", + "operationId": "VirtualNetworkRules_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the virtual network rule." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 NullVirtualNetworkRequest - Virtual Network Request is Null\n\n * 400 NullVirtualNetworkRequestParameters - Virtual Network Request Parameters are Null\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation." + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified virtual network rule does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a virtual network rule": { + "$ref": "./examples/VirtualNetworkRulesDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/virtualNetworkRules": { + "get": { + "tags": [ + "VirtualNetworkRules" + ], + "description": "Gets a list of virtual network rules in a server.", + "operationId": "VirtualNetworkRules_ListByServer", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of virtual network rules.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List virtual network rules": { + "$ref": "./examples/VirtualNetworkRulesList.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ @@ -1449,7 +1636,75 @@ } }, "description": "A list of firewall rules." - }, + }, + "VirtualNetworkRuleProperties": { + "description": "Properties of a virtual network rule.", + "required": [ + "virtualNetworkSubnetId" + ], + "type": "object", + "properties": { + "virtualNetworkSubnetId": { + "description": "The ARM resource id of the virtual network subnet.", + "type": "string" + }, + "ignoreMissingVnetServiceEndpoint": { + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled.", + "type": "boolean" + }, + "state": { + "description": "Virtual Network Rule State", + "enum": [ + "Initializing", + "InProgress", + "Ready", + "Deleting", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "VirtualNetworkRuleState", + "modelAsString": true + } + } + } + }, + "VirtualNetworkRule": { + "description": "A virtual network rule.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkRuleProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkRuleListResult": { + "description": "A list of virtual network rules.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, "DatabaseProperties": { "properties": { "charset": { @@ -1895,7 +2150,15 @@ "type": "string", "description": "The name of the server firewall rule.", "x-ms-parameter-location": "method" - }, + }, + "virtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "description": "The name of the virtual network rule.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", From b01043f2e44bf2c0d5763d793a11e1889ab3383d Mon Sep 17 00:00:00 2001 From: zikalino Date: Thu, 25 Oct 2018 07:52:49 +0800 Subject: [PATCH 057/464] improving hdinsight samples --- .../examples/CreateLinuxHadoopSecureHadoop.json | 2 +- .../examples/CreateLinuxHadoopSshPassword.json | 2 +- .../examples/CreateLinuxHadoopSshPublicKey.json | 2 +- .../examples/CreateLinuxSparkSshPassword.json | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json index b7d04576b131..c0e119f1c5e2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSecureHadoop.json @@ -22,7 +22,7 @@ }, "storageProfile": { "storageaccounts": [{ - "name": "mystorage", + "name": "mystorage.blob.core.windows.net", "isDefault": true, "container": "containername", "key": "storage account key" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json index 3831b22c7672..9b9bfda0c307 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPassword.json @@ -22,7 +22,7 @@ }, "storageProfile": { "storageaccounts": [{ - "name": "mystorage", + "name": "mystorage.blob.core.windows.net", "isDefault": true, "container": "containername", "key": "storagekey" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json index 9a1078519ddc..ff1ec0bbf362 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxHadoopSshPublicKey.json @@ -22,7 +22,7 @@ }, "storageProfile": { "storageaccounts": [{ - "name": "mystorage", + "name": "mystorage.blob.core.windows.net", "isDefault": true, "container": "containername", "key": "storagekey" diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json index 8a9b5a07e513..620798ca32be 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/CreateLinuxSparkSshPassword.json @@ -25,7 +25,7 @@ }, "storageProfile": { "storageaccounts": [{ - "name": "mystorage", + "name": "mystorage.blob.core.windows.net", "isDefault": true, "container": "containername", "key": "storageapikey*" From d12ea0b2bfc8cff5d8316fa953ecbb49dcecfde7 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Fri, 26 Oct 2018 15:14:51 -0700 Subject: [PATCH 058/464] Fix regular expression to support Unicode (#4341) * Fix regular expression to support Unicode The regexp engine in Go uses a slightly different syntax to support Unicode characters. Use a custom transformation to fix it for Go. * make where clause more specific --- specification/resources/resource-manager/readme.go.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md index 6a493f5fb730..109a5fa7fa82 100644 --- a/specification/resources/resource-manager/readme.go.md +++ b/specification/resources/resource-manager/readme.go.md @@ -2,6 +2,16 @@ These settings apply only when `--go` is specified on the command line. +### Fix up regular expressions to support Unicode. + +``` yaml +directive: + from: swagger-document # do it globally + where: $.paths..parameters[?(@.name == "resourceGroupName" || @.name == "sourceResourceGroupName")].pattern + set: ^[-\p{L}\._\(\)]+$ + reason: Necessary to match Unicode characters in the Go regexp engine. +``` + ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION From 01eb8f2f1465ac3e620916d06ae80e240d0063da Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Fri, 26 Oct 2018 15:46:36 -0700 Subject: [PATCH 059/464] EventHub : Revert PR 4246 from 2017 and added Kafka enabled (#4321) * Revert "moved VNet, IpFilter rules and Kafka from 2018-preview to 2017 API version (#4246)" This reverts commit 8c6f982d5f51cf9a173b4e098ae3f8b39d8d327d. * some lint fix * added kafkaEnabled to Namespace --- .../stable/2017-04-01/EventHub.json | 476 ------------------ .../examples/EHOperations_List.json | 75 +-- .../EHNameSpaceIPFilterRuleListAll.json | 26 - ...EHNameSpaceIpFilterRuleCreateorUpdate.json | 30 -- .../EHNameSpaceIpFilterRuleDelete.json | 13 - .../EHNameSpaceIpFilterRuleGet.json | 23 - .../EHNameSpaceIpFilterRuleUpdate.json | 30 -- ...SpaceVirtualNetworkRuleCreateorUpdate.json | 26 - .../EHNameSpaceVirtualNetworkRuleDelete.json | 13 - .../EHNameSpaceVirtualNetworkRuleGet.json | 21 - .../EHNameSpaceVirtualNetworkRuleListAll.json | 24 - .../EHNameSpaceVirtualNetworkRuleupdate.json | 26 - 12 files changed, 25 insertions(+), 758 deletions(-) delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json delete mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json index a61419e0a5db..d70c4431e7ce 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json @@ -1856,376 +1856,6 @@ "nextLinkName": "nextLink" } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListIPFilterRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" - } - }, - "description": "Gets a list of IP Filter rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully returned.", - "schema": { - "$ref": "#/definitions/IpFilterRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleCreate": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "The Namespace IpFilterRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule created", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleDelete": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" - } - }, - "description": "Deletes an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace IpFilterRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleGet": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" - } - }, - "description": "Gets an IpFilterRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule returned successfully.", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListVirtualNetworkRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" - } - }, - "description": "Gets a list of VirtualNetwork rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully returned.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "The Namespace VirtualNetworkRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule created", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleDelete": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" - } - }, - "description": "Deletes an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace VirtualNetworkRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" - } - }, - "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule returned successfully.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } } }, "definitions": { @@ -2978,94 +2608,6 @@ } ], "description": "Messaging Plan for the namespace" - }, - "IpFilterRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Accept", - "Reject" - ], - "x-ms-enum": { - "name": "IPAction", - "modelAsString": true - } - }, - "filterName": { - "type": "string", - "description": "IP Filter name" - } - }, - "description": "Properties supplied to create or update IpFilterRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get IpFilterRules operation" - }, - "IpFilterRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "Result of the List IpFilter Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "VirtualNetworkRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "virtualNetworkSubnetId": { - "type": "string", - "description": "ARM ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied to create or update VirtualNetworkRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get VirtualNetworkRules operation" - }, - "VirtualNetworkRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Result of the List VirtualNetwork Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" - } - }, - "description": "The response from the List namespace operation." } }, "parameters": { @@ -3170,24 +2712,6 @@ "minimum": 1, "maximum": 1000, "x-ms-parameter-location": "method" - }, - "IPFilterRuleNameParameter": { - "name": "ipFilterRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The IP Filter Rule name." - }, - "VirtualNetworkRuleNameParameter": { - "name": "virtualNetworkRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The Virtual Network Rule name." } } } \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EHOperations_List.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EHOperations_List.json index 5d4075e41f89..8d29635d7fa7 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EHOperations_List.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EHOperations_List.json @@ -11,8 +11,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Non Resource Operation", - "operation": "Get namespace availability.", - "description": "Checks availability of namespace under given subscription." + "operation": "Get namespace availability." } }, { @@ -20,8 +19,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub Resource Provider", - "operation": "Registers the EventHub Resource Provider", - "description": "Registers the subscription for the EventHub resource provider and enables the creation of EventHub resources" + "operation": "Registers the EventHub Resource Provider" } }, { @@ -29,8 +27,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace", - "operation": "Create Or Update Namespace ", - "description": "Create a Namespace Resource and Update its properties. Tags and status of the Namespace are the properties which can be updated." + "operation": "Create Or Update Namespace " } }, { @@ -38,8 +35,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace", - "operation": "Get Namespace Resource", - "description": "Get the list of Namespace Resource Description" + "operation": "Get Namespace Resource" } }, { @@ -47,8 +43,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace", - "operation": "Delete Namespace", - "description": "Delete Namespace Resource" + "operation": "Delete Namespace" } }, { @@ -56,8 +51,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "AuthorizationRules", - "operation": "Get Namespace Authorization Rules", - "description": "Get the list of Namespaces Authorization Rules description." + "operation": "Get Namespace Authorization Rules" } }, { @@ -65,8 +59,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "AuthorizationRules", - "operation": "Create or Update Namespace Authorization Rules", - "description": "Create a Namespace level Authorization Rules and update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + "operation": "Create or Update Namespace Authorization Rules" } }, { @@ -74,8 +67,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "AuthorizationRules", - "operation": "Delete Namespace Authorization Rule", - "description": "Delete Namespace Authorization Rule. The Default Namespace Authorization Rule cannot be deleted. " + "operation": "Delete Namespace Authorization Rule" } }, { @@ -83,8 +75,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "AuthorizationRules", - "operation": "Get Namespace Listkeys", - "description": "Get the Connection String to the Namespace" + "operation": "Get Namespace Listkeys" } }, { @@ -92,8 +83,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "AuthorizationRules", - "operation": "Resource Regeneratekeys", - "description": "Regenerate the Primary or Secondary key to the Resource" + "operation": "Resource Regeneratekeys" } }, { @@ -101,8 +91,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub", - "operation": "Create or Update EventHub", - "description": "Create or Update EventHub properties." + "operation": "Create or Update EventHub" } }, { @@ -110,8 +99,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub", - "operation": "Get EventHub", - "description": "Get list of EventHub Resource Descriptions" + "operation": "Get EventHub" } }, { @@ -119,8 +107,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub", - "operation": "Delete EventHub", - "description": "Operation to delete EventHub Resource" + "operation": "Delete EventHub" } }, { @@ -128,8 +115,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub AuthorizationRules", - "operation": " Get EventHub Authorization Rules", - "description": " Get the list of EventHub Authorization Rules" + "operation": " Get EventHub Authorization Rules" } }, { @@ -137,8 +123,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub AuthorizationRules", - "operation": "Create or Update EventHub Authorization Rule", - "description": "Create EventHub Authorization Rules and Update its properties. The Authorization Rules Access Rights, the Primary and Secondary Keys can be updated." + "operation": "Create or Update EventHub Authorization Rule" } }, { @@ -146,8 +131,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub AuthorizationRules", - "operation": "Delete EventHub Authorization Rules", - "description": "Operation to delete EventHub Authorization Rules" + "operation": "Delete EventHub Authorization Rules" } }, { @@ -155,8 +139,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub AuthorizationRules", - "operation": "List EventHub keys", - "description": "Get the Connection String to EventHub" + "operation": "List EventHub keys" } }, { @@ -164,8 +147,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "EventHub AuthorizationRules", - "operation": "Resource Regeneratekeys", - "description": "Regenerate the Primary or Secondary key to the Resource" + "operation": "Resource Regeneratekeys" } }, { @@ -173,8 +155,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "ConsumerGroup", - "operation": "Create or Update ConsumerGroup", - "description": "Create or Update ConsumerGroup properties." + "operation": "Create or Update ConsumerGroup" } }, { @@ -182,8 +163,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "ConsumerGroup", - "operation": "Get ConsumerGroup", - "description": "Get list of ConsumerGroup Resource Descriptions" + "operation": "Get ConsumerGroup" } }, { @@ -191,8 +171,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "ConsumerGroup", - "operation": "Delete ConsumerGroup", - "description": "Operation to delete ConsumerGroup Resource" + "operation": "Delete ConsumerGroup" } }, { @@ -200,8 +179,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace metrics", - "operation": "Get Namespace metrics", - "description": "Get list of Namespace metrics Resource Descriptions" + "operation": "Get Namespace metrics" } }, { @@ -209,8 +187,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace diagnostic settings", - "operation": "Get Namespace diagnostic settings", - "description": "Get list of Namespace diagnostic settings Resource Descriptions" + "operation": "Get Namespace diagnostic settings" } }, { @@ -218,8 +195,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace diagnostic settings", - "operation": "Create or Update Namespace diagnostic settings", - "description": "Get list of Namespace diagnostic settings Resource Descriptions" + "operation": "Create or Update Namespace diagnostic settings" } }, { @@ -227,8 +203,7 @@ "display": { "provider": "Microsoft Azure EventHub", "resource": "Namespace logs", - "operation": "Get Namespace logs", - "description": "Get list of Namespace logs Resource Descriptions" + "operation": "Get Namespace logs" } } ] diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json deleted file mode 100644 index 58f7d161de90..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.EventHub/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json deleted file mode 100644 index 0021793cc4ad..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337", - "parameters": { - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.EventHub/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json deleted file mode 100644 index 4b921fa62918..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337" - }, - "responses": { - "200": { }, - "204": { } - } -} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json deleted file mode 100644 index 30970870562b..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.EventHub/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json deleted file mode 100644 index b7a5a6803a03..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5849", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337", - "parameters": { - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.EventHub/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.EventHub/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json deleted file mode 100644 index 75d21c9265a5..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", - "parameters": { - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json deleted file mode 100644 index bd3dd401c8d3..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" - }, - "responses": { - "200": { }, - "204": { } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json deleted file mode 100644 index 6c05fa0cf72f..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json deleted file mode 100644 index d5ba67e22ce3..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json deleted file mode 100644 index 2bf72dee2cf0..000000000000 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleupdate.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", - "parameters": { - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.EventHub/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.EventHub/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} \ No newline at end of file From 7ae7189a99839315b540a0e1e3d233baa78850c1 Mon Sep 17 00:00:00 2001 From: kentzhang Date: Fri, 26 Oct 2018 17:15:25 -0700 Subject: [PATCH 060/464] Microsoft.CostManagement - Add supression command into readme (#4334) * Update specification/cost-management/resource-manager/readme.md add supression command into readme * Update specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json remove x-ms-mutability from collection property * Update specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json fix Automation for azure-sdk-for-go by adding operations method def * Update specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json add missing parameters * Update specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json fix typo --- .../2018-08-01-preview/costmanagement.json | 83 ++++++++++++++++++- .../resource-manager/readme.md | 9 ++ 2 files changed, 89 insertions(+), 3 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json index e737d0fe77a4..2cada3c5bc95 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json @@ -1946,9 +1946,89 @@ } } } + }, + "/providers/Microsoft.CostManagement/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available cost management REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } } }, "definitions": { + "Operation": { + "description": "A Cost Management REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.CostManagement.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: UsageDetail, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result of listing CostManagement operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of CostManagement operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, "ErrorBase": { "description": "The details of the error.", "properties": { @@ -2784,9 +2864,6 @@ }, "collection": { "$ref": "#/definitions/ConnectorCollectionInfo", - "x-ms-mutability": [ - "read" - ], "description": "Collection information", "readOnly": true } diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index ade67a1f48e1..2574976be824 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -23,6 +23,7 @@ These are the global settings for the Cost Management API. ``` yaml openapi-type: arm tag: package-2018-05 +azure-validator: true ``` --- @@ -35,6 +36,14 @@ input-file: - Microsoft.CostManagement/stable/2018-05-31/costmanagement.json ``` +## Suppression +``` yaml +directive: + - suppress: R2059 + from: costmanagement.json + where: $.paths + reason: We are extending Microsoft.Billing RP in some scenarios +``` ### Tag: package-2018-08-preview From 2cebed8134083bdb7a326885b27dd0b58bd6400b Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Mon, 29 Oct 2018 22:46:17 +0800 Subject: [PATCH 061/464] Oct10 (#4335) * copy 2018-03-01-preview spec for a new api-version * add new api-version 2018-10-01 --- .../examples/CheckNameAvailability.json | 20 + .../2018-10-01/examples/CreateOrUpdate.json | 58 + .../stable/2018-10-01/examples/Delete.json | 16 + .../stable/2018-10-01/examples/Get.json | 36 + .../examples/ListByResourceGroup.json | 39 + .../examples/ListBySubscription.json | 38 + .../stable/2018-10-01/examples/ListKeys.json | 18 + .../2018-10-01/examples/ListOperations.json | 24 + .../examples/ListUsagesByLocation.json | 36 + .../2018-10-01/examples/RegenerateKey.json | 24 + .../stable/2018-10-01/examples/Update.json | 54 + .../stable/2018-10-01/signalr.json | 1043 +++++++++++++++++ .../signalr/resource-manager/readme.go.md | 10 + .../signalr/resource-manager/readme.md | 24 +- .../signalr/resource-manager/readme.ruby.md | 11 + 15 files changed, 1450 insertions(+), 1 deletion(-) create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CheckNameAvailability.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListByResourceGroup.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListBySubscription.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListKeys.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListOperations.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListUsagesByLocation.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/RegenerateKey.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..a4f793e00f87 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "my-signalr-service" + }, + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The leaf is already used by other people" + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CreateOrUpdate.json new file mode 100644 index 000000000000..9f1354f493c6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/CreateOrUpdate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "parameters": { + "location": "eastus", + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "hostNamePrefix": null + } + }, + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "201": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "myservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0-preview", + "hostNamePrefix": null + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Delete.json new file mode 100644 index 000000000000..e3f208dab178 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Delete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + }, + "204": {} + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Get.json new file mode 100644 index 000000000000..678fd35549ed --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Get.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "myservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0-preview", + "hostNamePrefix": null + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListByResourceGroup.json new file mode 100644 index 000000000000..f411d1723f6d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListByResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "myservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0-preview", + "hostNamePrefix": null + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListBySubscription.json new file mode 100644 index 000000000000..6b348041bc47 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListBySubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "myservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0-preview", + "hostNamePrefix": null + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListKeys.json new file mode 100644 index 000000000000..6638ccabd60d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0" + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListOperations.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListOperations.json new file mode 100644 index 000000000000..a50b9256b643 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListOperations.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the SignalR's settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListUsagesByLocation.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListUsagesByLocation.json new file mode 100644 index 000000000000..af7ea7717c2b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/ListUsagesByLocation.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/RegenerateKey.json new file mode 100644 index 000000000000..e38114455fb5 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/RegenerateKey.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "201": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Update.json new file mode 100644 index 000000000000..39b2b6aca95e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/examples/Update.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "parameters": { + "tags": { + "key1": "value1" + }, + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "hostNamePrefix": null + } + }, + "api-version": "2018-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "myservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0-preview", + "hostNamePrefix": null + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json new file mode 100644 index 000000000000..6c2c47b394f5 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json @@ -0,0 +1,1043 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-10-01", + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListOperations": { + "$ref": "./examples/ListOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the SignalR name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": false, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + } + }, + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListBySubscription": { + "$ref": "./examples/ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListByResourceGroup": { + "$ref": "./examples/ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the SignalR resource.", + "operationId": "SignalR_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes SignalR service access keys.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + } + }, + "x-ms-examples": { + "ListKeys": { + "$ref": "./examples/ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "201": { + "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RegenerateKey": { + "$ref": "./examples/RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/SignalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the SignalR service and its properties.", + "operationId": "SignalR_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the corresponding SingalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + } + }, + "x-ms-examples": { + "Get": { + "$ref": "./examples/Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "SignalR_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRCreateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "201": { + "description": "Created. The response describes the new service and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdate": { + "$ref": "./examples/CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a SignalR service.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete": { + "$ref": "./examples/Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting SignalR service.", + "operationId": "SignalR_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SingalR service which is not up-to-date.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update": { + "$ref": "./examples/Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List usage quotas for Azure SignalR service by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListUsagesByLocation": { + "$ref": "./examples/ListUsagesByLocation.json" + } + } + } + } + }, + "definitions": { + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "type": "string" + }, + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "type": "string" + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "SKU of the service." + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "The properties of the service.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resouce.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the service - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the resource.(e.g. basic vs. standard)", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. This is typically a letter + number code, such as A0 or P3. Required (if sku is specified)", + "type": "string" + }, + "tier": { + "description": "Optional tier of this particular SKU. `Basic` is deprecated, use `Standard` instead for Basic tier.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "size": { + "description": "Optional, string. When the name field is the combination of tier and some other value, this would be the standalone code.", + "type": "string" + }, + "family": { + "description": "Optional, string. If the service has different generations of hardware, for the same SKU, then that can be captured here.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not \r\npossible for the resource this may be omitted.", + "type": "integer" + } + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalRCreateOrUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessibly port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.", + "type": "string" + } + } + }, + "SignalRCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", + "type": "object", + "properties": { + "hostNamePrefix": { + "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.", + "type": "string" + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of SignalR service.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + }, + "primaryConnectionString": { + "description": "SignalR connection string constructed via the primaryKey", + "type": "string" + }, + "secondaryConnectionString": { + "description": "SignalR connection string constructed via the secondaryKey", + "type": "string" + } + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + } + } + }, + "SignalRCreateParameters": { + "description": "Parameters for SignalR service create/update operation.\r\n\r\nKeep the same schema as AzSignalR.Models.SignalRResource", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalRUpdateParameters" + } + ], + "properties": { + "location": { + "description": "Azure GEO region: e.g. West US | East US | North Central US | South Central US | West Europe | North Europe | East Asia | Southeast Asia | etc. \r\nThe geo region of a resource never changes after it is created.", + "type": "string" + } + } + }, + "SignalRUpdateParameters": { + "description": "Parameters for SignalR service update operation", + "type": "object", + "properties": { + "tags": { + "description": "A list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. basic vs. standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRCreateOrUpdateProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": false + } + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of SignalR resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of SignalR resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName", + "description": "Localizable String object containing the name and a localized value." + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The indentifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "enum": [ + "2018-03-01-preview", + "2018-10-01" + ] + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SignalRServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} \ No newline at end of file diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index 2f9832efce0c..7f2bd24e04ce 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -14,6 +14,7 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: package-2018-03-01-preview + - tag: package-2018-10-01 ``` ### Tag: package-2018-03-01-preview and go @@ -24,3 +25,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-10-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/package-2018-10-01/$(namespace) +``` diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index d4aea7ad72ce..772e6929879b 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2018-03-01-preview +tag: package-2018-10-01 ``` +### Tag: package-2018-10-01 + +These settings apply only when `--tag=package-2018-10-01` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10-01' +input-file: +- Microsoft.SignalRService/stable/2018-10-01/signalr.json +``` ### Tag: package-2018-03-01-preview @@ -112,6 +120,20 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-signalr ``` yaml $(java) && $(multiapi) batch: - tag: package-2018-03-01-preview + - tag: package-2018-10-01 +``` + +### Tag: package-2018-10-01 and java + +These settings apply only when `--tag=package-2018-10-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-10-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2018_10_01 + output-folder: $(azure-libraries-for-java-folder)/signalr/resource-manager/v2018_10_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2018-03-01-preview and java diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index 99aa01d7bc4a..39b11888ae39 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -13,6 +13,17 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - tag: package-2018-03-01-preview + - tag: package-2018-10-01 +``` + +### Tag: package-2018-10-01 and ruby + +These settings apply only when `--tag=package-2018-10-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-10-01' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2018_10_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib ``` ### Tag: package-2018-03-01-preview and ruby From 6e127e682da4a23887d655657abfc3379d719540 Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Mon, 29 Oct 2018 07:48:25 -0700 Subject: [PATCH 062/464] Service Bus: Revert PR 4245 from 2017 (#4323) * Revert "Service Bus: moved VNet and IpFilter rules from 2018-preview to 2017 API version (#4245)" This reverts commit 41ebc864cec89e476d5e908e30f465362a568878. # Conflicts: # specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json * lint fixes * lint fix --- .../SBNameSpaceIPFilterRuleListAll.json | 26 - ...SBNameSpaceIpFilterRuleCreateorUpdate.json | 30 -- .../SBNameSpaceIpFilterRuleDelete.json | 13 - .../SBNameSpaceIpFilterRuleGet.json | 23 - .../SBNameSpaceIpFilterRuleUpdate.json | 30 -- ...SpaceVirtualNetworkRuleCreateorUpdate.json | 26 - .../SBNameSpaceVirtualNetworkRuleDelete.json | 13 - .../SBNameSpaceVirtualNetworkRuleGet.json | 21 - .../SBNameSpaceVirtualNetworkRuleListAll.json | 24 - .../SBNameSpaceVirtualNetworkRuleupdate.json | 26 - .../stable/2017-04-01/servicebus.json | 476 ------------------ 11 files changed, 708 deletions(-) delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleUpdate.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json delete mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleupdate.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json deleted file mode 100644 index 6c9cb82fcd17..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.ServiceBus/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json deleted file mode 100644 index 475ce4f106f8..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337", - "parameters": { - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.ServiceBus/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json deleted file mode 100644 index 4b921fa62918..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337" - }, - "responses": { - "200": { }, - "204": { } - } -} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json deleted file mode 100644 index 81c3142c4b9b..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5232", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.ServiceBus/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleUpdate.json deleted file mode 100644 index 97abba9a18cd..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleUpdate.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-5849", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "ipFilterRuleName": "sdk-IPFilterRules-7337", - "parameters": { - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/e2f361f0-3b27-4503-a9cc-21cfba380093/resourceGroups/Default-NotificationHubs-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-5232/ipfilterrules/sdk-IPFilterRules-7337", - "name": "sdk-IPFilterRules-7337", - "type": "Microsoft.ServiceBus/Namespaces/IpFilterRules", - "properties": { - "ipMask": "13.78.143.246/32", - "action": "Accept", - "filterName": "sdk-IPFilterRules-7337" - } - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json deleted file mode 100644 index c3bc41b41b6c..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", - "parameters": { - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.ServiceBus/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json deleted file mode 100644 index bd3dd401c8d3..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" - }, - "responses": { - "200": { }, - "204": { } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json deleted file mode 100644 index 5e2fc7b0e06d..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.ServiceBus/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json deleted file mode 100644 index 63ea8c805c51..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.ServiceBus/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleupdate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleupdate.json deleted file mode 100644 index 35d9ac618433..000000000000 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleupdate.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "namespaceName": "sdk-Namespace-6019", - "resourceGroupName": "ResourceGroup", - "api-version": "2017-04-01", - "subscriptionId": "Subscription", - "virtualNetworkRuleName": "sdk-VirtualNetworkRules-9191", - "parameters": { - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/sbehvnettest/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-6019/virtualnetworkrules/sdk-VirtualNetworkRules-9191", - "name": "sdk-VirtualNetworkRules-9191", - "type": "Microsoft.ServiceBus/Namespaces/VirtualNetworkRules", - "properties": { - "virtualNetworkSubnetId": "/subscriptions/Subscription/resourceGroups/ResourceGroup/providers/Microsoft.Network/virtualNetworks/sbehvnettest/subnets/default" - } - } - } - } -} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json index 18d0e5ec573b..86fae14e5cf3 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/stable/2017-04-01/servicebus.json @@ -2993,376 +2993,6 @@ "nextLinkName": "nextLink" } } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListIpFilterRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIPFilterRuleListAll.json" - } - }, - "description": "Gets a list of IP Filter rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully returned.", - "schema": { - "$ref": "#/definitions/IpFilterRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleCreate": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "The Namespace IpFilterRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule created", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleDelete": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleDelete.json" - } - }, - "description": "Deletes an IpFilterRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace IpFilterRule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleGet": { - "$ref": "./examples/NameSpaces/IPFilterRule/SBNameSpaceIpFilterRuleGet.json" - } - }, - "description": "Gets an IpFilterRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule returned successfully.", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListVirtualNetworkRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleListAll.json" - } - }, - "description": "Gets a list of VirtualNetwork rules for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully returned.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRuleListResult" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "The Namespace VirtualNetworkRule." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule created", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleDelete": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleDelete.json" - } - }, - "description": "Deletes an VirtualNetworkRule for a Namespace.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace VirtualNetworkRule successfully deleted." - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBNameSpaceVirtualNetworkRuleGet.json" - } - }, - "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/NamespaceNameParameter" - }, - { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule returned successfully.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "ServiceBus error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } } }, "definitions": { @@ -4778,94 +4408,6 @@ } }, "description": "The result of the List migrationConfigurations operation." - }, - "IpFilterRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Accept", - "Reject" - ], - "x-ms-enum": { - "name": "IPAction", - "modelAsString": true - } - }, - "filterName": { - "type": "string", - "description": "IP Filter name" - } - }, - "description": "Properties supplied to create or update IpFilterRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get IpFilterRules operation" - }, - "IpFilterRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "Result of the List IpFilter Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "VirtualNetworkRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "virtualNetworkSubnetId": { - "type": "string", - "description": "Resource ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied to create or update VirtualNetworkRules" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get VirtualNetworkRules operation" - }, - "VirtualNetworkRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Result of the List VirtualNetwork Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" - } - }, - "description": "The response from the List namespace operation." } }, "parameters": { @@ -5005,24 +4547,6 @@ "minimum": 1, "maximum": 1000, "x-ms-parameter-location": "method" - }, - "IPFilterRuleNameParameter": { - "name": "ipFilterRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The IP Filter Rule name." - }, - "VirtualNetworkRuleNameParameter": { - "name": "virtualNetworkRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The Virtual Network Rule name." } } } From 884d9027a69334049b2d8a2beacbb8cbc8f7612c Mon Sep 17 00:00:00 2001 From: vchske Date: Mon, 29 Oct 2018 10:44:43 -0700 Subject: [PATCH 063/464] Update MongoDbTasks.json (#4333) --- .../preview/2018-07-15-preview/definitions/MongoDbTasks.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json index 6056ff1e75df..dd4ec856c195 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json @@ -256,7 +256,7 @@ } }, "MongoDbFinishCommand": { - "x-ms-discriminator-value": "restart", + "x-ms-discriminator-value": "finish", "type": "object", "description": "Properties for the command that finishes a migration in whole or in part", "properties": { From 85277d4bc386f623fa835e0e2525b902486acfc4 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Mon, 29 Oct 2018 11:45:49 -0700 Subject: [PATCH 064/464] Fix #4346 - RequiredResourceAccess missing on GET (#4348) * Fix #4346 - RequiredResourceAccess missing on GET * Fix Py conf --- specification/graphrbac/data-plane/readme.md | 15 +-------------- .../data-plane/stable/1.6/graphrbac.json | 7 +++++++ 2 files changed, 8 insertions(+), 14 deletions(-) diff --git a/specification/graphrbac/data-plane/readme.md b/specification/graphrbac/data-plane/readme.md index b92980494b79..fc06a3929da1 100644 --- a/specification/graphrbac/data-plane/readme.md +++ b/specification/graphrbac/data-plane/readme.md @@ -90,7 +90,7 @@ python: payload-flattening-threshold: 2 namespace: azure.graphrbac package-name: azure-graphrbac - package-version: 0.50.0 + package-version: 0.52.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' @@ -104,19 +104,6 @@ python: output-folder: $(python-sdks-folder)/azure-graphrbac ``` -## Python - -These settings apply only when `--python` is specified on the command line. - -``` yaml $(python) -python: - # override the default output folder - output-folder: $(output-folder)/python - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.graphrbac -``` - ## Go See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json index 96cb6761dcf6..eaedd961a2bf 100644 --- a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json +++ b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json @@ -2738,6 +2738,13 @@ "oauth2AllowImplicitFlow" : { "type": "boolean", "description": "Whether to allow implicit grant flow for OAuth2" + }, + "requiredResourceAccess" : { + "type": "array", + "items": { + "$ref": "#/definitions/RequiredResourceAccess" + }, + "description": "Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience." } }, "description": "Active Directory application information." From 54ce984bb441c6eb8a30218a5f9039e849b7a3a1 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Mon, 29 Oct 2018 12:56:14 -0700 Subject: [PATCH 065/464] Python conf for Authorization 2018-09-01-preview (#4347) * Python conf for Authorization 2018-09-01-preview * Missing batch conf --- .../authorization/resource-manager/readme.md | 18 +++++++++++++++ .../resource-manager/readme.python.md | 22 +++++++++++++++++++ 2 files changed, 40 insertions(+) diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index e2eaa8ba206d..3c5f59689b9f 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -94,6 +94,24 @@ input-file: - Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json ``` +### Tag: package-2018-07-01-preview-only + +These settings apply only when `--tag=package-2018-07-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json +``` + +### Tag: package-2018-09-01-preview-only + +These settings apply only when `--tag=package-2018-09-01-preview-only` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01-preview-only' +input-file: +- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json +``` + ### Tag: package-2017-10-01-preview These settings apply only when `--tag=package-2017-10-01-preview` is specified on the command line. diff --git a/specification/authorization/resource-manager/readme.python.md b/specification/authorization/resource-manager/readme.python.md index 58dbdb31c6ff..544d7a0e92d9 100644 --- a/specification/authorization/resource-manager/readme.python.md +++ b/specification/authorization/resource-manager/readme.python.md @@ -21,11 +21,33 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-09-01-preview-only + - tag: package-2018-07-01-preview-only - tag: package-2018-01-01-preview-only - tag: package-2015-07-authorization-only - tag: package-2015-06-01-preview ``` +### Tag: package-2018-09-01-preview-only and python + +These settings apply only when `--tag=package-2018-09-01-preview-only --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-01-preview-only' && $(python) +python: + namespace: azure.mgmt.authorization.v2018_09_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization/v2018_09_01_preview +``` + +### Tag: package-2018-07-01-preview-only and python + +These settings apply only when `--tag=package-2018-07-01-preview-only --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-07-01-preview-only' && $(python) +python: + namespace: azure.mgmt.authorization.v2018_07_01_preview + output-folder: $(python-sdks-folder)/azure-mgmt-authorization/azure/mgmt/authorization/v2018_07_01_preview +``` + ### Tag: package-2018-01-01-preview-only and python These settings apply only when `--tag=package-2018-01-01-preview-only --python` is specified on the command line. From 6d04429e70cad92753d2621087c1c767c432cbe7 Mon Sep 17 00:00:00 2001 From: huizlAzure <43765498+huizlAzure@users.noreply.github.com> Date: Mon, 29 Oct 2018 13:54:26 -0700 Subject: [PATCH 066/464] Support for SRP BlobServiceProperties API (#4316) * Support for SRP BlobServiceProperties API * Address CR comments; fix java section in readme.md --- .../stable/2018-07-01/blob.json | 198 ++++++++++++++++++ .../2018-07-01/examples/BlobServicesGet.json | 87 ++++++++ .../2018-07-01/examples/BlobServicesPut.json | 157 ++++++++++++++ .../storage/resource-manager/readme.md | 8 +- 4 files changed, 446 insertions(+), 4 deletions(-) create mode 100644 specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json create mode 100644 specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json index 4c2b093704d9..1881958020ee 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json @@ -16,6 +16,91 @@ "application/json" ], "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/{BlobServicesName}": { + "put": { + "tags": [ + "BlobService" + ], + "operationId": "BlobServices_SetServiceProperties", + "x-ms-examples": { + "PutBlobServices": { + "$ref": "./examples/BlobServicesPut.json" + } + }, + "description": "Sets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules. ", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BlobServicesName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + }, + "description": "The properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules." + } + ], + "responses": { + "200": { + "description": "OK -- Sets The properties of a storage account’s Blob service successfully.", + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + } + } + } + }, + "get": { + "tags": [ + "BlobService" + ], + "operationId": "BlobServices_GetServiceProperties", + "x-ms-examples": { + "GetBlobServices": { + "$ref": "./examples/BlobServicesGet.json" + } + }, + "description": "Gets the properties of a storage account’s Blob service, including properties for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "./storage.json#/parameters/ResourceGroupName" + }, + { + "$ref": "./storage.json#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BlobServicesName" + } + ], + "responses": { + "200": { + "description": "OK -- returned the properties of a storage account’s Blob service.", + "schema": { + "$ref": "#/definitions/BlobServiceProperties" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers": { "get": { "tags": [ @@ -917,6 +1002,108 @@ } }, "description": "The list of blob containers." + }, + "BlobServiceProperties": { + "properties": { + "properties": { + "properties": { + "cors": { + "$ref": "#/definitions/CorsRules", + "description": "Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service." + }, + "defaultServiceVersion": { + "type": "string", + "description": "DefaultServiceVersion indicates the default version to use for requests to the Blob service if an incoming request’s version is not specified. Possible values include version 2008-10-27 and all more recent versions." + }, + "deleteRetentionPolicy": { + "$ref": "#/definitions/DeleteRetentionPolicy", + "description": "The blob service properties for soft delete." + } + }, + "x-ms-client-flatten": true, + "x-ms-client-name": "BlobServiceProperties", + "description": "The properties of a storage account’s Blob service." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The properties of a storage account’s Blob service." + }, + "DeleteRetentionPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Indicates whether DeleteRetentionPolicy is enabled for the Blob service." + }, + "days": { + "type": "integer", + "minimum": 1, + "maximum": 365, + "description": "Indicates the number of days that the deleted blob should be retained. The minimum specified value can be 1 and the maximum value can be 365." + } + }, + "description": "The blob service properties for soft delete." + }, + "CorsRules": { + "properties": { + "corsRules": { + "type": "array", + "items": { + "description": "Specifies a CORS rule for the Blob service. ", + "$ref": "#/definitions/CorsRule" + }, + "description": "The List of CORS rules. You can include up to five CorsRule elements in the request. " + } + }, + "description": "Sets the CORS rules. You can include up to five CorsRule elements in the request. " + }, + "CorsRule": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or \"*\" to allow all domains" + }, + "allowedMethods": { + "type": "array", + "items": { + "type": "string", + "enum": ["DELETE","GET","HEAD","MERGE","POST","OPTIONS","PUT"] + }, + "description": "Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin." + }, + "maxAgeInSeconds": { + "type": "integer", + "description": "Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response." + }, + "exposedHeaders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of response headers to expose to CORS clients." + }, + "allowedHeaders": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request." + } + }, + "required": [ + "allowedOrigins", + "allowedMethods", + "maxAgeInSeconds", + "exposedHeaders", + "allowedHeaders" + ], + "description": "Specifies a CORS rule for the Blob service." } }, "parameters": { @@ -940,6 +1127,17 @@ "default" ], "x-ms-parameter-location": "method" + }, + "BlobServicesName": { + "name": "BlobServicesName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the blob Service within the specified storage account. Blob Service Name must be 'default'", + "enum":[ + "default" + ], + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json new file mode 100644 index 000000000000..8036d7db9720 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "BlobServicesName": "default", + "api-version": "2018-07-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ], + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ], + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json new file mode 100644 index 000000000000..23110fcb5827 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json @@ -0,0 +1,157 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4410", + "accountName": "sto8607", + "BlobServicesName": "default", + "api-version": "2018-07-01", + "monitor": "true", + "parameters": { + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ], + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ], + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/res4410/providers/Microsoft.Storage/storageAccounts/sto8607/blobServices/default", + "name": "default", + "type": "Microsoft.Storage/storageAccounts/blobServices", + "properties": { + "cors": { + "corsRules": [ + { + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ], + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ], + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ], + } + ] + }, + "defaultServiceVersion": "2017-07-29", + "deleteRetentionPolicy": { + "enabled": true, + "days": 300 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index 25f8c5f86f1e..8ef24654829e 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -218,19 +218,19 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-storage ``` yaml $(java) && $(multiapi) batch: - - tag: package-2018-07-only + - tag: package-2018-07 - tag: package-2018-03 - tag: package-2018-02 - tag: package-2017-10 - tag: package-2016-01 ``` -### Tag: package-2018-07-only and java +### Tag: package-2018-07 and java -These settings apply only when `--tag=package-2018-07-only --java` is specified on the command line. +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-2018-07-only' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.storage.v2018_07_01 output-folder: $(azure-libraries-for-java-folder)/storage/resource-manager/v2018_07_01 From 07ce827bd912c961ec945d8e42d03ec78411fab8 Mon Sep 17 00:00:00 2001 From: Vlad Barosan Date: Tue, 30 Oct 2018 08:12:40 -0700 Subject: [PATCH 067/464] Fix go generation for signalR (#4355) --- specification/signalr/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index 7f2bd24e04ce..f84c87f6866a 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -32,5 +32,5 @@ These settings apply only when `--tag=package-2018-10-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-10-01' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/package-2018-10-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-10-01/$(namespace) ``` From c8fa8bd6e72a7606b08cf8e41e62fa7553c58773 Mon Sep 17 00:00:00 2001 From: Matt Briggs Date: Tue, 30 Oct 2018 11:00:13 -0700 Subject: [PATCH 068/464] Subscription Get state property desc (#4354) --- .../preview/2015-11-01/Subscriptions.json | 49 ++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json index a22cc59d65fe..7051a6d54164 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json @@ -595,7 +595,54 @@ ], "x-ms-enum": { "name": "SubscriptionState", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "description": "Subscription is active. New resources can be created.", + "name": "Enabled", + "value": "Enabled" + }, + { + "description": "This state is not used in Azure Stack.", + "name": "PastDue", + "value": "PastDue" + }, + { + "description": "This state is not used in Azure Stack.", + "name": "Warned", + "value": "Warned" + }, + { + "description": "Subscription is not active and usage is not reported. Resources are shut down (VMs stopped and deallocated, IP addresses are freed, etc). During this period, the Azure Stack Operator can re-enable the subscription which allows creation of new resources but doesn’t automatically restore disabled resources.", + "name": "Disabled", + "value": "Disabled" + }, + { + "description": "This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. Resources and Data are being deleted before subscription state is set to Deleted. This state cannot be reversed. It means that deletion is in progress.", + "name": "Deleting", + "value": "Deleting" + }, + { + "description": "Final state of subscription. All resources and data are deleted. This state cannot be reversed.", + "name": "Deleted", + "value": "Deleted" + }, + { + "description": "The String.", + "name": "Deleted", + "value": "Deleted" + }, + { + "description": "This state is not used in Azure Stack.", + "name": "NotDefined", + "value": "NotDefined" + }, + { + "description": "This state is unique to Azure Stack and is only visible to the Azure Stack Operator, and if used, to the respective Delegated Provider. It means that deletion failed. You can’t reverse the deletion process, so in this state all you can do is restart deletion. This state is not reported to RPs.", + "name": "PartiallyDeleted", + "value": "PartiallyDeleted" + } + ] } }, "Metric": { From c9d5c8aa98efd275ab861e1c9bd7af8c4fe59f36 Mon Sep 17 00:00:00 2001 From: lubalibu <39737466+lubalibu@users.noreply.github.com> Date: Tue, 30 Oct 2018 20:01:42 +0200 Subject: [PATCH 069/464] Update BlobAuditing swaggers to support Azure Monitor audit target (#4340) * Update auditing adding support for azure montior auditing target * Update BlobAuditing swaggers add azure monitor audit target and fix the swagers --- .../2015-05-01-preview/blobAuditing.json | 17 ++- ...DatabaseAzureMonitorAuditingCreateMin.json | 52 +++++++++ .../DatabaseBlobAuditingCreateMax.json | 9 +- .../2017-03-01-preview/blobAuditing.json | 110 ++++++++---------- ...DatabaseAzureMonitorAuditingCreateMin.json | 52 +++++++++ .../DatabaseBlobAuditingCreateMax.json | 11 +- .../DatabaseBlobAuditingCreateMin.json | 8 +- .../examples/DatabaseBlobAuditingGet.json | 5 +- ...DatabaseAzureMonitorAuditingCreateMin.json | 48 ++++++++ ...ExtendedDatabaseBlobAuditingCreateMax.json | 11 +- ...ExtendedDatabaseBlobAuditingCreateMin.json | 6 +- .../ExtendedDatabaseBlobAuditingGet.json | 3 +- .../ExtendedServerBlobAuditingCreateMax.json | 6 +- .../ExtendedServerBlobAuditingCreateMin.json | 3 +- .../ExtendedServerBlobAuditingGet.json | 3 +- .../examples/ServerBlobAuditingCreateMax.json | 6 +- .../examples/ServerBlobAuditingCreateMin.json | 3 +- .../examples/ServerBlobAuditingGet.json | 3 +- 18 files changed, 264 insertions(+), 92 deletions(-) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseAzureMonitorAuditingCreateMin.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json index 32ddc19328b7..da0b92c5a6bb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json @@ -51,7 +51,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -103,7 +103,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Successfully created the database blob auditing policy.", @@ -118,6 +118,9 @@ }, "Create or update a database's blob auditing policy with all parameters": { "$ref": "./examples/DatabaseBlobAuditingCreateMax.json" + }, + "Create or update a database's azure monitor auditing policy with minimal parameters": { + "$ref": "./examples/DatabaseAzureMonitorAuditingCreateMin.json" } } } @@ -132,7 +135,7 @@ "type": "object", "properties": { "state": { - "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", "enum": [ "Enabled", "Disabled" @@ -148,7 +151,7 @@ "type": "string" }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -157,7 +160,7 @@ }, "retentionDays": { "format": "int32", - "description": "Specifies the number of days to keep in the audit logs.", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", "type": "integer" }, "auditActionsAndGroups": { @@ -175,6 +178,10 @@ "isStorageSecondaryKeyInUse": { "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json new file mode 100644 index 000000000000..2d4883bd79ed --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2015-05-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "IsAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "isAzureMonitorTargetEnabled": true, + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "isAzureMonitorTargetEnabled": true, + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseBlobAuditingCreateMax.json index ce18f820b5e0..194627f146a2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/DatabaseBlobAuditingCreateMax.json @@ -14,7 +14,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["DATABASE_LOGOUT_GROUP","DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups":["DATABASE_LOGOUT_GROUP","DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"], + "isAzureMonitorTargetEnabled": true } } }, @@ -32,7 +33,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"], + "isAzureMonitorTargetEnabled": true } } }, @@ -49,7 +51,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "isAzureMonitorTargetEnabled": true } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json index 916da093d4f3..11bea1ff64a2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json @@ -51,7 +51,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -103,7 +103,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 BlobAuditingPredicateExpressionSyntaxError - Invalid value of parameter 'predicateExpression'.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 BlobAuditingPredicateExpressionSyntaxError - Invalid value of parameter 'predicateExpression'.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Successfully created the extended database blob auditing policy.", @@ -118,6 +118,9 @@ }, "Create or update an extended database's blob auditing policy with all parameters": { "$ref": "./examples/ExtendedDatabaseBlobAuditingCreateMax.json" + }, + "Create or update an extended database's azure monitor auditing policy with minimal parameters": { + "$ref": "./examples/ExtendedDatabaseAzureMonitorAuditingCreateMin.json" } } } @@ -203,7 +206,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingPredicateExpressionEmpty - Invalid parameter 'predicateExpression', value can not be empty.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." }, "202": { "description": "Updating the extended auditing settings is in progress." @@ -211,11 +214,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Update a server's extended blob auditing policy with all parameters": { - "$ref": "./examples/ExtendedServerBlobAuditingCreateMax.json" - }, "Update a server's extended blob auditing policy with minimal parameters": { "$ref": "./examples/ExtendedServerBlobAuditingCreateMin.json" + }, + "Update a server's extended blob auditing policy with all parameters": { + "$ref": "./examples/ExtendedServerBlobAuditingCreateMax.json" } } } @@ -301,7 +304,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." + "description": "*** Error Responses: ***\n\n * 400 InvalidServerBlobAuditingPolicyCreateRequest - The create server blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 409 ServerBlobAuditingPolicyInProgress - Set server blob auditing is already in progress." }, "202": { "description": "Updating the auditing settings is in progress." @@ -309,11 +312,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Update a server's blob auditing policy with all parameters": { - "$ref": "./examples/ServerBlobAuditingCreateMax.json" - }, "Update a server's blob auditing policy with minimal parameters": { "$ref": "./examples/ServerBlobAuditingCreateMin.json" + }, + "Update a server's blob auditing policy with all parameters": { + "$ref": "./examples/ServerBlobAuditingCreateMax.json" } } } @@ -353,7 +356,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -405,7 +408,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 BlobAuditingIsNotSupportedOnResourceType - Blob Auditing is currently not supported for this resource type.\n\n * 400 InvalidDatabaseBlobAuditingPolicyCreateRequest - The create database blob auditing policy request does not exist or has no properties object.\n\n * 400 InvalidBlobAuditActionsAndGroups - Invalid audit actions or action groups.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 BlobAuditingInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 BlobAuditingInvalidStorageAccountCredentials - The provided storage account or access key is not valid.\n\n * 400 BlobAuditingIsNotSupportedOnGeoDr - Blob auditing can be configured on primary databases only.\n\n * 400 InvalidBlobAuditActionsAndGroupsForDW - Unsupported audit actions or action groups for DW.\n\n * 400 BlobAuditingInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.\n\n * 400 BlobAuditingStorageAccountIsDisabled - The provided storage account is disabled.\n\n * 400 InvalidBlobAuditActions - Invalid audit action\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Successfully created the database blob auditing policy.", @@ -420,6 +423,9 @@ }, "Create or update a database's blob auditing policy with all parameters": { "$ref": "./examples/DatabaseBlobAuditingCreateMax.json" + }, + "Create or update a database's azure monitor auditing policy with minimal parameters": { + "$ref": "./examples/DatabaseAzureMonitorAuditingCreateMin.json" } } } @@ -438,7 +444,7 @@ "type": "string" }, "state": { - "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", "enum": [ "Enabled", "Disabled" @@ -454,7 +460,7 @@ "type": "string" }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -463,7 +469,7 @@ }, "retentionDays": { "format": "int32", - "description": "Specifies the number of days to keep in the audit logs.", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", "type": "integer" }, "auditActionsAndGroups": { @@ -481,47 +487,19 @@ "isStorageSecondaryKeyInUse": { "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", "type": "boolean" - } - } - }, - "Resource": { - "description": "ARM resource.", - "type": "object", - "properties": { - "id": { - "description": "Resource ID.", - "type": "string", - "readOnly": true }, - "name": { - "description": "Resource name.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Resource type.", - "type": "string", - "readOnly": true - } - }, - "x-ms-azure-resource": true - }, - "ProxyResource": { - "description": "ARM proxy resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" } - ], - "properties": {} + } }, "ExtendedDatabaseBlobAuditingPolicy": { "description": "An extended database blob auditing policy.", "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -544,7 +522,7 @@ "type": "string" }, "state": { - "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", "enum": [ "Enabled", "Disabled" @@ -560,7 +538,7 @@ "type": "string" }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -569,7 +547,7 @@ }, "retentionDays": { "format": "int32", - "description": "Specifies the number of days to keep in the audit logs.", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", "type": "integer" }, "auditActionsAndGroups": { @@ -587,6 +565,10 @@ "isStorageSecondaryKeyInUse": { "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" } } }, @@ -595,7 +577,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -614,7 +596,7 @@ "type": "object", "properties": { "state": { - "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", "enum": [ "Enabled", "Disabled" @@ -630,7 +612,7 @@ "type": "string" }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -639,7 +621,7 @@ }, "retentionDays": { "format": "int32", - "description": "Specifies the number of days to keep in the audit logs.", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", "type": "integer" }, "auditActionsAndGroups": { @@ -657,6 +639,10 @@ "isStorageSecondaryKeyInUse": { "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" } } }, @@ -665,7 +651,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { @@ -684,7 +670,7 @@ "type": "object", "properties": { "state": { - "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint and storageAccountAccessKey are required.", + "description": "Specifies the state of the policy. If state is Enabled, storageEndpoint or isAzureMonitorTargetEnabled are required.", "enum": [ "Enabled", "Disabled" @@ -700,7 +686,7 @@ "type": "string" }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the auditing storage account. If state is Enabled, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the auditing storage account. If state is Enabled and storageEndpoint is specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -709,7 +695,7 @@ }, "retentionDays": { "format": "int32", - "description": "Specifies the number of days to keep in the audit logs.", + "description": "Specifies the number of days to keep in the audit logs in the storage account.", "type": "integer" }, "auditActionsAndGroups": { @@ -727,6 +713,10 @@ "isStorageSecondaryKeyInUse": { "description": "Specifies whether storageAccountAccessKey value is the storage's secondary key.", "type": "boolean" + }, + "isAzureMonitorTargetEnabled": { + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "type": "boolean" } } }, @@ -735,7 +725,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json new file mode 100644 index 000000000000..2d4883bd79ed --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseAzureMonitorAuditingCreateMin.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2015-05-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "IsAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "isAzureMonitorTargetEnabled": true, + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/auditingSettings", + "kind": "V12", + "properties": { + "state":"Enabled", + "isAzureMonitorTargetEnabled": true, + "storageAccountAccessKey": "", + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json index a571903ebf91..194627f146a2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMax.json @@ -5,7 +5,7 @@ "serverName": "blobauditingtest-6440", "databaseName": "testdb", "blobAuditingPolicyName": "default", - "api-version": "2017-03-01-preview", + "api-version": "2015-05-01-preview", "parameters": { "properties": { "state": "Enabled", @@ -14,7 +14,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["DATABASE_LOGOUT_GROUP","DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups":["DATABASE_LOGOUT_GROUP","DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"], + "isAzureMonitorTargetEnabled": true } } }, @@ -32,7 +33,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"], + "isAzureMonitorTargetEnabled": true } } }, @@ -49,7 +51,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": ["DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public"] + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "isAzureMonitorTargetEnabled": true } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json index 6821106df1d8..e609623afef2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingCreateMin.json @@ -5,7 +5,7 @@ "serverName": "blobauditingtest-6440", "databaseName": "testdb", "blobAuditingPolicyName": "default", - "api-version": "2017-03-01-preview", + "api-version": "2015-05-01-preview", "parameters": { "properties": { "state": "Enabled", @@ -28,7 +28,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": true } } }, @@ -45,7 +46,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": true } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json index 9637d314f0bc..7e5d6e712101 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseBlobAuditingGet.json @@ -5,7 +5,7 @@ "serverName": "blobauditingtest-2080", "databaseName": "testdb", "blobAuditingPolicyName": "default", - "api-version": "2017-03-01-preview" + "api-version": "2015-05-01-preview" }, "responses": { "200": { @@ -20,7 +20,8 @@ "retentionDays": 0, "auditActionsAndGroups": [], "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", - "isStorageSecondaryKeyInUse": false + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": true } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseAzureMonitorAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseAzureMonitorAuditingCreateMin.json new file mode 100644 index 000000000000..14d01b0281a1 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseAzureMonitorAuditingCreateMin.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "blobauditingtest-4799", + "serverName": "blobauditingtest-6440", + "databaseName": "testdb", + "blobAuditingPolicyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true, + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/blobauditingtest-4799/providers/Microsoft.Sql/servers/blobauditingtest-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/extendedAuditingSettings", + "properties": { + "state": "Enabled", + "isAzureMonitorTargetEnabled": true, + "retentionDays": 0, + "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", + "isStorageSecondaryKeyInUse": false, + "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json index c3d225765d3d..880fdabb023b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMax.json @@ -14,8 +14,9 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], - "predicateExpression": "statement = 'select 1'" + "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true } } }, @@ -32,7 +33,8 @@ "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], - "predicateExpression": "statement = 'select 1'" + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true } } }, @@ -48,7 +50,8 @@ "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, "auditActionsAndGroups": [ "DATABASE_LOGOUT_GROUP", "DATABASE_ROLE_MEMBER_CHANGE_GROUP", "UPDATE on database::TestDatabaseName by public" ], - "predicateExpression": "statement = 'select 1'" + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": true } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json index 822c2619666d..c45b3514c1d3 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingCreateMin.json @@ -26,7 +26,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": false } } }, @@ -41,7 +42,8 @@ "retentionDays": 0, "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups":["SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP","FAILED_DATABASE_AUTHENTICATION_GROUP","BATCH_COMPLETED_GROUP"] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": false } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json index 46a66ce2854c..1b5a16828782 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedDatabaseBlobAuditingGet.json @@ -20,7 +20,8 @@ "auditActionsAndGroups": [], "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "predicateExpression": "statement = 'select 1'" + "predicateExpression": "statement = 'select 1'", + "isAzureMonitorTargetEnabled": false } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json index cd0ce930e7fa..53bc860a3920 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMax.json @@ -14,7 +14,8 @@ "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], - "predicateExpression": "object_name = 'SensitiveData'" + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": true } } }, @@ -31,7 +32,8 @@ "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], - "predicateExpression": "object_name = 'SensitiveData'" + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": true } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json index 95847565cb3d..e95c459688bb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingCreateMin.json @@ -25,7 +25,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": false } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json index 1c13d70019b3..fe470ca3be68 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ExtendedServerBlobAuditingGet.json @@ -19,7 +19,8 @@ "auditActionsAndGroups": [], "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", "isStorageSecondaryKeyInUse": false, - "predicateExpression": "object_name = 'SensitiveData'" + "predicateExpression": "object_name = 'SensitiveData'", + "isAzureMonitorTargetEnabled": false } } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json index 144353d69a54..f40d22cc4dc8 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMax.json @@ -13,7 +13,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": true } } }, @@ -29,7 +30,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": true } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json index 217a8d05ce80..41ae652c5dbb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingCreateMin.json @@ -25,7 +25,8 @@ "retentionDays": 6, "storageAccountSubscriptionId": "00000000-1234-0000-5678-000000000000", "isStorageSecondaryKeyInUse": false, - "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ] + "auditActionsAndGroups": [ "SUCCESSFUL_DATABASE_AUTHENTICATION_GROUP", "FAILED_DATABASE_AUTHENTICATION_GROUP", "BATCH_COMPLETED_GROUP" ], + "isAzureMonitorTargetEnabled": false } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json index 4fc165d07c2a..f7b40e033649 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ServerBlobAuditingGet.json @@ -18,7 +18,8 @@ "retentionDays": 0, "auditActionsAndGroups": [], "storageAccountSubscriptionId": "00000000-0000-0000-0000-000000000000", - "isStorageSecondaryKeyInUse": false + "isStorageSecondaryKeyInUse": false, + "isAzureMonitorTargetEnabled": false } } } From 7fa78609d2e3dc179ea1985dae98f91bdbc21854 Mon Sep 17 00:00:00 2001 From: James Park Date: Tue, 30 Oct 2018 11:04:44 -0700 Subject: [PATCH 070/464] [Maps] Introduce Event Grid Publisher event schema (#4326) --- .../stable/2018-01-01/Maps.json | 127 ++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json diff --git a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json new file mode 100644 index 000000000000..e7f7ab02d8de --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/Maps.json @@ -0,0 +1,127 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-01-01", + "title": "Schema of Azure Maps events published to Azure Event Grid", + "description": "Describes the schema of the Azure Maps events published to Azure Event Grid. This corresponds to the Data property of an EventGridEvent." + }, + "paths": {}, + "definitions": { + "MapsGeofenceEnteredEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceEntered event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ], + "properties": {} + }, + "MapsGeofenceExitedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceExited event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ], + "properties": {} + }, + "MapsGeofenceResultEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.Maps.GeofenceResult event.", + "allOf": [ + { + "$ref": "#/definitions/MapsGeofenceEventProperties" + } + ], + "properties": {} + }, + "MapsGeofenceEventProperties": { + "type": "object", + "description": "Schema of the Data property of an EventGridEvent for a Geofence event (GeofenceEntered, GeofenceExited, GeofenceResult).", + "properties": { + "details": { + "description": "List details generated during processing.", + "type": "array", + "items": { + "$ref": "#/definitions/MapsGeofenceDetail" + } + }, + "geometries": { + "description": "Lists the fence geometries that either fully contain the coordinate position or have an overlap with the searchBuffer around the fence.", + "type": "array", + "items": { + "$ref" : "#/definitions/MapsGeofenceGeometry" + } + } + } + }, + "MapsGeofenceGeometry": { + "description": "The geofence geometry.", + "type": "object", + "properties": { + "udId": { + "description": "The unique ID returned from user upload service when uploading a geofence.", + "type": "string" + }, + "geometryId": { + "description": "The unique ID for the geofence geometry.", + "type": "string" + }, + "distance": { + "description": "Distance from the coordinate to the closest border line of the polygon, point or point on the polyline. If the coordinate is outside, then the distance is positive. Negative means the coordinate is inside. If the coordinate is inside the polygon, but more than the value of searchBuffer away from the closest polygon border line, point or polyline, then the value is -999. A value of -999 means that there is great confidence the coordinate is well within the geofence.", + "type": "number" + }, + "nearestLat": { + "description": "Latitude of the nearest point of the geometry/geometry border. Void if distance = -999.", + "type": "number" + }, + "nearestLon": { + "description": "Longitude of the nearest point of the geometry/geometry border. Void if distance = -999.", + "type": "number" + } + } + }, + "MapsGeofenceDetail": { + "description": "Lists detail generated during processing.", + "type": "object", + "properties": { + "code": { + "description": "The detail code which identifies each detail item being returned.", + "type": "string", + "enum": [ + "ExpiredGeofencingData", + "GeofencingEventPublished", + "InvalidTimeGeofencingData" + ], + "x-ms-enum": { + "name": "MapsGeofenceDetailCodeType" + } + }, + "message": { + "description": "Text description of the detail.", + "type": "string" + }, + "type": { + "description": "The type of the detail.", + "type": "string", + "enum": [ + "Information", + "Warning" + ], + "x-ms-enum": { + "name": "MapsGeofenceDetailType", + "values": [ + { + "value": "Information", + "description": "Useful information to inform clients." + }, + { + "value": "Warning", + "description": "The detail serves as a warning to client." + } + ] + } + } + } + } + } +} From bc2b1356222a0bda2b5d9fd7fbad7483bfe1ec08 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Tue, 30 Oct 2018 12:13:57 -0700 Subject: [PATCH 071/464] Network october release (#4040) * Updated NetworkConfigurationDiagnostic API + example (#3905) * Fix incorrect API versions in Network's examples (#3954) * Fixed incorrect API versions in 2018-08-01's examples Added missing example for serviceEndpointPolicy.json * Fixed incorrect API version in 2018-07-01 example * swagger change for application gateway waf global config and exclusion list (#3972) * swagger change for application gateway waf global config and exclusion list * address the comments * add customer error spec for Application Gateway (#3985) * add customer error spec for Application Gateway * fix property name issue * Add ICMP to the list of supported protocols (#3993) * change appgw custom error status code enum and fix a typo of customErrorConfigurations (#4050) * add customer error spec for Application Gateway * fix property name issue * change appgw custom error status code enum and fix a typo of customErrorConfiguration * Add ExpressRoutePort swagger (#4104) * Add ExpressRoutePort details to readme.md * ExpressRoutePort swagger * Refer SubscriptionIdParameter and ApiVersionParameter from network.json * Cherry pick NRP's changes from master to October branch (#4251) * Remove error code from swagger (#4103) * Modifying example templates : enabling Ipv6 support for Private Peering (#4232) * Modifying example templates : enabling Ipv6 support for Private Peering * Resolving oav validation error * Changes to add operation id for outbound rules (#4320) * Changes to add operation id for outbound rules * Changes to make outbound rule similar to load balancing rule * fix failures - add example json files * fix failures * Fixed line endings, specs, examples * Change one parameter (#4339) * Change parameter in most recent version * Fix example * New SKU for ER (#4342) --- ...WatcherNetworkConfigurationDiagnostic.json | 2 +- .../stable/2018-08-01/applicationGateway.json | 86 +- .../stable/2018-08-01/azureFirewall.json | 3 +- ...sRouteCircuitCreateOnExpressRoutePort.json | 79 ++ .../examples/ExpressRouteLinkGet.json | 26 + .../examples/ExpressRouteLinkList.json | 42 + .../examples/ExpressRoutePortCreate.json | 112 +++ .../examples/ExpressRoutePortDelete.json | 13 + .../examples/ExpressRoutePortGet.json | 57 ++ .../examples/ExpressRoutePortList.json | 59 ++ .../ExpressRoutePortListByResourceGroup.json | 60 ++ .../examples/ExpressRoutePortUpdateLink.json | 120 +++ .../examples/ExpressRoutePortUpdateTags.json | 63 ++ .../ExpressRoutePortsLocationGet.json | 28 + .../ExpressRoutePortsLocationList.json | 27 + .../examples/LoadBalancerOutboundRuleGet.json | 33 + .../LoadBalancerOutboundRuleList.json | 36 + ...WatcherNetworkConfigurationDiagnostic.json | 12 +- .../ServiceEndpointPolicyUpdateTags.json | 47 ++ ...tualNetworkCheckIPAddressAvailability.json | 2 +- ...VirtualNetworkGatewayConnectionCreate.json | 2 +- .../VirtualNetworkGatewayConnectionGet.json | 2 +- .../VirtualNetworkGatewayConnectionsList.json | 2 +- .../VirtualWanSupportedSecurityProviders.json | 4 +- .../2018-08-01/examples/VpnConnectionGet.json | 2 +- .../examples/VpnConnectionList.json | 2 +- .../2018-08-01/examples/VpnConnectionPut.json | 2 +- .../2018-08-01/expressRouteCircuit.json | 19 +- .../stable/2018-08-01/expressRoutePort.json | 747 ++++++++++++++++++ .../stable/2018-08-01/loadBalancer.json | 112 +++ .../stable/2018-08-01/networkWatcher.json | 31 +- .../2018-08-01/serviceEndpointPolicy.json | 1 + .../stable/2018-08-01/virtualNetwork.json | 2 +- .../network/resource-manager/readme.md | 7 + 34 files changed, 1815 insertions(+), 27 deletions(-) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ServiceEndpointPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json index 525c1ebba653..770795a2c853 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -1,6 +1,6 @@ { "parameters" : { - "api-version": "2018-06-01", + "api-version": "2018-07-01", "subscriptionId" : "subid", "resourceGroupName" : "rg1", "networkWatcherName" : "nw1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json index 9900270e7ce6..77c14e39c946 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/applicationGateway.json @@ -1217,7 +1217,14 @@ "provisioningState": { "type": "string", "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the HTTP listener." + } }, "description": "Properties of HTTP listener of an application gateway." }, @@ -1683,7 +1690,14 @@ "provisioningState": { "type": "string", "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." - } + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the application gateway resource." + } }, "description": "Properties of the application gateway." }, @@ -1827,6 +1841,31 @@ "minimum": 8, "exclusiveMinimum": false, "description": "Maxium request body size for WAF." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maxium request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "maximum": 500, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maxium file upload size in Mb for WAF." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" + }, + "description": "The exclusion list." } }, "required": [ @@ -1895,6 +1934,28 @@ ], "description": "Allows to disable rules within a rule group or an entire rule group." }, + "ApplicationGatewayFirewallExclusion": { + "properties": { + "matchVariable": { + "type": "string", + "description": "The variable to be excluded." + }, + "selectorMatchOperator": { + "type": "string", + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + }, + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check" + }, "ApplicationGatewayAvailableWafRuleSetsResult": { "properties": { "value": { @@ -2084,6 +2145,27 @@ } }, "description": "Properties of ApplicationGatewaySslPredefinedPolicy" + }, + "ApplicationGatewayCustomError": { + "properties": { + "statusCode": { + "type": "string", + "description": "Status code of the application gateway customer error.", + "enum": [ + "HttpStatus403", + "HttpStatus502" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCustomErrorStatusCode", + "modelAsString": true + } + }, + "customErrorPageUrl": { + "type": "string", + "description": "Error page URL of the application gateway customer error." + } + }, + "description": "Customer error of an application gateway." }, "PolicyNameEnum": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json index 11fe956ede3f..0fac88e45080 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/azureFirewall.json @@ -741,7 +741,8 @@ "enum":[ "TCP", "UDP", - "Any" + "Any", + "ICMP" ], "x-ms-enum":{ "name":"AzureFirewallNetworkRuleProtocol", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json new file mode 100644 index 000000000000..65b05f62e3fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "type": "Microsoft.Network/expressRouteCircuits", + "circuitName": "expressRouteCircuit1", + "parameters": { + "location": "westus", + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + }, + "properties": { + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + }, + "201": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkGet.json new file mode 100644 index 000000000000..69ce035c4c7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "linkName": "linkName" + }, + "responses": { + "200": { + "body": { + "name": "linkName", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/linkName", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkList.json new file mode 100644 index 000000000000..a952ae5eb58b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRouteLinkList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "name": "link2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortCreate.json new file mode 100644 index 000000000000..4e09caf5e4c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortCreate.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortDelete.json new file mode 100644 index 000000000000..6565066f9c1b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortGet.json new file mode 100644 index 000000000000..10c570da1ac0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortList.json new file mode 100644 index 000000000000..a8e5e3c0975a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortListByResourceGroup.json new file mode 100644 index 000000000000..a4683c88ee7e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortListByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateLink.json new file mode 100644 index 000000000000..ef0263ae47d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateLink.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "links": [ + { + "name":"link1", + "properties": { + "adminState": "Enabled" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateTags.json new file mode 100644 index 000000000000..b8181ba14a91 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortUpdateTags.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationGet.json new file mode 100644 index 000000000000..43d01f4bde6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01", + "locationName": "locationName" + }, + "responses": { + "200": { + "body": { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsofot.Network/expressRoutePortsLocations/locationName", + "type": "Microsofot.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + { + "offerName": "100 Gbps", + "valueInGbps": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationList.json new file mode 100644 index 000000000000..1045812cb6b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ExpressRoutePortsLocationList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsofot.Network/expressRoutePortsLocations/locationName", + "type": "Microsofot.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleGet.json new file mode 100644 index 000000000000..08c38c01b6b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "outboundRuleName": "rule1", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleList.json new file mode 100644 index 000000000000..bc4c7e7e9427 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/LoadBalancerOutboundRuleList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2018-08-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json index 525c1ebba653..432209fc5142 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -1,12 +1,12 @@ { "parameters" : { - "api-version": "2018-06-01", + "api-version": "2018-08-01", "subscriptionId" : "subid", "resourceGroupName" : "rg1", "networkWatcherName" : "nw1", "parameters" : { "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "queries": [ + "profiles": [ { "direction" : "Inbound", "protocol" : "TCP", @@ -22,7 +22,7 @@ "body" : { "results": [ { - "trafficQuery": { + "profile": { "direction": "Inbound", "protocol": "TCP", "source": "10.1.0.4", @@ -34,6 +34,7 @@ "evaluatedNetworkSecurityGroups": [ { "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -83,6 +84,7 @@ }, { "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -108,7 +110,7 @@ "body" : { "results": [ { - "trafficQuery": { + "profile": { "direction": "Inbound", "protocol": "TCP", "source": "10.1.0.4", @@ -120,6 +122,7 @@ "evaluatedNetworkSecurityGroups": [ { "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" @@ -169,6 +172,7 @@ }, { "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", "matchedRule": { "ruleName": "UserRule_fe_rule", "action": "Allow" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ServiceEndpointPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ServiceEndpointPolicyUpdateTags.json new file mode 100644 index 000000000000..3c4879798f14 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/ServiceEndpointPolicyUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "api-version": "2018-08-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testServiceEndpointPolicy", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkCheckIPAddressAvailability.json index 1259b47e9141..534b785b8133 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkCheckIPAddressAvailability.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -4,7 +4,7 @@ "subscriptionId" : "subid", "resourceGroupName" : "rg1", "virtualNetworkName" : "test-vnet", - "IPAddress": "10.0.1.4" + "ipAddress": "10.0.1.4" }, "responses" : { "200" : { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionCreate.json index d82ea1da3d3a..e9c8210ad9aa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-07-01", + "api-version": "2018-08-01", "subscriptionId": "subid", "resourceGroupName": "rg1", "virtualNetworkGatewayConnectionName" : "connS2S", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionGet.json index 980993e1e6b2..12ae10d408ed 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-07-01", + "api-version": "2018-08-01", "subscriptionId": "subid", "resourceGroupName": "rg1", "virtualNetworkGatewayConnectionName" : "connS2S" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionsList.json index 1287b592b70e..c53622dfbe52 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionsList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-07-01", + "api-version": "2018-08-01", "subscriptionId": "subid", "resourceGroupName": "rg1" }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualWanSupportedSecurityProviders.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualWanSupportedSecurityProviders.json index 46080e150260..6852c564d856 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualWanSupportedSecurityProviders.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VirtualWanSupportedSecurityProviders.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "subid", "resourceGroupName": "rg1", - "api-version": "2018-07-01", + "api-version": "2018-08-01", "virtualWANName": "wan1" }, "responses": { @@ -24,4 +24,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionGet.json index c32622480b47..f980b3f9bd11 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionGet.json @@ -3,7 +3,7 @@ "gatewayName": "gateway1", "connectionName": "vpnConnection1", "resourceGroupName": "rg1", - "api-version": "2018-07-01", + "api-version": "2018-08-01", "subscriptionId": "subid" }, "responses": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionList.json index f7274998449b..0ca7b995e1d1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionList.json @@ -1,7 +1,7 @@ { "parameters": { "gatewayName": "gateway1", - "api-version": "2018-07-01", + "api-version": "2018-08-01", "resourceGroupName": "rg1", "subscriptionId": "subid" }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionPut.json index d9e55465bd90..c07d0b6cc05a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionPut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/VpnConnectionPut.json @@ -3,7 +3,7 @@ "connectionName": "vpnConnection1", "gatewayName": "gateway1", "resourceGroupName": "rg1", - "api-version": "2018-07-01", + "api-version": "2018-08-01", "subscriptionId": "subid", "VpnConnectionParameters": { "properties": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json index 4f473683ee8a..94be802019aa 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json @@ -1595,10 +1595,11 @@ }, "tier": { "type": "string", - "description": "The tier of the SKU. Possible values are 'Standard' and 'Premium'.", + "description": "The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'.", "enum": [ "Standard", - "Premium" + "Premium", + "Basic" ], "x-ms-enum": { "name": "ExpressRouteCircuitSkuTier", @@ -1688,6 +1689,20 @@ "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", "description": "The ServiceProviderProperties." }, + "expressRoutePort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." + }, + "bandwidthInGbps": { + "type": "number", + "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." + }, + "stag": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation." + }, "provisioningState": { "type": "string", "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json new file mode 100644 index 000000000000..820d010fcc18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRoutePort.json @@ -0,0 +1,747 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-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": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_List", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retriving a specific peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all ExpressRoutePort peering locations.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortsLocationList": { "$ref": "./examples/ExpressRoutePortsLocationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_Get", + "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the requested ExpressRoutePort peering location." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort peering location.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortsLocationGet": { "$ref": "./examples/ExpressRoutePortsLocationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { + "delete": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Delete", + "description": "Deletes the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortDelete": { "$ref": "./examples/ExpressRoutePortDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Get", + "description": "Retrieves the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortGet": { "$ref": "./examples/ExpressRoutePortGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_CreateOrUpdate", + "description": "Creates or updates the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "Parameters supplied to the create ExpressRoutePort operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortCreate": { "$ref": "./examples/ExpressRoutePortCreate.json" }, + "ExpressRoutePortUpdateLink": { "$ref": "./examples/ExpressRoutePortUpdateLink.json" } + } + }, + "patch": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_UpdateTags", + "description": "Update ExpressRoutePort tags", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ExpressRoutePort resource tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortUpdateTags": { "$ref": "./examples/ExpressRoutePortUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_ListByResourceGroup", + "description": "List all the ExpressRoutePort resources in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortListByResourceGroup": { "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_List", + "description": "List all the ExpressRoutePort resources in the specified subscription", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortList": { "$ref": "./examples/ExpressRoutePortList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_Get", + "description": "Retrieves the specified ExpressRouteLink resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteLink resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRouteLink resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteLink" + } + } + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_List", + "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteLinkListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkList.json" } + } + } + } + }, + "definitions": { + "ExpressRoutePortsLocationBandwidths": { + "title": "ExpressRoutePorts Location Bandwidths", + "description" : "Real-time inventory of available ExpressRoute port bandwidths.", + "properties": { + "offerName": { + "type": "string", + "readOnly": true, + "description": "Bandwidth descriptive name" + }, + "valueInGbps": { + "type": "integer", + "readOnly": true, + "description": "Bandwidth value in Gbps" + } + } + }, + "ExpressRoutePortsLocationPropertiesFormat": { + "title": "ExpressRoutePorts Location Properties", + "description" : "Properties specific to ExpressRoutePorts peering location resources.", + "properties": { + "address": { + "type": "string", + "readOnly": true, + "description": "Address of peering location." + }, + "contact": { + "type": "string", + "readOnly": true, + "description": "Contact details of peering locations." + }, + "availableBandwidths": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" + }, + "description": "The inventory of available ExpressRoutePort bandwidths." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRoutePortLocation resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRoutePortsLocation": { + "title": "ExpressRoutePorts Peering Location", + "description": "Definition of the ExpressRoutePorts peering location resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", + "description": "ExpressRoutePort peering location properties" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortsLocationListResult": { + "title": "ExpressRoutePorts Location List Result", + "description": "Response for ListExpressRoutePortsLocations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + }, + "description": "The list of all ExpressRoutePort peering locations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRouteLinkPropertiesFormat": { + "title": "ExpressRouteLink Resource Properties", + "description": "Properties specific to ExpressRouteLink resources.", + "properties": { + "routerName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router associated with physical port." + }, + "interfaceName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router interface." + }, + "patchPanelId": { + "readOnly": true, + "type": "string", + "description": "Mapping between physical port to patch panel port." + }, + "rackId": { + "readOnly": true, + "type": "string", + "description": "Mapping of physical patch panel to rack." + }, + "connectorType": { + "readOnly": true, + "type": "string", + "description": "Physical fiber port type.", + "enum": [ + "LC", + "SC" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkConnectorType", + "modelAsString": true + } + }, + "adminState": { + "type": "string", + "description": "Administrative state of the physical port", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkAdminState", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteLink": { + "title" : "ExpressRouteLink", + "description": "ExpressRouteLink child resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", + "description": "ExpressRouteLink properties" + }, + "name": { + "type": "string", + "description": "Name of child port resource that is unique among child port resources of the parent." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRouteLinkListResult": { + "title": "ExpressRouteLink List Result", + "description": "Response for ListExpressRouteLinks API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + }, + "description": "The list of ExpressRouteLink sub-resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRoutePortPropertiesFormat": { + "title": "ExpressRoutePort Properties", + "description" : "Properties specific to ExpressRoutePort resources.", + "properties": { + "peeringLocation": { + "type": "string", + "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." + }, + "bandwidthInGbps": { + "type": "integer", + "description": "Bandwidth of procured ports in Gbps" + }, + "provisionedBandwidthInGbps": { + "readOnly": true, + "type": "number", + "description": "Aggregate Gbps of associated circuit bandwidths." + }, + "mtu": { + "readOnly": true, + "type": "string", + "description": "Maximum transmission unit of the physical port pair(s)" + }, + "encapsulation": { + "type": "string", + "description": "Encapsulation method on physical ports.", + "enum": [ + "Dot1Q", + "QinQ" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsEncapsulation", + "modelAsString": true + } + }, + "etherType": { + "readOnly": true, + "type": "string", + "description": "Ethertype of the physical port." + }, + "allocationDate": { + "readOnly": true, + "type": "string", + "description": "Date of the physical port allocation to be used in Letter of Authorization." + }, + "links": { + "title" : "ExpressRouteLink Sub-Resources", + "description" : "The set of physical links of the ExpressRoutePort resource", + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "circuits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the ExpressRoutePort resource." + } + } + }, + "ExpressRoutePort": { + "title": "ExpressRoute Port", + "description": "ExpressRoutePort resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", + "description": "ExpressRoutePort properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortListResult": { + "title": "ExpressRoute Port List Result", + "description": "Response for ListExpressRoutePorts API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "A list of ExpressRoutePort resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/loadBalancer.json index 4cba44de570c..8d30a27644cc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/loadBalancer.json @@ -12,6 +12,7 @@ "consumes": [ "application/json" ], + "produces": [ "application/json" ], @@ -800,6 +801,100 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_List", + "description": "Gets all the outbound rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer OutboundRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerOutboundRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleList": { "$ref": "./examples/LoadBalancerOutboundRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_Get", + "description": "Gets the specified load balancer outbound rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "outboundRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting OutboundRule resource.", + "schema": { + "$ref": "#/definitions/OutboundRule" + } + } + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleGet": { "$ref": "./examples/LoadBalancerOutboundRuleGet.json" } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces": { "get": { "tags": [ @@ -1658,6 +1753,23 @@ }, "description": "Response for ListLoadBalancingRule API service call." }, + "LoadBalancerOutboundRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRule" + }, + "description": "A list of outbound rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListOutboundRule API service call." + }, "LoadBalancerProbeListResult": { "properties": { "value": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json index 0803437aeef0..6103a395dcf9 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json @@ -3432,23 +3432,36 @@ "description": "Parameters to get network configuration diagnostic.", "required": [ "targetResourceId", - "queries" + "profiles" ], "properties": { "targetResourceId": { "type": "string", "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." }, - "queries": { + "verbosityLevel": { + "type": "string", + "enum": [ + "Normal", + "Minimum", + "Full" + ], + "x-ms-enum": { + "name": "VerbosityLevel", + "modelAsString": true + }, + "description": "Verbosity level. Accepted values are 'Normal', 'Minimum', 'Full'." + }, + "profiles": { "type": "array", - "description": "List of traffic queries.", + "description": "List of network configuration diagnostic profiles.", "items": { - "$ref": "#/definitions/TrafficQuery" + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" } } } }, - "TrafficQuery": { + "NetworkConfigurationDiagnosticProfile": { "description": "Parameters to compare with network configuration.", "required": [ "direction", @@ -3504,8 +3517,8 @@ "NetworkConfigurationDiagnosticResult": { "description": "Network configuration diagnostic result corresponded to provided traffic query.", "properties": { - "trafficQuery": { - "$ref": "#/definitions/TrafficQuery" + "profile": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" }, "networkSecurityGroupResult": { "$ref": "#/definitions/NetworkSecurityGroupResult" @@ -3544,6 +3557,10 @@ "type": "string", "description": "Network security group ID." }, + "appliedTo": { + "type": "string", + "description": "Resource ID of nic or subnet to which network security group is applied." + }, "matchedRule": { "$ref": "#/definitions/MatchedRule" }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json index ca43b15b56b1..21c161feee88 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/serviceEndpointPolicy.json @@ -229,6 +229,7 @@ } }, "x-ms-examples": { + "Update service endpoint policy tags": { "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" } }, "x-ms-long-running-operation": true } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json index 477ec20ee203..43bd4a45dc6b 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json @@ -742,7 +742,7 @@ { "name": "ipAddress", "in": "query", - "required": false, + "required": true, "type": "string", "description": "The private IP address to be verified." }, diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 42e699ca7436..eeecf3860b3a 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -49,6 +49,7 @@ input-file: - Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json - Microsoft.Network/stable/2018-08-01/expressRouteCrossConnection.json - Microsoft.Network/stable/2018-08-01/expressRouteGateway.json + - Microsoft.Network/stable/2018-08-01/expressRoutePort.json - Microsoft.Network/stable/2018-08-01/interfaceEndpoint.json - Microsoft.Network/stable/2018-08-01/loadBalancer.json - Microsoft.Network/stable/2018-08-01/network.json @@ -657,6 +658,9 @@ directive: - suppress: RequiredPropertiesMissingInResourceModel from: expressRouteGateway.json reason: name, id and type properties are inherited from the upper level + - suppress: RequiredPropertiesMissingInResourceModel + from: expressRoutePort.json + reason: name, id and type properties are inherited from the upper level - suppress: RequiredPropertiesMissingInResourceModel from: loadBalancer.json reason: name, id and type properties are inherited from the upper level @@ -721,6 +725,9 @@ directive: - suppress: GetInOperationName where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability"].get.operationId reason: Customized verb is used for API + - suppress: PutInOperationName + where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}"].put.operationId + reason: Child resource is auto-created when top-level resource is created. - suppress: PutInOperationName where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey"].put.operationId reason: Customized verb is used for API From 73d0c3c4a4bcd3cb6e58ab0cc5f61599e47806bb Mon Sep 17 00:00:00 2001 From: Dave Bargeron Date: Tue, 30 Oct 2018 13:52:43 -0700 Subject: [PATCH 072/464] add Swagger spec for Bing Local Search API. (#4349) * add Swagger spec for Bing Local Search API. * update title "Local Search API" -> "Local Search Client" per yangyuan's comment on PR #4349. Also removed whitelist filter from SearchResponse filter. * add readme.md * fixed issues in readme.md and in Swagger spec caught by linter. * suppress R3016 linter error wrt "_type" because it can't be changed by me. * filtered ErrorResponse to "Errors" field only. * add x-ms-examples --- .../data-plane/LocalSearch/readme.md | 45 + .../LocalSearch/stable/v1.0/LocalSearch.json | 943 ++++++++++++++++++ .../SuccessfulLocalSearchRequest.json | 339 +++++++ 3 files changed, 1327 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/readme.md create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/examples/SuccessfulLocalSearchRequest.json diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.md new file mode 100644 index 000000000000..ef1492082453 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.md @@ -0,0 +1,45 @@ +# Cognitive Services Local Search SDK + +> see https://aka.ms/autorest + +Configuration for generating Local Search SDK. + +The current release is `release_1_0`. + +``` yaml + +tag: release_1_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 1.0 +These settings apply only when `--tag=release_1_0` is specified on the command line. + +``` yaml $(tag) == 'release_1_0' +input-file: stable/v1.0/LocalSearch.json +``` + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + namespace: Microsoft.Azure.CognitiveServices.Search.LocalSearch + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingLocalSearch/BingLocalSearch/Generated/LocalSearch +``` + + +## Suppressions +Suppressing errors due to API design: +``` yaml +directive: + - suppress: R3016 + reason: _type is a polymorphic discriminator that can't be changed. +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json new file mode 100644 index 000000000000..4361421ff602 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json @@ -0,0 +1,943 @@ +{ + "swagger": "2.0", + "info": { + "title": "Local Search Client", + "description": "The Local Search client lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses. The query can specify the name of the local business or it can ask for a list (for example, restaurants near me).", + "version": "1.0" + }, + "parameters": { + "x-bingapis-sdk": { + "name": "X-BingApis-SDK", + "description": "Activate swagger compliance", + "x-ms-parameter-location": "method", + "required": true, + "type": "string", + "in": "header", + "x-ms-enum": { + "name": "XBingApisSDK", + "modelAsString": true + }, + "enum": [ + "true" + ] + } + }, + "host": "api.cognitive.microsoft.com", + "schemes": [ + "https" + ], + "basePath": "/localbusinesses/v7.0/search", + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "name": "Ocp-Apim-Subscription-Key", + "type": "apiKey", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/localbusinesses/v7.0/search": { + "get": { + "summary": "The Local Search API lets you send a search query to Bing and get back search results that include local businesses such as restaurants, hotels, retail stores, or other local businesses. The query can specify the name of the local business or it can ask for a list (for example, restaurants near me).", + "operationId": "Local_Search", + "tags": [ + "LocalSearch" + ], + "parameters": [ + { + "$ref": "#/parameters/x-bingapis-sdk" + }, + { + "name": "Accept", + "in": "header", + "description": "The default media type is application/json. To specify that the response use [JSON-LD](http://json-ld.org/), set the Accept header to application/ld+json.", + "required": false, + "type": "string" + }, + { + "name": "Accept-Language", + "x-ms-client-name": "AcceptLanguage", + "in": "header", + "description": "A comma-delimited list of one or more languages to use for user interface strings. The list is in decreasing order of preference. For additional information, including expected format, see [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This header and the setLang query parameter are mutually exclusive; do not specify both. If you set this header, you must also specify the cc query parameter. Bing will use the first supported language it finds from the list, and combine that language with the cc parameter value to determine the market to return results for. If the list does not include a supported language, Bing will find the closest language and market that supports the request, and may use an aggregated or default market for the results instead of a specified one. You should use this header and the cc query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. A user interface string is a string that's used as a label in a user interface. There are very few user interface strings in the JSON response objects. Any links in the response objects to Bing.com properties will apply the specified language.", + "required": false, + "type": "string" + }, + { + "name": "Pragma", + "in": "header", + "description": "By default, Bing returns cached content, if available. To prevent Bing from returning cached content, set the Pragma header to no-cache (for example, Pragma: no-cache).", + "required": false, + "type": "string" + }, + { + "name": "User-Agent", + "x-ms-client-name": "UserAgent", + "in": "header", + "description": "The user agent originating the request. Bing uses the user agent to provide mobile users with an optimized experience. Although optional, you are strongly encouraged to always specify this header. The user-agent should be the same string that any commonly used browser would send. For information about user agents, see [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientID", + "x-ms-client-name": "ClientId", + "in": "header", + "description": "Bing uses this header to provide users with consistent behavior across Bing API calls. Bing often flights new features and improvements, and it uses the client ID as a key for assigning traffic on different flights. If you do not use the same client ID for a user across multiple requests, then Bing may assign the user to multiple conflicting flights. Being assigned to multiple conflicting flights can lead to an inconsistent user experience. For example, if the second request has a different flight assignment than the first, the experience may be unexpected. Also, Bing can use the client ID to tailor web results to that client ID’s search history, providing a richer experience for the user. Bing also uses this header to help improve result rankings by analyzing the activity generated by a client ID. The relevance improvements help with better quality of results delivered by Bing APIs and in turn enables higher click-through rates for the API consumer. IMPORTANT: Although optional, you should consider this header required. Persisting the client ID across multiple requests for the same end user and device combination enables 1) the API consumer to receive a consistent user experience, and 2) higher click-through rates via better quality of results from the Bing APIs. Each user that uses your application on the device must have a unique, Bing generated client ID. If you do not include this header in the request, Bing generates an ID and returns it in the X-MSEdge-ClientID response header. The only time that you should NOT include this header in a request is the first time the user uses your app on that device. Use the client ID for each Bing API request that your app makes for this user on the device. Persist the client ID. To persist the ID in a browser app, use a persistent HTTP cookie to ensure the ID is used across all sessions. Do not use a session cookie. For other apps such as mobile apps, use the device's persistent storage to persist the ID. The next time the user uses your app on that device, get the client ID that you persisted. Bing responses may or may not include this header. If the response includes this header, capture the client ID and use it for all subsequent Bing requests for the user on that device. If you include the X-MSEdge-ClientID, you must not include cookies in the request.", + "required": false, + "type": "string" + }, + { + "name": "X-MSEdge-ClientIP", + "x-ms-client-name": "ClientIp", + "in": "header", + "description": "The IPv4 or IPv6 address of the client device. The IP address is used to discover the user's location. Bing uses the location information to determine safe search behavior. Although optional, you are encouraged to always specify this header and the X-Search-Location header. Do not obfuscate the address (for example, by changing the last octet to 0). Obfuscating the address results in the location not being anywhere near the device's actual location, which may result in Bing serving erroneous results.", + "required": false, + "type": "string" + }, + { + "name": "X-Search-Location", + "x-ms-client-name": "Location", + "in": "header", + "description": "A semicolon-delimited list of key/value pairs that describe the client's geographical location. Bing uses the location information to determine safe search behavior and to return relevant local content. Specify the key/value pair as :. The following are the keys that you use to specify the user's location. lat (required): The latitude of the client's location, in degrees. The latitude must be greater than or equal to -90.0 and less than or equal to +90.0. Negative values indicate southern latitudes and positive values indicate northern latitudes. long (required): The longitude of the client's location, in degrees. The longitude must be greater than or equal to -180.0 and less than or equal to +180.0. Negative values indicate western longitudes and positive values indicate eastern longitudes. re (required): The radius, in meters, which specifies the horizontal accuracy of the coordinates. Pass the value returned by the device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and 18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp of when the client was at the location. (The UNIX timestamp is the number of seconds since January 1, 1970.) head (optional): The client's relative heading or direction of travel. Specify the direction of travel as degrees from 0 through 360, counting clockwise relative to true north. Specify this key only if the sp key is nonzero. sp (optional): The horizontal velocity (speed), in meters per second, that the client device is traveling. alt (optional): The altitude of the client device, in meters. are (optional): The radius, in meters, that specifies the vertical accuracy of the coordinates. Specify this key only if you specify the alt key. Although many of the keys are optional, the more information that you provide, the more accurate the location results are. Although optional, you are encouraged to always specify the user's geographical location. Providing the location is especially important if the client's IP address does not accurately reflect the user's physical location (for example, if the client uses VPN). For optimal results, you should include this header and the X-MSEdge-ClientIP header, but at a minimum, you should include this header.", + "required": false, + "type": "string" + }, + { + "name": "cc", + "x-ms-client-name": "CountryCode", + "in": "query", + "description": "A 2-character country code of the country where the results come from. This API supports only the United States market. If you specify this query parameter, it must be set to us. If you set this parameter, you must also specify the Accept-Language header. Bing uses the first supported language it finds from the languages list, and combine that language with the country code that you specify to determine the market to return results for. If the languages list does not include a supported language, Bing finds the closest language and market that supports the request, or it may use an aggregated or default market for the results instead of a specified one. You should use this query parameter and the Accept-Language query parameter only if you specify multiple languages; otherwise, you should use the mkt and setLang query parameters. This parameter and the mkt query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string" + }, + { + "name": "mkt", + "x-ms-client-name": "Market", + "in": "query", + "description": "The market where the results come from. You are strongly encouraged to always specify the market, if known. Specifying the market helps Bing route the request and return an appropriate and optimal response. This parameter and the cc query parameter are mutually exclusive—do not specify both.", + "required": false, + "type": "string", + "default": "en-us" + }, + { + "name": "q", + "x-ms-client-name": "Query", + "in": "query", + "description": "The user's search term.", + "required": true, + "type": "string" + }, + { + "name": "localcategories", + "x-ms-client-name": "LocalCategories", + "in": "query", + "description": "comma-delimiated list of business categories to search for. Supported categories can be high-level such as EatDrink, Shop, SeeDo.", + "required": false, + "type": "string" + }, + { + "name": "localcircularview", + "x-ms-client-name": "localCircularView", + "in": "query", + "description": "Preferred location to search around, expressed as Latitude, longitude and radius in meters. For example 47.61503,-122.1719,5000. Note that circular view should only be used to indicate a search around a point on the map, not as an approximation for a view port of a map rectangle.", + "required": false, + "type": "string" + }, + { + "name": "localmapview", + "x-ms-client-name": "localMapView", + "in": "query", + "description": "Preferred bounding box for results, specified in NW_latitude, NW_Longitude, SE_Latitude, SE_Longitude format. For example 47.64,-122.13,47.63,-122.12. These values are lat, long pairs for the Northwest corner and the Southeast corner of a rectangle.", + "required": false, + "type": "string" + }, + { + "name": "count", + "x-ms-client-name": "Count", + "in": "query", + "description": "Preferred number of results to return. If not specified, then Bing returns 1-20 of the most relevant results.", + "required": false, + "type": "string" + }, + { + "name": "first", + "x-ms-client-name": "First", + "in": "query", + "description": "First result to return. zero-based. default is 0.", + "required": false, + "type": "string" + }, + { + "name": "ResponseFormat", + "in": "query", + "description": "The media type to use for the response. The following are the possible case-insensitive values: JSON, JSONLD. The default is JSON. If you specify JSONLD, the response body includes JSON-LD objects that contain the search results.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Json", + "JsonLd" + ], + "x-ms-enum": { + "name": "ResponseFormat", + "modelAsString": true + } + }, + "collectionFormat": "csv" + }, + { + "name": "SafeSearch", + "in": "query", + "description": "A filter used to filter adult content. Off: Return webpages with adult text, images, or videos. Moderate: Return webpages with adult text, but not adult images or videos. Strict: Do not return webpages with adult text, images, or videos. The default is Moderate. If the request comes from a market that Bing's adult policy requires that safeSearch is set to Strict, Bing ignores the safeSearch value and uses Strict. If you use the site: query operator, there is the chance that the response may contain adult content regardless of what the safeSearch query parameter is set to. Use site: only if you are aware of the content on the site and your scenario supports the possibility of adult content.", + "required": false, + "type": "string", + "enum": [ + "Off", + "Moderate", + "Strict" + ], + "x-ms-enum": { + "name": "SafeSearch", + "modelAsString": true + } + }, + { + "name": "SetLang", + "in": "query", + "description": "The language to use for user interface strings. Specify the language using the ISO 639-1 2-letter language code. For example, the language code for English is EN. The default is EN (English). Although optional, you should always specify the language. Typically, you set setLang to the same language specified by mkt unless the user wants the user interface strings displayed in a different language. This parameter and the Accept-Language header are mutually exclusive; do not specify both. A user interface string is a string that's used as a label in a user interface. There are few user interface strings in the JSON response objects. Also, any links to Bing.com properties in the response objects apply the specified language.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/SearchResponse" + } + }, + "default": { + "description": "An error has occurred. Check the response type and/or status code for more details.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples//SuccessfulLocalSearchRequest.json" + } + } + } + } + }, + "definitions": { + "SearchResponse": { + "description": "Defines the top-level object that the response includes when the request succeeds.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": { + "queryContext": { + "description": "An object that contains the query string that Bing used for the request. This object contains the query string as entered by the user. It may also contain an altered query string that Bing used for the query if the query string contained a spelling mistake.", + "$ref": "#/definitions/QueryContext", + "readOnly": true + }, + "places": { + "description": "A list of local entities such as restaurants or hotels that are relevant to the query.", + "$ref": "#/definitions/Places", + "readOnly": true + }, + "lottery": { + "$ref": "#/definitions/SearchResultsAnswer", + "readOnly": true + }, + "searchResultsConfidenceScore": { + "readOnly": true, + "type": "number", + "format": "float" + } + } + }, + "Response": { + "description": "Defines a response. All schemas that return at the root of the response must inherit from this object.", + "allOf": [ + { + "$ref": "#/definitions/Identifiable" + } + ], + "type": "object", + "properties": { + "readLink": { + "description": "The URL that returns this resource.", + "readOnly": true, + "type": "string" + }, + "webSearchUrl": { + "description": "The URL to Bing's search result for this item.", + "readOnly": true, + "type": "string" + }, + "potentialAction": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Action" + } + }, + "immediateAction": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Action" + } + }, + "preferredClickthroughUrl": { + "readOnly": true, + "type": "string" + }, + "adaptiveCard": { + "readOnly": true, + "type": "string" + } + } + }, + "QueryContext": { + "description": "Defines the query context that Bing used for the request.", + "discriminator": "_type", + "type": "object", + "required": [ + "originalQuery", + "_type" + ], + "properties": { + "originalQuery": { + "description": "The query string as specified in the request.", + "type": "string" + }, + "alteredQuery": { + "description": "The query string used by Bing to perform the query. Bing uses the altered query string if the original query string contained spelling mistakes. For example, if the query string is \"saling downwind\", the altered query string will be \"sailing downwind\". This field is included only if the original query string contains a spelling mistake.", + "readOnly": true, + "type": "string" + }, + "alterationDisplayQuery": { + "description": "AlteredQuery that is formatted for display purpose. The query string in the AlterationDisplayQuery can be html-escaped and can contain hit-highlighting characters", + "readOnly": true, + "type": "string" + }, + "alterationOverrideQuery": { + "description": "The query string to use to force Bing to use the original string. For example, if the query string is \"saling downwind\", the override query string will be \"+saling downwind\". Remember to encode the query string which results in \"%2Bsaling+downwind\". This field is included only if the original query string contains a spelling mistake.", + "readOnly": true, + "type": "string" + }, + "adultIntent": { + "description": "A Boolean value that indicates whether the specified query has adult intent. The value is true if the query has adult intent; otherwise, false.", + "readOnly": true, + "type": "boolean" + }, + "askUserForLocation": { + "description": "A Boolean value that indicates whether Bing requires the user's location to provide accurate results. If you specified the user's location by using the X-MSEdge-ClientIP and X-Search-Location headers, you can ignore this field. For location aware queries, such as \"today's weather\" or \"restaurants near me\" that need the user's location to provide accurate results, this field is set to true. For location aware queries that include the location (for example, \"Seattle weather\"), this field is set to false. This field is also set to false for queries that are not location aware, such as \"best sellers\".", + "readOnly": true, + "type": "boolean" + }, + "isTransactional": { + "readOnly": true, + "type": "boolean" + }, + "_type": { + "type": "string" + } + } + }, + "Places": { + "description": "Defines a local entity answer.", + "allOf": [ + { + "$ref": "#/definitions/SearchResultsAnswer" + } + ], + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "description": "A list of local entities, such as restaurants or hotels.", + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + } + } + }, + "SearchResultsAnswer": { + "description": "Defines a search result answer.", + "allOf": [ + { + "$ref": "#/definitions/Answer" + } + ], + "type": "object", + "properties": { + "queryContext": { + "$ref": "#/definitions/QueryContext", + "readOnly": true + }, + "totalEstimatedMatches": { + "description": "The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results.", + "readOnly": true, + "type": "integer", + "format": "int64" + }, + "isFamilyFriendly": { + "readOnly": true, + "type": "boolean" + } + } + }, + "Identifiable": { + "description": "Defines the identity of a resource.", + "allOf": [ + { + "$ref": "#/definitions/ResponseBase" + } + ], + "type": "object", + "properties": { + "id": { + "description": "A String identifier.", + "readOnly": true, + "type": "string" + } + } + }, + "Answer": { + "description": "Defines an answer.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": {} + }, + "ErrorResponse": { + "description": "The top-level response that represents a failed request.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "required": [ + "errors" + ], + "properties": { + "errors": { + "description": "A list of errors that describe the reasons why the request failed.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "Thing": { + "description": "Defines a thing.", + "allOf": [ + { + "$ref": "#/definitions/Response" + } + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "url": { + "description": "The URL to get more information about the thing represented by this object.", + "readOnly": true, + "type": "string" + }, + "entityPresentationInfo": { + "description": "Additional information about the entity such as hints that you can use to determine the entity's type. To determine the entity's type, use the entityScenario and entityTypeHint fields.", + "$ref": "#/definitions/EntitiesEntityPresentationInfo", + "readOnly": true + } + } + }, + "Action": { + "description": "Defines an action.", + "allOf": [ + { + "$ref": "#/definitions/CreativeWork" + } + ], + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Place" + } + }, + "result": { + "description": "The result produced in the action.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "displayName": { + "description": "A display name for the action.", + "readOnly": true, + "type": "string" + }, + "isTopAction": { + "description": "A Boolean representing whether this result is the top action.", + "readOnly": true, + "type": "boolean" + }, + "serviceUrl": { + "description": "Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.", + "readOnly": true, + "type": "string" + } + } + }, + "CreativeWork": { + "description": "The most generic kind of creative work, including books, movies, photographs, software programs, etc.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "thumbnailUrl": { + "description": "The URL to a thumbnail of the item.", + "readOnly": true, + "type": "string" + }, + "about": { + "description": "For internal use only.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "mentions": { + "description": "For internal use only.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "provider": { + "description": "The source of the creative work.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Thing" + } + }, + "creator": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "text": { + "description": "Text content of this creative work", + "readOnly": true, + "type": "string" + }, + "discussionUrl": { + "readOnly": true, + "type": "string" + }, + "commentCount": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "mainEntity": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "headLine": { + "readOnly": true, + "type": "string" + }, + "copyrightHolder": { + "$ref": "#/definitions/Thing", + "readOnly": true + }, + "copyrightYear": { + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "disclaimer": { + "readOnly": true, + "type": "string" + }, + "isAccessibleForFree": { + "readOnly": true, + "type": "boolean" + }, + "genre": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "isFamilyFriendly": { + "readOnly": true, + "type": "boolean" + } + } + }, + "Place": { + "description": "Defines information about a local entity, such as a restaurant or hotel.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object", + "properties": { + "geo": { + "$ref": "#/definitions/GeoCoordinates", + "readOnly": true + }, + "routablePoint": { + "$ref": "#/definitions/GeoCoordinates", + "readOnly": true + }, + "address": { + "description": "The postal address of where the entity is located", + "$ref": "#/definitions/PostalAddress", + "readOnly": true + }, + "telephone": { + "description": "The entity's telephone number", + "readOnly": true, + "type": "string" + } + } + }, + "ResponseBase": { + "description": "Response base", + "discriminator": "_type", + "type": "object", + "required": [ + "_type" + ], + "properties": { + "_type": { + "type": "string" + } + } + }, + "Error": { + "description": "Defines the error that occurred.", + "discriminator": "_type", + "type": "object", + "required": [ + "code", + "message", + "_type" + ], + "properties": { + "code": { + "description": "The error code that identifies the category of error.", + "type": "string", + "default": "None", + "enum": [ + "None", + "ServerError", + "InvalidRequest", + "RateLimitExceeded", + "InvalidAuthorization", + "InsufficientAuthorization" + ], + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "subCode": { + "description": "The error code that further helps to identify the error.", + "readOnly": true, + "type": "string", + "enum": [ + "UnexpectedError", + "ResourceError", + "NotImplemented", + "ParameterMissing", + "ParameterInvalidValue", + "HttpNotAllowed", + "Blocked", + "AuthorizationMissing", + "AuthorizationRedundancy", + "AuthorizationDisabled", + "AuthorizationExpired" + ], + "x-ms-enum": { + "name": "ErrorSubCode", + "modelAsString": true + } + }, + "message": { + "description": "A description of the error.", + "type": "string" + }, + "moreDetails": { + "description": "A description that provides additional information about the error.", + "readOnly": true, + "type": "string" + }, + "parameter": { + "description": "The parameter in the request that caused the error.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "The parameter's value in the request that was not valid.", + "readOnly": true, + "type": "string" + }, + "_type": { + "type": "string" + } + } + }, + "Intangible": { + "description": "A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.", + "allOf": [ + { + "$ref": "#/definitions/Thing" + } + ], + "type": "object" + }, + "EntitiesEntityPresentationInfo": { + "description": "Defines additional information about an entity such as type hints.", + "x-ms-discriminator-value": "Entities/EntityPresentationInfo", + "discriminator": "_type", + "type": "object", + "required": [ + "entityScenario", + "_type" + ], + "properties": { + "entityScenario": { + "description": "The supported scenario.", + "type": "string", + "default": "DominantEntity", + "enum": [ + "DominantEntity", + "DisambiguationItem", + "ListItem" + ], + "x-ms-enum": { + "name": "EntityScenario", + "modelAsString": true + } + }, + "entityTypeHints": { + "description": "A list of hints that indicate the entity's type. The list could contain a single hint such as Movie or a list of hints such as Place, LocalBusiness, Restaurant. Each successive hint in the array narrows the entity's type.", + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Place", + "LocalBusiness", + "Restaurant", + "Hotel" + ], + "x-ms-enum": { + "name": "EntityType", + "modelAsString": true + } + } + }, + "entityTypeDisplayHint": { + "description": "A display version of the entity hint. For example, if entityTypeHints is Artist, this field may be set to American Singer.", + "readOnly": true, + "type": "string" + }, + "query": { + "readOnly": true, + "type": "string" + }, + "entitySubTypeHints": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "_type": { + "type": "string" + } + } + }, + "SearchAction": { + "allOf": [ + { + "$ref": "#/definitions/Action" + } + ], + "type": "object", + "properties": { + "displayText": { + "readOnly": true, + "type": "string" + }, + "query": { + "readOnly": true, + "type": "string" + }, + "richContent": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Answer" + } + }, + "formattingRuleId": { + "readOnly": true, + "type": "string" + } + } + }, + "StructuredValue": { + "allOf": [ + { + "$ref": "#/definitions/Intangible" + } + ], + "type": "object" + }, + "GeoCoordinates": { + "discriminator": "_type", + "type": "object", + "required": [ + "latitude", + "longitude", + "_type" + ], + "properties": { + "latitude": { + "type": "number", + "format": "double" + }, + "longitude": { + "type": "number", + "format": "double" + }, + "elevation": { + "readOnly": true, + "type": "number", + "format": "double" + }, + "_type": { + "type": "string" + } + } + }, + "PostalAddress": { + "description": "Defines a postal address.", + "allOf": [ + { + "$ref": "#/definitions/StructuredValue" + } + ], + "type": "object", + "properties": { + "streetAddress": { + "readOnly": true, + "type": "string" + }, + "addressLocality": { + "description": "The city where the street address is located. For example, Seattle.", + "readOnly": true, + "type": "string" + }, + "addressSubregion": { + "readOnly": true, + "type": "string" + }, + "addressRegion": { + "description": "The state or province code where the street address is located. This could be the two-letter code. For example, WA, or the full name , Washington.", + "readOnly": true, + "type": "string" + }, + "postalCode": { + "description": "The zip code or postal code where the street address is located. For example, 98052.", + "readOnly": true, + "type": "string" + }, + "postOfficeBoxNumber": { + "readOnly": true, + "type": "string" + }, + "addressCountry": { + "description": "The country/region where the street address is located. This could be the two-letter ISO code. For example, US, or the full name, United States.", + "readOnly": true, + "type": "string" + }, + "countryIso": { + "description": "The two letter ISO code of this countr. For example, US.", + "readOnly": true, + "type": "string" + }, + "neighborhood": { + "description": "The neighborhood where the street address is located. For example, Westlake.", + "readOnly": true, + "type": "string" + }, + "addressRegionAbbreviation": { + "description": "Region Abbreviation. For example, WA.", + "readOnly": true, + "type": "string" + }, + "text": { + "description": "The complete address. For example, 2100 Westlake Ave N, Bellevue, WA 98052.", + "readOnly": true, + "type": "string" + }, + "houseNumber": { + "readOnly": true, + "type": "string" + }, + "streetName": { + "readOnly": true, + "type": "string" + }, + "formattingRuleId": { + "readOnly": true, + "type": "string" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/examples/SuccessfulLocalSearchRequest.json b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/examples/SuccessfulLocalSearchRequest.json new file mode 100644 index 000000000000..d34cc7cf7e80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/examples/SuccessfulLocalSearchRequest.json @@ -0,0 +1,339 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "Accept": "application/json", + "User-Agent": "{User Agent}", + "X-MSEdge-ClientID": "{Client ID}", + "mkt": "en-us", + "q": "restaurants in seattle" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "_type": "SearchResponse", + "queryContext": { + "originalQuery": "restaurants in seattle" + }, + "places": { + "totalEstimatedMatches": 10, + "value": [ + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.0", + "name": "SkyCity Restaurant", + "url": "http://www.spaceneedle.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.620491027832, + "longitude": -122.349227905273 + }, + "routablePoint": { + "latitude": 47.620044708252, + "longitude": -122.348487854004 + }, + "address": { + "streetAddress": "400 Broad St", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98109", + "addressCountry": "US", + "neighborhood": "Queen Anne: Lower", + "text": "400 Broad St, Seattle, WA, 98109" + }, + "telephone": "(206) 905-2100" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.1", + "name": "Shiro's Sushi Restaurant", + "url": "http://shiros.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6147994995117, + "longitude": -122.347297668457 + }, + "routablePoint": { + "latitude": 47.614917755127, + "longitude": -122.347145080566 + }, + "address": { + "streetAddress": "2401 2nd Ave", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98121", + "addressCountry": "US", + "neighborhood": "Belltown", + "text": "2401 2nd Ave, Seattle, WA, 98121" + }, + "telephone": "(206) 443-9844" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.2", + "name": "Maneki Restaurant", + "url": "http://www.manekirestaurant.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.599739074707, + "longitude": -122.326141357422 + }, + "routablePoint": { + "latitude": 47.599739074707, + "longitude": -122.326362609863 + }, + "address": { + "streetAddress": "304 6th Ave S", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98104", + "addressCountry": "US", + "neighborhood": "Japantown, Chinatown International District", + "text": "304 6th Ave S, Seattle, WA, 98104" + }, + "telephone": "(206) 622-2631" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.3", + "name": "Palomino", + "url": "http://palomino.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.610538482666, + "longitude": -122.334686279297 + }, + "routablePoint": { + "latitude": 47.6102981567383, + "longitude": -122.335258483887 + }, + "address": { + "streetAddress": "1420 5th Ave", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98101", + "addressCountry": "US", + "neighborhood": "Downtown", + "text": "1420 5th Ave, Seattle, WA, 98101" + }, + "telephone": "(206) 623-1300" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.4", + "name": "Lowell's Restaurant", + "url": "http://eatatlowells.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6087112426758, + "longitude": -122.340911865234 + }, + "routablePoint": { + "latitude": 47.6088256835938, + "longitude": -122.340766906738 + }, + "address": { + "streetAddress": "1519 Pike Pl", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98101", + "addressCountry": "US", + "neighborhood": "Downtown", + "text": "1519 Pike Pl, Seattle, WA, 98101" + }, + "telephone": "(206) 622-2036" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.5", + "name": "The Athenian Seafood Restaurant and Bar", + "url": "http://www.athenianseattle.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "address": { + "streetAddress": "", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98101", + "addressCountry": "US", + "neighborhood": "Downtown", + "text": "Seattle, WA, 98101" + }, + "telephone": "(206) 624-7166" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.6", + "name": "Cutters Crabhouse", + "url": "http://cutterscrabhouse.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6105194091797, + "longitude": -122.344390869141 + }, + "routablePoint": { + "latitude": 47.610767364502, + "longitude": -122.34407043457 + }, + "address": { + "streetAddress": "2001 Western Ave", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98121", + "addressCountry": "US", + "neighborhood": "Downtown", + "text": "2001 Western Ave, Seattle, WA, 98121" + }, + "telephone": "(206) 448-4884" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.7", + "name": "Americana Restaurant", + "url": "http://www.americanaseattle.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6206283569336, + "longitude": -122.321342468262 + }, + "routablePoint": { + "latitude": 47.6206321716309, + "longitude": -122.320915222168 + }, + "address": { + "streetAddress": "219 Broadway E", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98102", + "addressCountry": "US", + "neighborhood": "Capitol Hill", + "text": "219 Broadway E, Seattle, WA, 98102" + }, + "telephone": "(206) 328-4604" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.8", + "name": "Six Seven Restaurant", + "url": "http://www.edgewaterhotel.com/seattle-six-seven-restaurant.aspx", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6125106811523, + "longitude": -122.352020263672 + }, + "routablePoint": { + "latitude": 47.612964630127, + "longitude": -122.351547241211 + }, + "address": { + "streetAddress": "2411 Alaskan Way", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98121", + "addressCountry": "US", + "neighborhood": "Interbay", + "text": "2411 Alaskan Way, Seattle, WA, 98121" + }, + "telephone": "(206) 269-4575" + }, + { + "_type": "LocalBusiness", + "id": "https://api.cognitive.microsoft.com/api/v7/#Places.9", + "name": "Fisherman's Restaurant", + "url": "http://thefishermansrestaurant.com/", + "entityPresentationInfo": { + "entityScenario": "ListItem", + "entityTypeHints": [ + "Place", + "LocalBusiness", + "Restaurant" + ] + }, + "geo": { + "latitude": 47.6060791015625, + "longitude": -122.341049194336 + }, + "routablePoint": { + "latitude": 47.606330871582, + "longitude": -122.340446472168 + }, + "address": { + "streetAddress": "1301 Alaskan Way", + "addressLocality": "Seattle", + "addressRegion": "WA", + "postalCode": "98101", + "addressCountry": "US", + "neighborhood": "Waterfront", + "text": "1301 Alaskan Way, Seattle, WA, 98101" + }, + "telephone": "(206) 623-3500" + } + ], + "searchAction": {} + } + } + } + } +} \ No newline at end of file From 29b57c9990323df99ee15d3c8e630832eeb52b7b Mon Sep 17 00:00:00 2001 From: Ace Eldeib Date: Wed, 31 Oct 2018 07:39:06 -0700 Subject: [PATCH 073/464] Add example with nested segmentation, fix number types, remove extraneous `produces` (#4311) * add segmented metrics example, minor fixes * add example, return metric get full to previous state * remove duplicate file * Fix examples * fix go object type * fix build issues on parameters * fix go configuration --- .../examples/metric-get-segmented.json | 149 ++++++++++++++++++ .../preview/2018-04-20/swagger.json | 11 +- .../preview/v1/AppInsights.json | 7 +- .../v1/examples/metric-get-segmented.json | 146 +++++++++++++++++ .../preview/v1/examples/query-schema.json | 18 +-- .../data-plane/readme.go.md | 16 +- .../oms-get-cross-workspace-example.json | 4 +- .../stable/v1/examples/oms-get-example.json | 4 +- .../oms-post-cross-workspace-example.json | 4 +- .../stable/v1/examples/oms-post-example.json | 4 +- .../data-plane/readme.go.md | 4 + 11 files changed, 327 insertions(+), 40 deletions(-) create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json new file mode 100644 index 000000000000..c97ac07326cf --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json @@ -0,0 +1,149 @@ +{ + "title": "Get intervaled and segmented request count", + "description": "Gets intervaled and segmented metric", + "parameters": { + "subscriptionId": "c512b59c-4005-40e2-b13d-ac29cfb46af4", + "resourceGroupName": "test-rg", + "applicationName": "azure-insights", + "apiVersion": "2018-04-20", + "metricId": "requests%2Fcount", + "timespan": "P2D", + "interval": "P1D", + "segment": [ + "operation/name", + "request/success" + ] + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2018-10-22T10:40:09.065Z", + "end": "2018-10-22T22:40:09.065Z", + "segments": [ + { + "operation/name": "GET Home/Index", + "segments": [ + { + "requests/count": null, + "sum": 156483, + "request/success": false + }, + { + "requests/count": null, + "sum": 3795, + "request/success": true + } + ] + }, + { + "operation/name": "GET /", + "segments": [ + { + "requests/count": null, + "sum": 34168, + "request/success": false + }, + { + "requests/count": null, + "sum": 12, + "request/success": true + } + ] + }, + { + "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-light-webfont.eot", + "segments": [ + { + "requests/count": null, + "sum": 9378, + "request/success": true + } + ] + }, + { + "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-webfont.eot", + "segments": [ + { + "requests/count": null, + "sum": 9370, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/Details", + "segments": [ + { + "requests/count": null, + "sum": 1989, + "request/success": false + }, + { + "requests/count": null, + "sum": 14, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/Index", + "segments": [ + { + "requests/count": null, + "sum": 1991, + "request/success": true + } + ] + }, + { + "operation/name": "GET Employees/Index", + "segments": [ + { + "requests/count": null, + "sum": 1990, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/GetLogEntries", + "segments": [ + { + "requests/count": null, + "sum": 1985, + "request/success": true + } + ] + }, + { + "operation/name": "GET Employees/Details", + "segments": [ + { + "requests/count": null, + "sum": 663, + "request/success": false + }, + { + "requests/count": null, + "sum": 663, + "request/success": true + } + ] + }, + { + "operation/name": "GET Reports/Index", + "segments": [ + { + "requests/count": null, + "sum": 1086, + "request/success": true + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json index 408621d1bed9..2532c71e063f 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json @@ -142,6 +142,9 @@ }, "intervaledMetric": { "$ref": "examples/metric-get-full.json" + }, + "segmentedIntervaledMetric": { + "$ref": "examples/metric-get-segmented.json" } }, "parameters": [ @@ -487,7 +490,7 @@ ], "x-ms-enum": { "name": "MetricsAggregation", - "modelAsString": false + "modelAsString": true } } }, @@ -807,7 +810,7 @@ ], "x-ms-enum": { "name": "MetricsAggregation", - "modelAsString": false + "modelAsString": true } } }, @@ -999,9 +1002,7 @@ } } }, - "additionalProperties": { - "type": "object" - } + "additionalProperties": true }, "eventType": { "description": "The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types.", diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json index c8065b8adce7..ad12ee07fa7f 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json @@ -56,6 +56,9 @@ }, "intervaledMetric": { "$ref": "examples/metric-get-full.json" + }, + "segmentedIntervaledMetric": { + "$ref": "examples/metric-get-segmented.json" } }, "parameters": [ @@ -936,9 +939,7 @@ } } }, - "additionalProperties": { - "type": "object" - } + "additionalProperties": true }, "eventType": { "description": "The type of events to query; either a standard event type (`traces`, `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`, `availabilityResults`) or `$all` to query across all event types.", diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json new file mode 100644 index 000000000000..f8844e39107b --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json @@ -0,0 +1,146 @@ +{ + "title": "Get intervaled and segmented request count", + "description": "Gets intervaled and segmented metric", + "parameters": { + "appId": "DEMO_APP", + "metricId": "requests%2Fcount", + "timespan": "P2D", + "interval": "P1D", + "segment": [ + "operation/name", + "request/success" + ] + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2018-10-22T10:40:09.065Z", + "end": "2018-10-22T22:40:09.065Z", + "segments": [ + { + "operation/name": "GET Home/Index", + "segments": [ + { + "requests/count": null, + "sum": 156483, + "request/success": false + }, + { + "requests/count": null, + "sum": 3795, + "request/success": true + } + ] + }, + { + "operation/name": "GET /", + "segments": [ + { + "requests/count": null, + "sum": 34168, + "request/success": false + }, + { + "requests/count": null, + "sum": 12, + "request/success": true + } + ] + }, + { + "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-light-webfont.eot", + "segments": [ + { + "requests/count": null, + "sum": 9378, + "request/success": true + } + ] + }, + { + "operation/name": "GET /FabrikamProd/Content/fonts/segoewp-webfont.eot", + "segments": [ + { + "requests/count": null, + "sum": 9370, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/Details", + "segments": [ + { + "requests/count": null, + "sum": 1989, + "request/success": false + }, + { + "requests/count": null, + "sum": 14, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/Index", + "segments": [ + { + "requests/count": null, + "sum": 1991, + "request/success": true + } + ] + }, + { + "operation/name": "GET Employees/Index", + "segments": [ + { + "requests/count": null, + "sum": 1990, + "request/success": true + } + ] + }, + { + "operation/name": "GET ServiceTickets/GetLogEntries", + "segments": [ + { + "requests/count": null, + "sum": 1985, + "request/success": true + } + ] + }, + { + "operation/name": "GET Employees/Details", + "segments": [ + { + "requests/count": null, + "sum": 663, + "request/success": false + }, + { + "requests/count": null, + "sum": 663, + "request/success": true + } + ] + }, + { + "operation/name": "GET Reports/Index", + "segments": [ + { + "requests/count": null, + "sum": 1086, + "request/success": true + } + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json index 9041c74be769..505248f596ee 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json @@ -182,7 +182,7 @@ [ "traces", "itemCount", - "System.Double" + "System.Int32" ], [ "customEvents", @@ -332,7 +332,7 @@ [ "customEvents", "itemCount", - "System.Double" + "System.Int32" ], [ "pageViews", @@ -497,7 +497,7 @@ [ "pageViews", "itemCount", - "System.Double" + "System.Int32" ], [ "requests", @@ -682,7 +682,7 @@ [ "requests", "itemCount", - "System.Double" + "System.Int32" ], [ "dependencies", @@ -872,7 +872,7 @@ [ "dependencies", "itemCount", - "System.Double" + "System.Int32" ], [ "exceptions", @@ -1097,7 +1097,7 @@ [ "exceptions", "itemCount", - "System.Double" + "System.Int32" ], [ "availabilityResults", @@ -1282,7 +1282,7 @@ [ "availabilityResults", "itemCount", - "System.Double" + "System.Int32" ], [ "customMetrics", @@ -1482,7 +1482,7 @@ [ "performanceCounters", "value", - "System.String" + "System.Double" ], [ "performanceCounters", @@ -1797,7 +1797,7 @@ [ "browserTimings", "itemCount", - "System.Double" + "System.Int32" ], [ "tEST_CL", diff --git a/specification/applicationinsights/data-plane/readme.go.md b/specification/applicationinsights/data-plane/readme.go.md index 618a78d847fa..3c88242b48d2 100644 --- a/specification/applicationinsights/data-plane/readme.go.md +++ b/specification/applicationinsights/data-plane/readme.go.md @@ -21,19 +21,5 @@ These settings apply only when `--tag=v1 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'v1' && $(go) -output-folder: $(go-sdk-folder)/services/appinsights/v1/$(namespace) -``` - -``` yaml $(typescript) -typescript: - package-name: azure-applicationinsights-query - package-version: 1.0.0-Preview-1 - output-folder: $(node-sdks-folder)/lib/services/applicationinsightsQuery/lib - generate-metadata: true - azure-arm: true - add-credentials: true -directive: - - from: swagger-document - where: $.definitions.table.properties.rows.items.items - transform: $.type = "object" +output-folder: $(go-sdk-folder)/services/preview/appinsights/v1/$(namespace) ``` \ No newline at end of file diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-cross-workspace-example.json index 2e7d2e5846c3..785cf83dc88b 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-cross-workspace-example.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-cross-workspace-example.json @@ -2,9 +2,9 @@ "title": "Cross Workspace Query", "description": "A cross workspace query that the type and count of each row per workspace.", "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", - "workspaces": "draft-test,draft-test-2", - "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111" + "workspaces": "draft-test,draft-test-2" }, "responses": { "200": { diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-example.json index d0410a61ee8c..2818b0bedbb0 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-example.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-get-example.json @@ -2,9 +2,9 @@ "title": "Simple Query", "description": "A simple query that returns query results.", "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", "query": "Usage | take 10", - "timespan": "PT12H", - "workspaceId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + "timespan": "PT12H" }, "responses": { "200": { diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-cross-workspace-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-cross-workspace-example.json index 42693c0fbceb..930205a98196 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-cross-workspace-example.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-cross-workspace-example.json @@ -2,14 +2,14 @@ "title": "Cross Workspace Query", "description": "A cross workspace query that the type and count of each row per workspace.", "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", "body": { "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId", "workspaces": [ "draft-test", "draft-test-2" ] - }, - "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111" + } }, "responses": { "200": { diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-example.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-example.json index eb17e4f3cf72..002776cb4d86 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-example.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/v1/examples/oms-post-example.json @@ -2,11 +2,11 @@ "title": "Simple Query", "description": "A simple query that returns query results.", "parameters": { + "workspaceId": "63613592-b6f7-4c3d-a390-22ba13102111", "body": { "query": "Usage | take 10", "timespan": "PT12H" - }, - "workspaceId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + } }, "responses": { "200": { diff --git a/specification/operationalinsights/data-plane/readme.go.md b/specification/operationalinsights/data-plane/readme.go.md index c683948ad931..a0f6346d5799 100644 --- a/specification/operationalinsights/data-plane/readme.go.md +++ b/specification/operationalinsights/data-plane/readme.go.md @@ -23,4 +23,8 @@ Please also specify `--go-sdk-folder= Date: Wed, 31 Oct 2018 20:55:01 +0530 Subject: [PATCH 074/464] Changed the descriptions of multiple items to bring more clarity for users. (#4365) * Some description text changes * fix Go SDK codegen --- .../stable/2018-05-05/AlertsManagement.json | 54 +++++++++---------- .../resource-manager/readme.go.md | 12 ++--- 2 files changed, 33 insertions(+), 33 deletions(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json index ca549e250e7a..a552dcdb9e63 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json @@ -3,7 +3,7 @@ "info": { "version": "2018-05-05", "title": "Azure Alerts Management Service Resource Provider", - "description": "Azure Alerts Management Service provides a single pane of glass of alerts borne from Azure Monitor." + "description": "Azure Alerts Management Service provides a single pane of glass of alerts across Azure Monitor." }, "schemes": [ "https" @@ -54,7 +54,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts": { "get": { "operationId": "Alerts_GetAll", - "description": "List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields. ", + "description": "List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime. ", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -184,7 +184,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate": { "post": { "operationId": "Alerts_ChangeState", - "description": "Change the state of the alert.", + "description": "Change the state of an alert.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -223,7 +223,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history": { "get": { "operationId": "Alerts_GetHistory", - "description": "Get the history of the changes of an alert.", + "description": "Get the history of an alert, which captures any monitor condition changes (Fired/Resolved) and alert state changes (New/Acknowledged/Closed).", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -237,7 +237,7 @@ ], "responses": { "200": { - "description": "OK. Returns the list of changes of alert.", + "description": "OK. Returns the history of the specified alert.", "schema": { "$ref": "#/definitions/alertModification" } @@ -259,7 +259,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary": { "get": { "operationId": "Alerts_GetSummary", - "description": "Summary of alerts with the count each severity.", + "description": "Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -328,8 +328,8 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups": { "get": { "operationId": "SmartGroups_GetAll", - "summary": "Get all smartGroups within the subscription", - "description": "List all the smartGroups within the specified subscription. ", + "summary": "Get all Smart Groups within a specified subscription", + "description": "List all the Smart Groups within a specified subscription. ", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -399,8 +399,8 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}": { "get": { "operationId": "SmartGroups_GetById", - "summary": "Get information of smart alerts group.", - "description": "Get details of smart group.", + "summary": "Get information related to a specific Smart Group.", + "description": "Get information related to a specific Smart Group.", "produces": [ "application/json" ], @@ -445,7 +445,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState": { "post": { "operationId": "SmartGroups_ChangeState", - "description": "Change the state from unresolved to resolved and all the alerts within the smart group will also be resolved.", + "description": "Change the state of a Smart Group.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -462,7 +462,7 @@ ], "responses": { "200": { - "description": "OK. Alert state updated.", + "description": "OK. Smart Group state updated.", "headers": { "x-ms-request-id": { "type": "string", @@ -490,7 +490,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history": { "get": { "operationId": "SmartGroups_GetHistory", - "description": "Get the history of the changes of smart group.", + "description": "Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -579,7 +579,7 @@ "x-ms-parameter-location": "method" }, "monitorService": { - "description": "Filter by monitor service which is the source of the alert instance. Default value is select all.", + "description": "Filter by monitor service which generates the alert instance. Default value is select all.", "name": "monitorService", "type": "string", "in": "query", @@ -693,7 +693,7 @@ } }, "monitorCondition": { - "description": "Filter by monitor condition which is the state of the monitor(alertRule) at monitor service. Default value is to select all.", + "description": "Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all.", "name": "monitorCondition", "type": "string", "in": "query", @@ -709,7 +709,7 @@ } }, "alertRule": { - "description": "Filter by alert rule(monitor) which fired alert instance. Default value is to select all.", + "description": "Filter by specific alert rule. Default value is to select all.", "name": "alertRule", "type": "string", "in": "query", @@ -743,7 +743,7 @@ "x-ms-parameter-location": "method" }, "includeContext": { - "description": "Include context which has data contextual to the monitor service. Default value is false'", + "description": "Include context which has contextual data specific to the monitor service. Default value is false'", "name": "includeContext", "type": "boolean", "in": "query", @@ -799,7 +799,7 @@ } }, "alertsSummaryGroupBy": { - "description": "This parameter allows the result set to be aggregated by input fields. For example, groupby=severity,alertstate.", + "description": "This parameter allows the result set to be grouped by input fields. For example, groupby=severity,alertstate.", "name": "groupby", "type": "string", "in": "query", @@ -819,7 +819,7 @@ } }, "smartGroupsSortBy": { - "description": "Sort the query results by input field Default value is sort by 'lastModifiedDateTime'.", + "description": "Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'.", "name": "sortBy", "type": "string", "in": "query", @@ -1015,16 +1015,16 @@ }, "alertContext": { "type": "object", - "description": "More details which are contextual to the monitor service.", + "description": "Information specific to the monitor service that gives more contextual details about the alert.", "readOnly": true }, "essentials": { "type": "object", - "description": "This object contains normalized fields across different monitor service and also contains state related fields.", + "description": "This object contains consistent fields across different monitor services.", "properties": { "severity": { "type": "string", - "description": "Severity of alert Sev0 being highest and Sev3 being lowest.", + "description": "Severity of alert Sev0 being highest and Sev4 being lowest.", "readOnly": true, "enum": [ "Sev0", @@ -1040,7 +1040,7 @@ }, "signalType": { "type": "string", - "description": "Log based alert or metric based alert", + "description": "The type of signal the alert is based on, which could be metrics, logs or activity logs.", "readOnly": true, "enum": [ "Metric", @@ -1054,7 +1054,7 @@ }, "alertState": { "type": "string", - "description": "Alert object state, which is modified by the user.", + "description": "Alert object state, which can be modified by the user.", "readOnly": true, "enum": [ "New", @@ -1068,7 +1068,7 @@ }, "monitorCondition": { "type": "string", - "description": "Represents rule condition(Fired/Resolved) maintained by monitor service depending on the state of the state.", + "description": "Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds.", "readOnly": true, "enum": [ "Fired", @@ -1155,7 +1155,7 @@ "monitorConditionResolvedDateTime": { "type": "string", "format": "date-time", - "description": "Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because of the rule condition is not met.", + "description": "Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met.", "readOnly": true }, "lastModifiedUserName": { @@ -1531,4 +1531,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/alertsmanagement/resource-manager/readme.go.md b/specification/alertsmanagement/resource-manager/readme.go.md index 4341e8cb6d5a..15f8da2cd650 100644 --- a/specification/alertsmanagement/resource-manager/readme.go.md +++ b/specification/alertsmanagement/resource-manager/readme.go.md @@ -12,14 +12,14 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) batch: - - tag: package-2018-05-preview + - tag: package-2018-05 ``` -### Tag: package-2018-05-preview and go +### Tag: package-2018-05 and go -These settings apply only when `--tag=package-2018-05-preview --go` is specified on the command line. +These settings apply only when `--tag=package-2018-05 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2018-05-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-05-05-preview/$(namespace) -``` \ No newline at end of file +``` yaml $(tag) == 'package-2018-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-05-05/$(namespace) +``` From 86f0601994508ff7c59576186f0c889669ae8841 Mon Sep 17 00:00:00 2001 From: wawon-msft <32000704+wawon-msft@users.noreply.github.com> Date: Wed, 31 Oct 2018 09:55:57 -0700 Subject: [PATCH 075/464] Fixed non-existent extra parameter (bug) (#4364) --- .../preview/2015-03-01-preview/applications.json | 7 ------- .../preview/2018-06-01-preview/applications.json | 7 ------- 2 files changed, 14 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json index bf8e4d00ffb8..eabeaa6e40f2 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/applications.json @@ -249,9 +249,6 @@ "format": "int32", "description": "The public port to connect to." } - }, - "additionalProperties": { - "type": "string" } }, "ApplicationGetEndpoint": { @@ -340,10 +337,6 @@ "readOnly": true, "type": "string", "description": "The marketplace identifier." - }, - "additionalProperties": { - "description": "The additional properties for application.", - "type": "string" } } }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json index 0f93b242c986..81828bee681f 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/applications.json @@ -251,9 +251,6 @@ "format": "int32", "description": "The public port to connect to." } - }, - "additionalProperties": { - "type": "string" } }, "ApplicationGetEndpoint": { @@ -342,10 +339,6 @@ "readOnly": true, "type": "string", "description": "The marketplace identifier." - }, - "additionalProperties": { - "description": "The additional properties for application.", - "type": "string" } } }, From 47695966902a2b8fb1c437476fc994dd1910b979 Mon Sep 17 00:00:00 2001 From: Ron Balter <38618732+t-robalt@users.noreply.github.com> Date: Wed, 31 Oct 2018 22:40:56 +0200 Subject: [PATCH 076/464] [DO NOT MERGE] VA List Api version edit (#4257) * VA List Api version edit * Updated missing tests * Update DatabaseVulnerabilityAssessmentListByDatabase.json * Update DatabaseVulnerabilityAssessmentListByDatabase.json * Update DatabaseVulnerabilityAssessmentListByDatabase.json --- .../databaseVulnerabilityAssessments.json | 91 +++++- ...ityAssessmentCreateContainerSasKeyMin.json | 0 ...ulnerabilityAssessmentCreateSasKeyMin.json | 48 ---- ...tyAssessmentCreateStorageAccessKeyMin.json | 0 ...rabilityAssessmentCreateStorageKeyMin.json | 48 ---- ...VulnerabilityAssessmentListByDatabase.json | 4 +- ...VulnerabilityAssessmentListByDatabase.json | 0 ...nagedDatabaseVulnerabilityAssessments.json | 85 +++++- .../DatabaseVulnerabilityAssessment.json | 258 ----------------- ...nagedDatabaseVulnerabilityAssessments.json | 262 ------------------ ...abaseVulnerabilityAssessmentCreateMax.json | 54 ---- ...DatabaseVulnerabilityAssessmentDelete.json | 14 - .../DatabaseVulnerabilityAssessmentGet.json | 27 -- ...abaseVulnerabilityAssessmentCreateMax.json | 53 ---- ...abaseVulnerabilityAssessmentCreateMin.json | 48 ---- ...DatabaseVulnerabilityAssessmentDelete.json | 14 - ...gedDatabaseVulnerabilityAssessmentGet.json | 27 -- 17 files changed, 157 insertions(+), 876 deletions(-) rename specification/sql/resource-manager/Microsoft.Sql/preview/{2018-06-01-preview => 2017-03-01-preview}/examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json (100%) delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateSasKeyMin.json rename specification/sql/resource-manager/Microsoft.Sql/preview/{2018-06-01-preview => 2017-03-01-preview}/examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json (100%) delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageKeyMin.json rename specification/sql/resource-manager/Microsoft.Sql/preview/{2018-06-01-preview => 2017-03-01-preview}/examples/DatabaseVulnerabilityAssessmentListByDatabase.json (97%) rename specification/sql/resource-manager/Microsoft.Sql/preview/{2018-06-01-preview => 2017-10-01-preview}/examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json (100%) delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/DatabaseVulnerabilityAssessment.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/ManagedDatabaseVulnerabilityAssessments.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMax.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMin.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentDelete.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentGet.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json index 7fcfd980c6b9..8a97f00afc0c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json @@ -66,7 +66,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -133,7 +133,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Successfully created the vulnerability assessment.", @@ -143,14 +143,14 @@ } }, "x-ms-examples": { - "Create a database's vulnerability assessment with all parameters": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateMax.json" - }, "Create a database's vulnerability assessment with minimal parameters, when storageContainerSasKey is specified": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateSasKeyMin.json" + "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json" }, "Create a database's vulnerability assessment with minimal parameters, when storageAccountAccessKey is specified": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateStorageKeyMin.json" + "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json" + }, + "Create a database's vulnerability assessment with all parameters": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentCreateMax.json" } } }, @@ -200,7 +200,7 @@ "description": "Successfully removed the database vulnerability assessment." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -209,18 +209,64 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments": { + "get": { + "tags": [ + "DatabaseVulnerabilityAssessments" + ], + "description": "Lists the vulnerability assessment policies associated with a database.", + "operationId": "DatabaseVulnerabilityAssessments_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment policies are defined.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database vulnerability assessment policies.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the database's vulnerability assessment policies": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentListByDatabase.json" + } + } + } } }, "definitions": { "DatabaseVulnerabilityAssessmentProperties": { "description": "Properties of a database Vulnerability Assessment.", - "required": [ - "storageContainerPath" - ], "type": "object", "properties": { "storageContainerPath": { - "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", "type": "string", "x-ms-mutability": [ "create", @@ -236,7 +282,7 @@ ] }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the vulnerability assessment storage account. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -286,6 +332,25 @@ "x-ms-client-flatten": true } } + }, + "DatabaseVulnerabilityAssessmentListResult": { + "description": "A list of the database's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json similarity index 100% rename from specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json rename to specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateContainerSasKeyMin.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateSasKeyMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateSasKeyMin.json deleted file mode 100644 index 121ad41dc081..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateSasKeyMin.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-03-01-preview", - "parameters": { - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json similarity index 100% rename from specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json rename to specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageAccessKeyMin.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageKeyMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageKeyMin.json deleted file mode 100644 index 30ee42d4206c..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentCreateStorageKeyMin.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-03-01-preview", - "parameters": { - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json similarity index 97% rename from specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json rename to specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json index db1a430bf939..c70a2a22b9a6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/DatabaseVulnerabilityAssessmentListByDatabase.json @@ -3,7 +3,7 @@ "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "vulnerabilityaseessmenttest-4799", "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", + "databaseName": "testdb", "vulnerabilityAssessmentName": "default", "api-version": "2018-06-01-preview" }, @@ -28,4 +28,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json similarity index 100% rename from specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json rename to specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json index fd9ef090237a..f7891dbc7934 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessments.json @@ -70,7 +70,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -141,7 +141,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Successfully created the vulnerability assessment.", @@ -209,7 +209,7 @@ "description": "Successfully removed the database vulnerability assessment." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -218,18 +218,68 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments": { + "get": { + "tags": [ + "ManagedDatabaseVulnerabilityAssessments" + ], + "description": "Lists the vulnerability assessments of a managed database.", + "operationId": "ManagedDatabaseVulnerabilityAssessments_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the vulnerability assessment is defined.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database vulnerability assessments.", + "schema": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessmentListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a database's vulnerability assessments list": { + "$ref": "./examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json" + } + } + } } }, "definitions": { "DatabaseVulnerabilityAssessmentProperties": { "description": "Properties of a database Vulnerability Assessment.", - "required": [ - "storageContainerPath" - ], "type": "object", "properties": { "storageContainerPath": { - "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/).", + "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", "type": "string", "x-ms-mutability": [ "create", @@ -245,7 +295,7 @@ ] }, "storageAccountAccessKey": { - "description": "Specifies the identifier key of the vulnerability assessment storage account. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", + "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", "type": "string", "x-ms-mutability": [ "create", @@ -295,6 +345,25 @@ "x-ms-client-flatten": true } } + }, + "DatabaseVulnerabilityAssessmentListResult": { + "description": "A list of the database's vulnerability assessments.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseVulnerabilityAssessment" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } } }, "parameters": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/DatabaseVulnerabilityAssessment.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/DatabaseVulnerabilityAssessment.json deleted file mode 100644 index b7c6b90bec7e..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/DatabaseVulnerabilityAssessment.json +++ /dev/null @@ -1,258 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-06-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments": { - "get": { - "tags": [ - "DatabaseVulnerabilityAssessments" - ], - "description": "Lists the vulnerability assessment policies associated with a database.", - "operationId": "DatabaseVulnerabilityAssessments_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "databaseName", - "in": "path", - "description": "The name of the database for which the vulnerability assessment policies are defined.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the database vulnerability assessment policies.", - "schema": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessmentListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get the database's vulnerability assessment policies": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentListByDatabase.json" - } - } - } - } - }, - "definitions": { - "DatabaseVulnerabilityAssessmentListResult": { - "description": "A list of the database's vulnerability assessments.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessment" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "DatabaseVulnerabilityAssessmentProperties": { - "description": "Properties of a database Vulnerability Assessment.", - "type": "object", - "properties": { - "storageContainerPath": { - "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "storageContainerSasKey": { - "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "storageAccountAccessKey": { - "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "recurringScans": { - "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", - "description": "The recurring scans settings" - } - } - }, - "VulnerabilityAssessmentRecurringScansProperties": { - "description": "Properties of a Vulnerability Assessment recurring scans.", - "type": "object", - "properties": { - "isEnabled": { - "description": "Recurring scans state.", - "type": "boolean" - }, - "emailSubscriptionAdmins": { - "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", - "default": true, - "type": "boolean" - }, - "emails": { - "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DatabaseVulnerabilityAssessment": { - "description": "A database vulnerability assessment.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessmentProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/ManagedDatabaseVulnerabilityAssessments.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/ManagedDatabaseVulnerabilityAssessments.json deleted file mode 100644 index a108cdcf5d7c..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/ManagedDatabaseVulnerabilityAssessments.json +++ /dev/null @@ -1,262 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-06-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/vulnerabilityAssessments": { - "get": { - "tags": [ - "ManagedDatabaseVulnerabilityAssessments" - ], - "description": "Lists the vulnerability assessments of a database.", - "operationId": "ManagedDatabaseVulnerabilityAssessments_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string" - }, - { - "name": "databaseName", - "in": "path", - "description": "The name of the database for which the vulnerability assessment is defined.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the database vulnerability assessments.", - "schema": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessmentListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Get a database's vulnerability assessments list": { - "$ref": "./examples/ManagedDatabaseVulnerabilityAssessmentListByDatabase.json" - } - } - } - } - }, - "definitions": { - "DatabaseVulnerabilityAssessmentListResult": { - "description": "A list of the database's vulnerability assessments.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessment" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "DatabaseVulnerabilityAssessmentProperties": { - "description": "Properties of a database Vulnerability Assessment.", - "type": "object", - "properties": { - "storageContainerPath": { - "description": "A blob storage container path to hold the scan results (e.g. https://myStorage.blob.core.windows.net/VaScans/). It is required if server level vulnerability assessment policy doesn't set", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "storageContainerSasKey": { - "description": "A shared access signature (SAS Key) that has write access to the blob container specified in 'storageContainerPath' parameter. If 'storageAccountAccessKey' isn't specified, StorageContainerSasKey is required.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "storageAccountAccessKey": { - "description": "Specifies the identifier key of the storage account for vulnerability assessment scan results. If 'StorageContainerSasKey' isn't specified, storageAccountAccessKey is required.", - "type": "string", - "x-ms-mutability": [ - "create", - "update" - ] - }, - "recurringScans": { - "$ref": "#/definitions/VulnerabilityAssessmentRecurringScansProperties", - "description": "The recurring scans settings" - } - } - }, - "VulnerabilityAssessmentRecurringScansProperties": { - "description": "Properties of a Vulnerability Assessment recurring scans.", - "type": "object", - "properties": { - "isEnabled": { - "description": "Recurring scans state.", - "type": "boolean" - }, - "emailSubscriptionAdmins": { - "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", - "default": true, - "type": "boolean" - }, - "emails": { - "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "DatabaseVulnerabilityAssessment": { - "description": "A database vulnerability assessment.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseVulnerabilityAssessmentProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json deleted file mode 100644 index 75862b1e65c3..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentCreateMax.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-03-01-preview", - "parameters": { - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "storageAccountAccessKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json deleted file mode 100644 index b6cfa2303d4e..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json deleted file mode 100644 index 2c583ee4a055..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/DatabaseVulnerabilityAssessmentGet.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "serverName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/servers/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMax.json deleted file mode 100644 index f028be63d685..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMax.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "managedInstanceName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMin.json deleted file mode 100644 index ace54ecf7ca1..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentCreateMin.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "managedInstanceName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-10-01-preview", - "parameters": { - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "storageContainerSasKey": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": false, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": false, - "emailSubscriptionAdmins": false, - "emails": [] - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentDelete.json deleted file mode 100644 index 6815fcdb5093..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "managedInstanceName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentGet.json deleted file mode 100644 index f88ef60d2c6a..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ManagedDatabaseVulnerabilityAssessmentGet.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "vulnerabilityaseessmenttest-4799", - "managedInstanceName": "vulnerabilityaseessmenttest-6440", - "databaseName": "testdb", - "vulnerabilityAssessmentName": "default", - "api-version": "2017-10-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/vulnerabilityaseessmenttest-4799/providers/Microsoft.Sql/managedInstances/vulnerabilityaseessmenttest-6440/databases/testdb/vulnerabilityAssessments/default", - "name": "default", - "type": "Microsoft.Sql/servers/databases/vulnerabilityAssessments", - "properties": { - "storageContainerPath": "https://myStorage.blob.core.windows.net/vulnerability-assessment/", - "recurringScans": { - "isEnabled": true, - "emailSubscriptionAdmins": true, - "emails": [ "email1@mail.com", "email2@mail.com" ] - } - } - } - } - } -} \ No newline at end of file From eae134537e7fd35e5bcbae4eda564d91933e9257 Mon Sep 17 00:00:00 2001 From: Jacob Viau Date: Wed, 31 Oct 2018 14:16:32 -0700 Subject: [PATCH 077/464] Add Devtestlabs/2018-09-15 (#4357) * Copy DTL 2016-05-15 * Add DTL 2018-09-15 * Update go and ruby readme * Add package-2018-09 to java. Re-order go & ruby api tag --- .../stable/2018-09-15/DTL.json | 11018 ++++++++++++++++ .../2018-09-15/examples/Labs_ClaimAnyVm.json | 17 + .../examples/Labs_CreateEnvironment.json | 41 + .../examples/Labs_CreateOrUpdate.json | 81 + .../2018-09-15/examples/Labs_Delete.json | 19 + .../examples/Labs_GenerateUploadUri.json | 18 + .../stable/2018-09-15/examples/Labs_Get.json | 46 + .../examples/Labs_ListByResourceGroup.json | 45 + .../examples/Labs_ListBySubscription.json | 78 + .../2018-09-15/examples/Labs_Update.json | 47 + .../examples/ProviderOperations_List.json | 859 ++ .../examples/VirtualMachines_Claim.json | 17 + .../VirtualMachines_CreateOrUpdate.json | 117 + .../examples/VirtualMachines_Delete.json | 20 + .../examples/VirtualMachines_Get.json | 54 + .../VirtualMachines_GetRdpFileContents.json | 16 + .../examples/VirtualMachines_List.json | 57 + .../examples/VirtualMachines_Redeploy.json | 18 + .../examples/VirtualMachines_Resize.json | 21 + .../examples/VirtualMachines_Restart.json | 18 + .../examples/VirtualMachines_Start.json | 18 + .../examples/VirtualMachines_Stop.json | 17 + .../examples/VirtualMachines_UnClaim.json | 18 + .../examples/VirtualMachines_Update.json | 59 + .../VirtualNetworks_CreateOrUpdate.json | 47 + .../examples/VirtualNetworks_Delete.json | 20 + .../examples/VirtualNetworks_Get.json | 54 + .../examples/VirtualNetworks_List.json | 57 + .../examples/VirtualNetworks_Update.json | 70 + .../devtestlabs/resource-manager/readme.go.md | 9 + .../devtestlabs/resource-manager/readme.md | 25 +- .../resource-manager/readme.ruby.md | 11 + 32 files changed, 13011 insertions(+), 1 deletion(-) create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json create mode 100644 specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json new file mode 100644 index 000000000000..cc38601373f2 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json @@ -0,0 +1,11018 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-09-15", + "title": "DevTestLabsClient", + "description": "The DevTest Labs Client." + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.DevTestLab/operations": { + "get": { + "tags": [ "ProviderOperations" ], + "description": "Result of the request to list REST API operations", + "operationId": "ProviderOperations_List", + "parameters": [ { "$ref": "#/parameters/api-version" } ], + "responses": { + "200": { + "description": "Success", + "schema": { "$ref": "#/definitions/ProviderOperationResult" } + } + }, + "x-ms-examples": { "ProviderOperations_List": { "$ref": "./examples/ProviderOperations_List.json" } }, + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/labs": { + "get": { + "tags": [ "Labs" ], + "description": "List labs in a subscription.", + "operationId": "Labs_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Lab", + "x-ms-examples": { "Labs_ListBySubscription": { "$ref": "./examples/Labs_ListBySubscription.json" } } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/locations/{locationName}/operations/{name}": { + "get": { + "tags": [ "Operations" ], + "description": "Get operation.", + "operationId": "Operations_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/locationName" }, + { + "name": "name", + "in": "path", + "description": "The name of the operation.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationResult" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevTestLab/schedules": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "List schedules in a subscription.", + "operationId": "GlobalSchedules_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs": { + "get": { + "tags": [ "Labs" ], + "description": "List labs in a resource group.", + "operationId": "Labs_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Lab", + "x-ms-examples": { "Labs_ListByResourceGroup": { "$ref": "./examples/Labs_ListByResourceGroup.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources": { + "get": { + "tags": [ "ArtifactSources" ], + "description": "List artifact sources in a given lab.", + "operationId": "ArtifactSources_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSourceList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ArtifactSource" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates": { + "get": { + "tags": [ "ArmTemplates" ], + "description": "List azure resource manager templates in a given artifact source.", + "operationId": "ArmTemplates_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArmTemplateList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ArmTemplate" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/armtemplates/{name}": { + "get": { + "tags": [ "ArmTemplates" ], + "description": "Get azure resource manager template.", + "operationId": "ArmTemplates_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the azure Resource Manager template.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArmTemplate" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts": { + "get": { + "tags": [ "Artifacts" ], + "description": "List artifacts in a given artifact source.", + "operationId": "Artifacts_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=title)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Artifact" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}": { + "get": { + "tags": [ "Artifacts" ], + "description": "Get artifact.", + "operationId": "Artifacts_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=title)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Artifact" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{artifactSourceName}/artifacts/{name}/generateArmTemplate": { + "post": { + "tags": [ "Artifacts" ], + "description": "Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact.", + "operationId": "Artifacts_GenerateArmTemplate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "artifactSourceName", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact.", + "required": true, + "type": "string" + }, + { + "name": "generateArmTemplateRequest", + "in": "body", + "description": "Parameters for generating an ARM template for deploying artifacts.", + "required": true, + "schema": { "$ref": "#/definitions/GenerateArmTemplateRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArmTemplateInfo" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/artifactsources/{name}": { + "get": { + "tags": [ "ArtifactSources" ], + "description": "Get artifact source.", + "operationId": "ArtifactSources_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=displayName)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "ArtifactSources" ], + "description": "Create or replace an existing artifact source.", + "operationId": "ArtifactSources_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "artifactSource", + "in": "body", + "description": "Properties of an artifact source.", + "required": true, + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "ArtifactSources" ], + "description": "Delete artifact source.", + "operationId": "ArtifactSources_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "ArtifactSources" ], + "description": "Modify properties of artifact sources.", + "operationId": "ArtifactSources_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the artifact source.", + "required": true, + "type": "string" + }, + { + "name": "artifactSource", + "in": "body", + "description": "Properties of an artifact source.", + "required": true, + "schema": { "$ref": "#/definitions/ArtifactSourceFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ArtifactSource" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/costs/{name}": { + "get": { + "tags": [ "Costs" ], + "description": "Get cost.", + "operationId": "Costs_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the cost.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=labCostDetails)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Costs" ], + "description": "Create or replace an existing cost.", + "operationId": "Costs_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the cost.", + "required": true, + "type": "string" + }, + { + "name": "labCost", + "in": "body", + "description": "A cost item.", + "required": true, + "schema": { "$ref": "#/definitions/LabCost" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/LabCost" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages": { + "get": { + "tags": [ "CustomImages" ], + "description": "List custom images in a given lab.", + "operationId": "CustomImages_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=vm)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImageList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/CustomImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/customimages/{name}": { + "get": { + "tags": [ "CustomImages" ], + "description": "Get custom image.", + "operationId": "CustomImages_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=vm)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "CustomImages" ], + "description": "Create or replace an existing custom image. This operation can take a while to complete.", + "operationId": "CustomImages_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { + "name": "customImage", + "in": "body", + "description": "A custom image.", + "required": true, + "schema": { "$ref": "#/definitions/CustomImage" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "CustomImages" ], + "description": "Delete custom image. This operation can take a while to complete.", + "operationId": "CustomImages_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "CustomImages" ], + "description": "Modify properties of custom images.", + "operationId": "CustomImages_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the custom image.", + "required": true, + "type": "string" + }, + { + "name": "customImage", + "in": "body", + "description": "A custom image.", + "required": true, + "schema": { "$ref": "#/definitions/CustomImageFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/CustomImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas": { + "get": { + "tags": [ "Formulas" ], + "description": "List formulas in a given lab.", + "operationId": "Formulas_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/FormulaList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Formula" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/formulas/{name}": { + "get": { + "tags": [ "Formulas" ], + "description": "Get formula.", + "operationId": "Formulas_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Formula" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Formulas" ], + "description": "Create or replace an existing Formula. This operation can take a while to complete.", + "operationId": "Formulas_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { + "name": "formula", + "in": "body", + "description": "A formula for creating a VM, specifying an image base and other parameters", + "required": true, + "schema": { "$ref": "#/definitions/Formula" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Formula" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Formula" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Formulas" ], + "description": "Delete formula.", + "operationId": "Formulas_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "Formulas" ], + "description": "Modify properties of formulas.", + "operationId": "Formulas_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the formula.", + "required": true, + "type": "string" + }, + { + "name": "formula", + "in": "body", + "description": "A formula for creating a VM, specifying an image base and other parameters", + "required": true, + "schema": { "$ref": "#/definitions/FormulaFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Formula" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/galleryimages": { + "get": { + "tags": [ "GalleryImages" ], + "description": "List gallery images in a given lab.", + "operationId": "GalleryImages_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=author)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GalleryImageList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/GalleryImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels": { + "get": { + "tags": [ "NotificationChannels" ], + "description": "List notificationchannels in a given lab.", + "operationId": "NotificationChannels_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannelList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/NotificationChannel" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}": { + "get": { + "tags": [ "NotificationChannels" ], + "description": "Get notificationchannel.", + "operationId": "NotificationChannels_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=webHookUrl)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "NotificationChannels" ], + "description": "Create or replace an existing notificationChannel.", + "operationId": "NotificationChannels_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notificationChannel", + "in": "body", + "description": "A notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "NotificationChannels" ], + "description": "Delete notificationchannel.", + "operationId": "NotificationChannels_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "NotificationChannels" ], + "description": "Modify properties of notificationchannels.", + "operationId": "NotificationChannels_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notificationChannel", + "in": "body", + "description": "A notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotificationChannelFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/NotificationChannel" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}/notify": { + "post": { + "tags": [ "NotificationChannels" ], + "description": "Send notification to provided channel.", + "operationId": "NotificationChannels_Notify", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the notificationChannel.", + "required": true, + "type": "string" + }, + { + "name": "notifyParameters", + "in": "body", + "description": "Properties for generating a Notification.", + "required": true, + "schema": { "$ref": "#/definitions/NotifyParameters" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{name}/evaluatePolicies": { + "post": { + "tags": [ "PolicySets" ], + "description": "Evaluates lab policy.", + "operationId": "PolicySets_EvaluatePolicies", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "evaluatePoliciesRequest", + "in": "body", + "description": "Request body for evaluating a policy set.", + "required": true, + "schema": { "$ref": "#/definitions/EvaluatePoliciesRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/EvaluatePoliciesResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies": { + "get": { + "tags": [ "Policies" ], + "description": "List policies in a given policy set.", + "operationId": "Policies_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/PolicyList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Policy" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/policysets/{policySetName}/policies/{name}": { + "get": { + "tags": [ "Policies" ], + "description": "Get policy.", + "operationId": "Policies_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=description)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Policies" ], + "description": "Create or replace an existing policy.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "policy", + "in": "body", + "description": "A Policy.", + "required": true, + "schema": { "$ref": "#/definitions/Policy" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "Policies" ], + "description": "Delete policy.", + "operationId": "Policies_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "Policies" ], + "description": "Modify properties of policies.", + "operationId": "Policies_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "policySetName", + "in": "path", + "description": "The name of the policy set.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the policy.", + "required": true, + "type": "string" + }, + { + "name": "policy", + "in": "body", + "description": "A Policy.", + "required": true, + "schema": { "$ref": "#/definitions/PolicyFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Policy" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules": { + "get": { + "tags": [ "Schedules" ], + "description": "List schedules in a given lab.", + "operationId": "Schedules_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}": { + "get": { + "tags": [ "Schedules" ], + "description": "Get schedule.", + "operationId": "Schedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Schedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "Schedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "Schedules" ], + "description": "Delete schedule.", + "operationId": "Schedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "Schedules" ], + "description": "Modify properties of schedules.", + "operationId": "Schedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/execute": { + "post": { + "tags": [ "Schedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "Schedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/schedules/{name}/listApplicable": { + "post": { + "tags": [ "Schedules" ], + "description": "Lists all applicable schedules", + "operationId": "Schedules_ListApplicable", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners": { + "get": { + "tags": [ "ServiceRunners" ], + "description": "List service runners in a given lab.", + "operationId": "ServiceRunners_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceRunnerList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ServiceRunner" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/servicerunners/{name}": { + "get": { + "tags": [ "ServiceRunners" ], + "description": "Get service runner.", + "operationId": "ServiceRunners_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "ServiceRunners" ], + "description": "Create or replace an existing Service runner.", + "operationId": "ServiceRunners_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { + "name": "serviceRunner", + "in": "body", + "description": "A container for a managed identity to execute DevTest lab services.", + "required": true, + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/ServiceRunner" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "ServiceRunners" ], + "description": "Delete service runner.", + "operationId": "ServiceRunners_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service runner.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users": { + "get": { + "tags": [ "Users" ], + "description": "List user profiles in a given lab.", + "operationId": "Users_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=identity)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/UserList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/User" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{name}": { + "get": { + "tags": [ "Users" ], + "description": "Get user profile.", + "operationId": "Users_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=identity)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Users" ], + "description": "Create or replace an existing user profile. This operation can take a while to complete.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "Profile of a lab user.", + "required": true, + "schema": { "$ref": "#/definitions/User" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Users" ], + "description": "Delete user profile. This operation can take a while to complete.", + "operationId": "Users_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Users" ], + "description": "Modify properties of user profiles.", + "operationId": "Users_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "Profile of a lab user.", + "required": true, + "schema": { "$ref": "#/definitions/UserFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks": { + "get": { + "tags": [ "Disks" ], + "description": "List disks in a given user profile.", + "operationId": "Disks_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=diskType)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DiskList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Disk" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}": { + "get": { + "tags": [ "Disks" ], + "description": "Get disk.", + "operationId": "Disks_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=diskType)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Disk" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Disks" ], + "description": "Create or replace an existing disk. This operation can take a while to complete.", + "operationId": "Disks_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "disk", + "in": "body", + "description": "A Disk.", + "required": true, + "schema": { "$ref": "#/definitions/Disk" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Disk" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Disk" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Disks" ], + "description": "Delete disk. This operation can take a while to complete.", + "operationId": "Disks_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Disks" ], + "description": "Modify properties of disks.", + "operationId": "Disks_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "disk", + "in": "body", + "description": "A Disk.", + "required": true, + "schema": { "$ref": "#/definitions/DiskFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Disk" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/attach": { + "post": { + "tags": [ "Disks" ], + "description": "Attach and create the lease of the disk to the virtual machine. This operation can take a while to complete.", + "operationId": "Disks_Attach", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "attachDiskProperties", + "in": "body", + "description": "Properties of the disk to attach.", + "required": true, + "schema": { "$ref": "#/definitions/AttachDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}/detach": { + "post": { + "tags": [ "Disks" ], + "description": "Detach and break the lease of the disk attached to the virtual machine. This operation can take a while to complete.", + "operationId": "Disks_Detach", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the disk.", + "required": true, + "type": "string" + }, + { + "name": "detachDiskProperties", + "in": "body", + "description": "Properties of the disk to detach.", + "required": true, + "schema": { "$ref": "#/definitions/DetachDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments": { + "get": { + "tags": [ "Environments" ], + "description": "List environments in a given user profile.", + "operationId": "Environments_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironmentList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/DtlEnvironment" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/environments/{name}": { + "get": { + "tags": [ "Environments" ], + "description": "Get environment.", + "operationId": "Environments_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=deploymentProperties)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Environments" ], + "description": "Create or replace an existing environment. This operation can take a while to complete.", + "operationId": "Environments_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "dtlEnvironment", + "in": "body", + "description": "An environment, which is essentially an ARM template deployment.", + "required": true, + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Environments" ], + "description": "Delete environment. This operation can take a while to complete.", + "operationId": "Environments_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Environments" ], + "description": "Modify properties of environments.", + "operationId": "Environments_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "dtlEnvironment", + "in": "body", + "description": "An environment, which is essentially an ARM template deployment.", + "required": true, + "schema": { "$ref": "#/definitions/DtlEnvironmentFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/DtlEnvironment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets": { + "get": { + "tags": [ "Secrets" ], + "description": "List secrets in a given user profile.", + "operationId": "Secrets_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=value)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/SecretList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Secret" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/secrets/{name}": { + "get": { + "tags": [ "Secrets" ], + "description": "Get secret.", + "operationId": "Secrets_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=value)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Secret" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "Secrets" ], + "description": "Create or replace an existing secret. This operation can take a while to complete.", + "operationId": "Secrets_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "A secret.", + "required": true, + "schema": { "$ref": "#/definitions/Secret" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Secret" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Secret" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Secrets" ], + "description": "Delete secret.", + "operationId": "Secrets_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "Secrets" ], + "description": "Modify properties of secrets.", + "operationId": "Secrets_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the secret.", + "required": true, + "type": "string" + }, + { + "name": "secret", + "in": "body", + "description": "A secret.", + "required": true, + "schema": { "$ref": "#/definitions/SecretFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Secret" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics": { + "get": { + "tags": [ "ServiceFabrics" ], + "description": "List service fabrics in a given user profile.", + "operationId": "ServiceFabrics_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=applicableSchedule)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceFabricList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ServiceFabric" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}": { + "get": { + "tags": [ "ServiceFabrics" ], + "description": "Get service fabric.", + "operationId": "ServiceFabrics_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=applicableSchedule)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceFabric" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "ServiceFabrics" ], + "description": "Create or replace an existing Service Fabric. This operation can take a while to complete.", + "operationId": "ServiceFabrics_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabric", + "in": "body", + "description": "A Service Fabric.", + "required": true, + "schema": { "$ref": "#/definitions/ServiceFabric" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceFabric" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/ServiceFabric" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "ServiceFabrics" ], + "description": "Delete service fabric. This operation can take a while to complete.", + "operationId": "ServiceFabrics_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "ServiceFabrics" ], + "description": "Modify properties of service fabrics.", + "operationId": "ServiceFabrics_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabric", + "in": "body", + "description": "A Service Fabric.", + "required": true, + "schema": { "$ref": "#/definitions/ServiceFabricFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ServiceFabric" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/listApplicableSchedules": { + "post": { + "tags": [ "ServiceFabrics" ], + "description": "Lists the applicable start/stop schedules, if any.", + "operationId": "ServiceFabrics_ListApplicableSchedules", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ApplicableSchedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/start": { + "post": { + "tags": [ "ServiceFabrics" ], + "description": "Start a service fabric. This operation can take a while to complete.", + "operationId": "ServiceFabrics_Start", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{name}/stop": { + "post": { + "tags": [ "ServiceFabrics" ], + "description": "Stop a service fabric This operation can take a while to complete.", + "operationId": "ServiceFabrics_Stop", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules": { + "get": { + "tags": [ "ServiceFabricSchedules" ], + "description": "List schedules in a given service fabric.", + "operationId": "ServiceFabricSchedules_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}": { + "get": { + "tags": [ "ServiceFabricSchedules" ], + "description": "Get schedule.", + "operationId": "ServiceFabricSchedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "ServiceFabricSchedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "ServiceFabricSchedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "ServiceFabricSchedules" ], + "description": "Delete schedule.", + "operationId": "ServiceFabricSchedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "ServiceFabricSchedules" ], + "description": "Modify properties of schedules.", + "operationId": "ServiceFabricSchedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/servicefabrics/{serviceFabricName}/schedules/{name}/execute": { + "post": { + "tags": [ "ServiceFabricSchedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "ServiceFabricSchedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user profile.", + "required": true, + "type": "string" + }, + { + "name": "serviceFabricName", + "in": "path", + "description": "The name of the service Fabric.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines": { + "get": { + "tags": [ "VirtualMachines" ], + "description": "List virtual machines in a given lab.", + "operationId": "VirtualMachines_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachineList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/LabVirtualMachine", + "x-ms-examples": { "VirtualMachines_List": { "$ref": "./examples/VirtualMachines_List.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}": { + "get": { + "tags": [ "VirtualMachines" ], + "description": "Get virtual machine.", + "operationId": "VirtualMachines_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Get": { "$ref": "./examples/VirtualMachines_Get.json" } } + }, + "put": { + "tags": [ "VirtualMachines" ], + "description": "Create or replace an existing Virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachine", + "in": "body", + "description": "A virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_CreateOrUpdate": { "$ref": "./examples/VirtualMachines_CreateOrUpdate.json" } }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "VirtualMachines" ], + "description": "Delete virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Delete": { "$ref": "./examples/VirtualMachines_Delete.json" } }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "VirtualMachines" ], + "description": "Modify properties of virtual machines.", + "operationId": "VirtualMachines_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachine", + "in": "body", + "description": "A virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachineFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Update": { "$ref": "./examples/VirtualMachines_Update.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Attach a new or existing data disk to virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_AddDataDisk", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "dataDiskProperties", + "in": "body", + "description": "Request body for adding a new or existing data disk to a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/DataDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Apply artifacts to virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_ApplyArtifacts", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "applyArtifactsRequest", + "in": "body", + "description": "Request body for applying artifacts to a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/ApplyArtifactsRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Take ownership of an existing virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_Claim", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Claim": { "$ref": "./examples/VirtualMachines_Claim.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Detach the specified disk from the virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_DetachDataDisk", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "detachDataDiskProperties", + "in": "body", + "description": "Request body for detaching data disk from a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/DetachDataDiskProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Gets a string that represents the contents of the RDP file for the virtual machine", + "operationId": "VirtualMachines_GetRdpFileContents", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/RdpConnection" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_GetRdpFileContents": { "$ref": "./examples/VirtualMachines_GetRdpFileContents.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Lists the applicable start/stop schedules, if any.", + "operationId": "VirtualMachines_ListApplicableSchedules", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ApplicableSchedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/redeploy": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Redeploy a virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_Redeploy", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Redeploy": { "$ref": "./examples/VirtualMachines_Redeploy.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/resize": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Resize Virtual Machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Resize", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "resizeLabVirtualMachineProperties", + "in": "body", + "description": "Request body for resizing a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/ResizeLabVirtualMachineProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Resize": { "$ref": "./examples/VirtualMachines_Resize.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/restart": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Restart a virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Restart", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Restart": { "$ref": "./examples/VirtualMachines_Restart.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Start a virtual machine. This operation can take a while to complete.", + "operationId": "VirtualMachines_Start", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Start": { "$ref": "./examples/VirtualMachines_Start.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Stop a virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_Stop", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_Stop": { "$ref": "./examples/VirtualMachines_Stop.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/transferDisks": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete.", + "operationId": "VirtualMachines_TransferDisks", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/unClaim": { + "post": { + "tags": [ "VirtualMachines" ], + "description": "Release ownership of an existing virtual machine This operation can take a while to complete.", + "operationId": "VirtualMachines_UnClaim", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualMachines_UnClaim": { "$ref": "./examples/VirtualMachines_UnClaim.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules": { + "get": { + "tags": [ "VirtualMachineSchedules" ], + "description": "List schedules in a given virtual machine.", + "operationId": "VirtualMachineSchedules_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}": { + "get": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Get schedule.", + "operationId": "VirtualMachineSchedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "VirtualMachineSchedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Delete schedule.", + "operationId": "VirtualMachineSchedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Modify properties of schedules.", + "operationId": "VirtualMachineSchedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{virtualMachineName}/schedules/{name}/execute": { + "post": { + "tags": [ "VirtualMachineSchedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "VirtualMachineSchedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "virtualMachineName", + "in": "path", + "description": "The name of the virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks": { + "get": { + "tags": [ "VirtualNetworks" ], + "description": "List virtual networks in a given lab.", + "operationId": "VirtualNetworks_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetworkList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/VirtualNetwork", + "x-ms-examples": { "VirtualNetworks_List": { "$ref": "./examples/VirtualNetworks_List.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualnetworks/{name}": { + "get": { + "tags": [ "VirtualNetworks" ], + "description": "Get virtual network.", + "operationId": "VirtualNetworks_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=externalSubnets)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualNetworks_Get": { "$ref": "./examples/VirtualNetworks_Get.json" } } + }, + "put": { + "tags": [ "VirtualNetworks" ], + "description": "Create or replace an existing virtual network. This operation can take a while to complete.", + "operationId": "VirtualNetworks_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "virtualNetwork", + "in": "body", + "description": "A virtual network.", + "required": true, + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualNetworks_CreateOrUpdate": { "$ref": "./examples/VirtualNetworks_CreateOrUpdate.json" } }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "VirtualNetworks" ], + "description": "Delete virtual network. This operation can take a while to complete.", + "operationId": "VirtualNetworks_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualNetworks_Delete": { "$ref": "./examples/VirtualNetworks_Delete.json" } }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "VirtualNetworks" ], + "description": "Modify properties of virtual networks.", + "operationId": "VirtualNetworks_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the virtual network.", + "required": true, + "type": "string" + }, + { + "name": "virtualNetwork", + "in": "body", + "description": "A virtual network.", + "required": true, + "schema": { "$ref": "#/definitions/VirtualNetworkFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/VirtualNetwork" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "VirtualNetworks_Update": { "$ref": "./examples/VirtualNetworks_Update.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}": { + "get": { + "tags": [ "Labs" ], + "description": "Get lab.", + "operationId": "Labs_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=defaultStorageAccount)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_Get": { "$ref": "./examples/Labs_Get.json" } } + }, + "put": { + "tags": [ "Labs" ], + "description": "Create or replace an existing lab. This operation can take a while to complete.", + "operationId": "Labs_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "A lab.", + "required": true, + "schema": { "$ref": "#/definitions/Lab" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_CreateOrUpdate": { "$ref": "./examples/Labs_CreateOrUpdate.json" } }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "Labs" ], + "description": "Delete lab. This operation can take a while to complete.", + "operationId": "Labs_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_Delete": { "$ref": "./examples/Labs_Delete.json" } }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Labs" ], + "description": "Modify properties of labs.", + "operationId": "Labs_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "A lab.", + "required": true, + "schema": { "$ref": "#/definitions/LabFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_Update": { "$ref": "./examples/Labs_Update.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/claimAnyVm": { + "post": { + "tags": [ "Labs" ], + "description": "Claim a random claimable virtual machine in the lab. This operation can take a while to complete.", + "operationId": "Labs_ClaimAnyVm", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_ClaimAnyVm": { "$ref": "./examples/Labs_ClaimAnyVm.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/createEnvironment": { + "post": { + "tags": [ "Labs" ], + "description": "Create virtual machines in a lab. This operation can take a while to complete.", + "operationId": "Labs_CreateEnvironment", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "labVirtualMachineCreationParameter", + "in": "body", + "description": "Properties for creating a virtual machine.", + "required": true, + "schema": { "$ref": "#/definitions/LabVirtualMachineCreationParameter" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_CreateEnvironment": { "$ref": "./examples/Labs_CreateEnvironment.json" } }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/exportResourceUsage": { + "post": { + "tags": [ "Labs" ], + "description": "Exports the lab resource usage into a storage account This operation can take a while to complete.", + "operationId": "Labs_ExportResourceUsage", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "exportResourceUsageParameters", + "in": "body", + "description": "The parameters of the export operation.", + "required": true, + "schema": { "$ref": "#/definitions/ExportResourceUsageParameters" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/generateUploadUri": { + "post": { + "tags": [ "Labs" ], + "description": "Generate a URI for uploading custom disk images to a Lab.", + "operationId": "Labs_GenerateUploadUri", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "generateUploadUriParameter", + "in": "body", + "description": "Properties for generating an upload URI.", + "required": true, + "schema": { "$ref": "#/definitions/GenerateUploadUriParameter" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GenerateUploadUriResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-examples": { "Labs_GenerateUploadUri": { "$ref": "./examples/Labs_GenerateUploadUri.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/importVirtualMachine": { + "post": { + "tags": [ "Labs" ], + "description": "Import a virtual machine into a different lab. This operation can take a while to complete.", + "operationId": "Labs_ImportVirtualMachine", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "importLabVirtualMachineRequest", + "in": "body", + "description": "This represents the payload required to import a virtual machine from a different lab into the current one", + "required": true, + "schema": { "$ref": "#/definitions/ImportLabVirtualMachineRequest" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{name}/listVhds": { + "post": { + "tags": [ "Labs" ], + "description": "List disk images available for custom image creation.", + "operationId": "Labs_ListVhds", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabVhdList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "List schedules in a resource group.", + "operationId": "GlobalSchedules_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName')", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ScheduleList" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Schedule" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}": { + "get": { + "tags": [ "GlobalSchedules" ], + "description": "Get schedule.", + "operationId": "GlobalSchedules_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=status)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "put": { + "tags": [ "GlobalSchedules" ], + "description": "Create or replace an existing schedule.", + "operationId": "GlobalSchedules_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/Schedule" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "delete": { + "tags": [ "GlobalSchedules" ], + "description": "Delete schedule.", + "operationId": "GlobalSchedules_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + }, + "patch": { + "tags": [ "GlobalSchedules" ], + "description": "Modify properties of schedules.", + "operationId": "GlobalSchedules_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "schedule", + "in": "body", + "description": "A schedule.", + "required": true, + "schema": { "$ref": "#/definitions/ScheduleFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Schedule" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/execute": { + "post": { + "tags": [ "GlobalSchedules" ], + "description": "Execute a schedule. This operation can take a while to complete.", + "operationId": "GlobalSchedules_Execute", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/schedules/{name}/retarget": { + "post": { + "tags": [ "GlobalSchedules" ], + "description": "Updates a schedule's target resource Id. This operation can take a while to complete.", + "operationId": "GlobalSchedules_Retarget", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "name", + "in": "path", + "description": "The name of the schedule.", + "required": true, + "type": "string" + }, + { + "name": "retargetScheduleProperties", + "in": "body", + "description": "Properties for retargeting a virtual machine schedule.", + "required": true, + "schema": { "$ref": "#/definitions/RetargetScheduleProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ApplicableSchedule": { + "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicableScheduleProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ApplicableScheduleFragment": { + "description": "Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplicableSchedulePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ApplicableScheduleProperties": { + "description": "Properties of a schedules applicable to a virtual machine.", + "type": "object", + "properties": { + "labVmsShutdown": { + "$ref": "#/definitions/Schedule", + "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." + }, + "labVmsStartup": { + "$ref": "#/definitions/Schedule", + "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." + } + } + }, + "ApplicableSchedulePropertiesFragment": { + "description": "Properties of a schedules applicable to a virtual machine.", + "type": "object", + "properties": { + "labVmsShutdown": { + "$ref": "#/definitions/ScheduleFragment", + "description": "The auto-shutdown schedule, if one has been set at the lab or lab resource level." + }, + "labVmsStartup": { + "$ref": "#/definitions/ScheduleFragment", + "description": "The auto-startup schedule, if one has been set at the lab or lab resource level." + } + } + }, + "ApplyArtifactsRequest": { + "description": "Request body for applying artifacts to a virtual machine.", + "type": "object", + "properties": { + "artifacts": { + "description": "The list of artifacts to apply.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + } + } + }, + "ArmTemplate": { + "description": "An Azure Resource Manager template.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArmTemplateProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArmTemplateInfo": { + "description": "Information about a generated ARM template.", + "type": "object", + "properties": { + "template": { + "description": "The template's contents.", + "type": "object" + }, + "parameters": { + "description": "The parameters of the ARM template.", + "type": "object" + } + } + }, + "ArmTemplateList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ArmTemplate" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ArmTemplateParameterProperties": { + "description": "Properties of an Azure Resource Manager template parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the template parameter.", + "type": "string" + }, + "value": { + "description": "The value of the template parameter.", + "type": "string" + } + } + }, + "ArmTemplateParameterPropertiesFragment": { + "description": "Properties of an Azure Resource Manager template parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the template parameter.", + "type": "string" + }, + "value": { + "description": "The value of the template parameter.", + "type": "string" + } + } + }, + "ArmTemplateProperties": { + "description": "Properties of an Azure Resource Manager template.", + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the ARM template.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the ARM template.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the ARM template.", + "type": "string", + "readOnly": true + }, + "icon": { + "description": "The URI to the icon of the ARM template.", + "type": "string", + "readOnly": true + }, + "contents": { + "description": "The contents of the ARM template.", + "type": "object", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the armTemplate.", + "type": "string", + "readOnly": true + }, + "parametersValueFilesInfo": { + "description": "File name and parameter values information from all azuredeploy.*.parameters.json for the ARM template.", + "type": "array", + "items": { "$ref": "#/definitions/ParametersValueFileInfo" }, + "readOnly": true + }, + "enabled": { + "description": "Whether or not ARM template is enabled for use by lab user.", + "type": "boolean", + "readOnly": true + } + } + }, + "Artifact": { + "description": "An artifact.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactDeploymentStatusProperties": { + "description": "Properties of an artifact deployment.", + "type": "object", + "properties": { + "deploymentStatus": { + "description": "The deployment status of the artifact.", + "type": "string" + }, + "artifactsApplied": { + "format": "int32", + "description": "The total count of the artifacts that were successfully applied.", + "type": "integer" + }, + "totalArtifacts": { + "format": "int32", + "description": "The total count of the artifacts that were tentatively applied.", + "type": "integer" + } + } + }, + "ArtifactDeploymentStatusPropertiesFragment": { + "description": "Properties of an artifact deployment.", + "type": "object", + "properties": { + "deploymentStatus": { + "description": "The deployment status of the artifact.", + "type": "string" + }, + "artifactsApplied": { + "format": "int32", + "description": "The total count of the artifacts that were successfully applied.", + "type": "integer" + }, + "totalArtifacts": { + "format": "int32", + "description": "The total count of the artifacts that were tentatively applied.", + "type": "integer" + } + } + }, + "ArtifactInstallProperties": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "artifactId": { + "description": "The artifact's identifier.", + "type": "string" + }, + "artifactTitle": { + "description": "The artifact's title.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the artifact.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactParameterProperties" } + }, + "status": { + "description": "The status of the artifact.", + "type": "string" + }, + "deploymentStatusMessage": { + "description": "The status message from the deployment.", + "type": "string" + }, + "vmExtensionStatusMessage": { + "description": "The status message from the virtual machine extension.", + "type": "string" + }, + "installTime": { + "format": "date-time", + "description": "The time that the artifact starts to install on the virtual machine.", + "type": "string" + } + } + }, + "ArtifactInstallPropertiesFragment": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "artifactId": { + "description": "The artifact's identifier.", + "type": "string" + }, + "artifactTitle": { + "description": "The artifact's title.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the artifact.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactParameterPropertiesFragment" } + }, + "status": { + "description": "The status of the artifact.", + "type": "string" + }, + "deploymentStatusMessage": { + "description": "The status message from the deployment.", + "type": "string" + }, + "vmExtensionStatusMessage": { + "description": "The status message from the virtual machine extension.", + "type": "string" + }, + "installTime": { + "format": "date-time", + "description": "The time that the artifact starts to install on the virtual machine.", + "type": "string" + } + } + }, + "ArtifactList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Artifact" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ArtifactParameterProperties": { + "description": "Properties of an artifact parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ArtifactParameterPropertiesFragment": { + "description": "Properties of an artifact parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ArtifactProperties": { + "description": "Properties of an artifact.", + "type": "object", + "properties": { + "title": { + "description": "The artifact's title.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The artifact's description.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The artifact's publisher.", + "type": "string", + "readOnly": true + }, + "filePath": { + "description": "The file path to the artifact.", + "type": "string", + "readOnly": true + }, + "icon": { + "description": "The URI to the artifact icon.", + "type": "string", + "readOnly": true + }, + "targetOsType": { + "description": "The artifact's target OS.", + "type": "string", + "readOnly": true + }, + "parameters": { + "description": "The artifact's parameters.", + "type": "object", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "The artifact's creation date.", + "type": "string", + "readOnly": true + } + } + }, + "ArtifactSource": { + "description": "Properties of an artifact source.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactSourceProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactSourceFragment": { + "description": "Properties of an artifact source.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ArtifactSourcePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ArtifactSourceList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactSource" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ArtifactSourceProperties": { + "description": "Properties of an artifact source.", + "type": "object", + "properties": { + "displayName": { + "description": "The artifact source's display name.", + "type": "string" + }, + "uri": { + "description": "The artifact source's URI.", + "type": "string" + }, + "sourceType": { + "description": "The artifact source's type.", + "enum": [ "VsoGit", "GitHub" ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "folderPath": { + "description": "The folder containing artifacts.", + "type": "string" + }, + "armTemplateFolderPath": { + "description": "The folder containing Azure Resource Manager templates.", + "type": "string" + }, + "branchRef": { + "description": "The artifact source's branch reference.", + "type": "string" + }, + "securityToken": { + "description": "The security token to authenticate to the artifact source.", + "type": "string" + }, + "status": { + "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "createdDate": { + "format": "date-time", + "description": "The artifact source's creation date.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "ArtifactSourcePropertiesFragment": { + "description": "Properties of an artifact source.", + "type": "object", + "properties": { + "displayName": { + "description": "The artifact source's display name.", + "type": "string" + }, + "uri": { + "description": "The artifact source's URI.", + "type": "string" + }, + "sourceType": { + "description": "The artifact source's type.", + "enum": [ "VsoGit", "GitHub" ], + "type": "string", + "x-ms-enum": { + "name": "SourceControlType", + "modelAsString": true + } + }, + "folderPath": { + "description": "The folder containing artifacts.", + "type": "string" + }, + "armTemplateFolderPath": { + "description": "The folder containing Azure Resource Manager templates.", + "type": "string" + }, + "branchRef": { + "description": "The artifact source's branch reference.", + "type": "string" + }, + "securityToken": { + "description": "The security token to authenticate to the artifact source.", + "type": "string" + }, + "status": { + "description": "Indicates if the artifact source is enabled (values: Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + } + } + }, + "AttachDiskProperties": { + "description": "Properties of the disk to attach.", + "type": "object", + "properties": { + "leasedByLabVmId": { + "description": "The resource ID of the Lab virtual machine to which the disk is attached.", + "type": "string" + } + } + }, + "AttachNewDataDiskOptions": { + "description": "Properties to attach new disk to the Virtual Machine.", + "type": "object", + "properties": { + "diskSizeGiB": { + "format": "int32", + "description": "Size of the disk to be attached in GibiBytes.", + "type": "integer" + }, + "diskName": { + "description": "The name of the disk to be attached.", + "type": "string" + }, + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + } + }, + "AttachNewDataDiskOptionsFragment": { + "description": "Properties to attach new disk to the Virtual Machine.", + "type": "object", + "properties": { + "diskSizeGiB": { + "format": "int32", + "description": "Size of the disk to be attached in GibiBytes.", + "type": "integer" + }, + "diskName": { + "description": "The name of the disk to be attached.", + "type": "string" + }, + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + } + }, + "BulkCreationParameters": { + "description": "Parameters for creating multiple virtual machines as a single action.", + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "The number of virtual machine instances to create.", + "type": "integer" + } + } + }, + "BulkCreationParametersFragment": { + "description": "Parameters for creating multiple virtual machines as a single action.", + "type": "object", + "properties": { + "instanceCount": { + "format": "int32", + "description": "The number of virtual machine instances to create.", + "type": "integer" + } + } + }, + "CloudError": { + "description": "Error from a REST request.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The cloud error that occured" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "Body of an error from a REST request.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "target": { + "description": "The error target.", + "type": "string" + }, + "details": { + "description": "Inner errors.", + "type": "array", + "items": { "$ref": "#/definitions/CloudErrorBody" } + } + }, + "x-ms-external": true + }, + "ComputeDataDisk": { + "description": "A data disks attached to a virtual machine.", + "type": "object", + "properties": { + "name": { + "description": "Gets data disk name.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "diskSizeGiB": { + "format": "int32", + "description": "Gets data disk size in GiB.", + "type": "integer" + } + } + }, + "ComputeDataDiskFragment": { + "description": "A data disks attached to a virtual machine.", + "type": "object", + "properties": { + "name": { + "description": "Gets data disk name.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "diskSizeGiB": { + "format": "int32", + "description": "Gets data disk size in GiB.", + "type": "integer" + } + } + }, + "ComputeVmInstanceViewStatus": { + "description": "Status information about a virtual machine.", + "type": "object", + "properties": { + "code": { + "description": "Gets the status Code.", + "type": "string" + }, + "displayStatus": { + "description": "Gets the short localizable label for the status.", + "type": "string" + }, + "message": { + "description": "Gets the message associated with the status.", + "type": "string" + } + } + }, + "ComputeVmInstanceViewStatusFragment": { + "description": "Status information about a virtual machine.", + "type": "object", + "properties": { + "code": { + "description": "Gets the status Code.", + "type": "string" + }, + "displayStatus": { + "description": "Gets the short localizable label for the status.", + "type": "string" + }, + "message": { + "description": "Gets the message associated with the status.", + "type": "string" + } + } + }, + "ComputeVmProperties": { + "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", + "type": "object", + "properties": { + "statuses": { + "description": "Gets the statuses of the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatus" } + }, + "osType": { + "description": "Gets the OS type of the virtual machine.", + "type": "string" + }, + "vmSize": { + "description": "Gets the size of the virtual machine.", + "type": "string" + }, + "networkInterfaceId": { + "description": "Gets the network interface ID of the virtual machine.", + "type": "string" + }, + "osDiskId": { + "description": "Gets OS disk blob uri for the virtual machine.", + "type": "string" + }, + "dataDiskIds": { + "description": "Gets data disks blob uri for the virtual machine.", + "type": "array", + "items": { "type": "string" } + }, + "dataDisks": { + "description": "Gets all data disks attached to the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeDataDisk" } + } + } + }, + "ComputeVmPropertiesFragment": { + "description": "Properties of a virtual machine returned by the Microsoft.Compute API.", + "type": "object", + "properties": { + "statuses": { + "description": "Gets the statuses of the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeVmInstanceViewStatusFragment" } + }, + "osType": { + "description": "Gets the OS type of the virtual machine.", + "type": "string" + }, + "vmSize": { + "description": "Gets the size of the virtual machine.", + "type": "string" + }, + "networkInterfaceId": { + "description": "Gets the network interface ID of the virtual machine.", + "type": "string" + }, + "osDiskId": { + "description": "Gets OS disk blob uri for the virtual machine.", + "type": "string" + }, + "dataDiskIds": { + "description": "Gets data disks blob uri for the virtual machine.", + "type": "array", + "items": { "type": "string" } + }, + "dataDisks": { + "description": "Gets all data disks attached to the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ComputeDataDiskFragment" } + } + } + }, + "CostThresholdProperties": { + "description": "Properties of a cost threshold item.", + "type": "object", + "properties": { + "thresholdId": { + "description": "The ID of the cost threshold item.", + "type": "string" + }, + "percentageThreshold": { + "$ref": "#/definitions/PercentageCostThresholdProperties", + "description": "The value of the percentage cost threshold." + }, + "displayOnChart": { + "description": "Indicates whether this threshold will be displayed on cost charts.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "CostThresholdStatus", + "modelAsString": true + } + }, + "sendNotificationWhenExceeded": { + "description": "Indicates whether notifications will be sent when this threshold is exceeded.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "CostThresholdStatus", + "modelAsString": true + } + }, + "notificationSent": { + "description": "Indicates the datetime when notifications were last sent for this threshold.", + "type": "string" + } + } + }, + "CustomImage": { + "description": "A custom image.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomImageProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "CustomImageFragment": { + "description": "A custom image.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/CustomImagePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "CustomImageList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/CustomImage" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "CustomImageProperties": { + "description": "Properties of a custom image.", + "type": "object", + "properties": { + "vm": { + "$ref": "#/definitions/CustomImagePropertiesFromVm", + "description": "The virtual machine from which the image is to be created." + }, + "vhd": { + "$ref": "#/definitions/CustomImagePropertiesCustom", + "description": "The VHD from which the image is to be created." + }, + "description": { + "description": "The description of the custom image.", + "type": "string" + }, + "author": { + "description": "The author of the custom image.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the custom image.", + "type": "string", + "readOnly": true + }, + "managedImageId": { + "description": "The Managed Image Id backing the custom image.", + "type": "string" + }, + "managedSnapshotId": { + "description": "The Managed Snapshot Id backing the custom image.", + "type": "string" + }, + "dataDiskStorageInfo": { + "description": "Storage information about the data disks present in the custom image", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskStorageTypeInfo" } + }, + "customImagePlan": { + "$ref": "#/definitions/CustomImagePropertiesFromPlan", + "description": "Storage information about the plan related to this custom image" + }, + "isPlanAuthorized": { + "description": "Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "CustomImagePropertiesCustom": { + "description": "Properties for creating a custom image from a VHD.", + "required": [ "osType" ], + "type": "object", + "properties": { + "imageName": { + "description": "The image name.", + "type": "string" + }, + "sysPrep": { + "description": "Indicates whether sysprep has been run on the VHD.", + "type": "boolean" + }, + "osType": { + "description": "The OS type of the custom image (i.e. Windows, Linux)", + "enum": [ "Windows", "Linux", "None" ], + "type": "string", + "x-ms-enum": { + "name": "CustomImageOsType", + "modelAsString": true + } + } + } + }, + "CustomImagePropertiesCustomFragment": { + "description": "Properties for creating a custom image from a VHD.", + "type": "object", + "properties": { + "imageName": { + "description": "The image name.", + "type": "string" + }, + "sysPrep": { + "description": "Indicates whether sysprep has been run on the VHD.", + "type": "boolean" + }, + "osType": { + "description": "The OS type of the custom image (i.e. Windows, Linux)", + "enum": [ "Windows", "Linux", "None" ], + "type": "string", + "x-ms-enum": { + "name": "CustomImageOsType", + "modelAsString": true + } + } + } + }, + "CustomImagePropertiesFragment": { + "description": "Properties of a custom image.", + "type": "object", + "properties": { + "vm": { + "$ref": "#/definitions/CustomImagePropertiesFromVmFragment", + "description": "The virtual machine from which the image is to be created." + }, + "vhd": { + "$ref": "#/definitions/CustomImagePropertiesCustomFragment", + "description": "The VHD from which the image is to be created." + }, + "description": { + "description": "The description of the custom image.", + "type": "string" + }, + "author": { + "description": "The author of the custom image.", + "type": "string" + }, + "managedImageId": { + "description": "The Managed Image Id backing the custom image.", + "type": "string" + }, + "managedSnapshotId": { + "description": "The Managed Snapshot Id backing the custom image.", + "type": "string" + }, + "dataDiskStorageInfo": { + "description": "Storage information about the data disks present in the custom image", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskStorageTypeInfoFragment" } + }, + "customImagePlan": { + "$ref": "#/definitions/CustomImagePropertiesFromPlanFragment", + "description": "Storage information about the plan related to this custom image" + }, + "isPlanAuthorized": { + "description": "Whether or not the custom images underlying offer/plan has been enabled for programmatic deployment", + "type": "boolean" + } + } + }, + "CustomImagePropertiesFromPlan": { + "description": "Properties for plan on a custom image.", + "type": "object", + "properties": { + "id": { + "description": "The id of the plan, equivalent to name of the plan", + "type": "string" + }, + "publisher": { + "description": "The publisher for the plan from the marketplace image the custom image is derived from", + "type": "string" + }, + "offer": { + "description": "The offer for the plan from the marketplace image the custom image is derived from", + "type": "string" + } + } + }, + "CustomImagePropertiesFromPlanFragment": { + "description": "Properties for plan on a custom image.", + "type": "object", + "properties": { + "id": { + "description": "The id of the plan, equivalent to name of the plan", + "type": "string" + }, + "publisher": { + "description": "The publisher for the plan from the marketplace image the custom image is derived from", + "type": "string" + }, + "offer": { + "description": "The offer for the plan from the marketplace image the custom image is derived from", + "type": "string" + } + } + }, + "CustomImagePropertiesFromVm": { + "description": "Properties for creating a custom image from a virtual machine.", + "type": "object", + "properties": { + "sourceVmId": { + "description": "The source vm identifier.", + "type": "string" + }, + "windowsOsInfo": { + "$ref": "#/definitions/WindowsOsInfo", + "description": "The Windows OS information of the VM." + }, + "linuxOsInfo": { + "$ref": "#/definitions/LinuxOsInfo", + "description": "The Linux OS information of the VM." + } + } + }, + "CustomImagePropertiesFromVmFragment": { + "description": "Properties for creating a custom image from a virtual machine.", + "type": "object", + "properties": { + "sourceVmId": { + "description": "The source vm identifier.", + "type": "string" + }, + "windowsOsInfo": { + "$ref": "#/definitions/WindowsOsInfoFragment", + "description": "The Windows OS information of the VM." + }, + "linuxOsInfo": { + "$ref": "#/definitions/LinuxOsInfoFragment", + "description": "The Linux OS information of the VM." + } + } + }, + "DataDiskProperties": { + "description": "Request body for adding a new or existing data disk to a virtual machine.", + "type": "object", + "properties": { + "attachNewDataDiskOptions": { + "$ref": "#/definitions/AttachNewDataDiskOptions", + "description": "Specifies options to attach a new disk to the virtual machine." + }, + "existingLabDiskId": { + "description": "Specifies the existing lab disk id to attach to virtual machine.", + "type": "string" + }, + "hostCaching": { + "description": "Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).", + "enum": [ "None", "ReadOnly", "ReadWrite" ], + "type": "string", + "x-ms-enum": { + "name": "HostCachingOptions", + "modelAsString": true + } + } + } + }, + "DataDiskPropertiesFragment": { + "description": "Request body for adding a new or existing data disk to a virtual machine.", + "type": "object", + "properties": { + "attachNewDataDiskOptions": { + "$ref": "#/definitions/AttachNewDataDiskOptionsFragment", + "description": "Specifies options to attach a new disk to the virtual machine." + }, + "existingLabDiskId": { + "description": "Specifies the existing lab disk id to attach to virtual machine.", + "type": "string" + }, + "hostCaching": { + "description": "Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).", + "enum": [ "None", "ReadOnly", "ReadWrite" ], + "type": "string", + "x-ms-enum": { + "name": "HostCachingOptions", + "modelAsString": true + } + } + } + }, + "DataDiskStorageTypeInfo": { + "description": "Storage information about the data disks present in the custom image", + "type": "object", + "properties": { + "lun": { + "description": "Disk Lun", + "type": "string" + }, + "storageType": { + "description": "Disk Storage Type", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + } + }, + "DataDiskStorageTypeInfoFragment": { + "description": "Storage information about the data disks present in the custom image", + "type": "object", + "properties": { + "lun": { + "description": "Disk Lun", + "type": "string" + }, + "storageType": { + "description": "Disk Storage Type", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + } + } + }, + "DayDetails": { + "description": "Properties of a daily schedule.", + "type": "object", + "properties": { + "time": { + "description": "The time of day the schedule will occur.", + "type": "string" + } + } + }, + "DayDetailsFragment": { + "description": "Properties of a daily schedule.", + "type": "object", + "properties": { + "time": { + "description": "The time of day the schedule will occur.", + "type": "string" + } + } + }, + "DetachDataDiskProperties": { + "description": "Request body for detaching data disk from a virtual machine.", + "type": "object", + "properties": { + "existingLabDiskId": { + "description": "Specifies the disk resource ID to detach from virtual machine.", + "type": "string" + } + } + }, + "DetachDiskProperties": { + "description": "Properties of the disk to detach.", + "type": "object", + "properties": { + "leasedByLabVmId": { + "description": "The resource ID of the Lab VM to which the disk is attached.", + "type": "string" + } + } + }, + "Disk": { + "description": "A Disk.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/DiskProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DiskFragment": { + "description": "A Disk.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/DiskPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DiskList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Disk" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "DiskProperties": { + "description": "Properties of a disk.", + "type": "object", + "properties": { + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "diskSizeGiB": { + "format": "int32", + "description": "The size of the disk in GibiBytes.", + "type": "integer" + }, + "leasedByLabVmId": { + "description": "The resource ID of the VM to which this disk is leased.", + "type": "string" + }, + "diskBlobName": { + "description": "When backed by a blob, the name of the VHD blob without extension.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the disk.", + "type": "string", + "readOnly": true + }, + "hostCaching": { + "description": "The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "DiskPropertiesFragment": { + "description": "Properties of a disk.", + "type": "object", + "properties": { + "diskType": { + "description": "The storage type for the disk (i.e. Standard, Premium).", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "diskSizeGiB": { + "format": "int32", + "description": "The size of the disk in GibiBytes.", + "type": "integer" + }, + "leasedByLabVmId": { + "description": "The resource ID of the VM to which this disk is leased.", + "type": "string" + }, + "diskBlobName": { + "description": "When backed by a blob, the name of the VHD blob without extension.", + "type": "string" + }, + "diskUri": { + "description": "When backed by a blob, the URI of underlying blob.", + "type": "string" + }, + "hostCaching": { + "description": "The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).", + "type": "string" + }, + "managedDiskId": { + "description": "When backed by managed disk, this is the ID of the compute disk resource.", + "type": "string" + } + } + }, + "DtlEnvironment": { + "description": "An environment, which is essentially an ARM template deployment.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DtlEnvironmentFragment": { + "description": "An environment, which is essentially an ARM template deployment.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DtlEnvironmentList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/DtlEnvironment" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "EnvironmentDeploymentProperties": { + "description": "Properties of an environment deployment.", + "type": "object", + "properties": { + "armTemplateId": { + "description": "The Azure Resource Manager template's identifier.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the Azure Resource Manager template.", + "type": "array", + "items": { "$ref": "#/definitions/ArmTemplateParameterProperties" } + } + } + }, + "EnvironmentDeploymentPropertiesFragment": { + "description": "Properties of an environment deployment.", + "type": "object", + "properties": { + "armTemplateId": { + "description": "The Azure Resource Manager template's identifier.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the Azure Resource Manager template.", + "type": "array", + "items": { "$ref": "#/definitions/ArmTemplateParameterPropertiesFragment" } + } + } + }, + "EnvironmentProperties": { + "description": "Properties of an environment.", + "type": "object", + "properties": { + "deploymentProperties": { + "$ref": "#/definitions/EnvironmentDeploymentProperties", + "description": "The deployment properties of the environment." + }, + "armTemplateDisplayName": { + "description": "The display name of the Azure Resource Manager template that produced the environment.", + "type": "string" + }, + "resourceGroupId": { + "description": "The identifier of the resource group containing the environment's resources.", + "type": "string", + "readOnly": true + }, + "createdByUser": { + "description": "The creator of the environment.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentPropertiesFragment": { + "description": "Properties of an environment.", + "type": "object", + "properties": { + "deploymentProperties": { + "$ref": "#/definitions/EnvironmentDeploymentPropertiesFragment", + "description": "The deployment properties of the environment." + }, + "armTemplateDisplayName": { + "description": "The display name of the Azure Resource Manager template that produced the environment.", + "type": "string" + } + } + }, + "EvaluatePoliciesProperties": { + "description": "Properties for evaluating a policy set.", + "type": "object", + "properties": { + "factName": { + "description": "The fact name.", + "type": "string" + }, + "factData": { + "description": "The fact data.", + "type": "string" + }, + "valueOffset": { + "description": "The value offset.", + "type": "string" + }, + "userObjectId": { + "description": "The user for which policies will be evaluated", + "type": "string" + } + } + }, + "EvaluatePoliciesRequest": { + "description": "Request body for evaluating a policy set.", + "type": "object", + "properties": { + "policies": { + "description": "Policies to evaluate.", + "type": "array", + "items": { "$ref": "#/definitions/EvaluatePoliciesProperties" } + } + } + }, + "EvaluatePoliciesResponse": { + "description": "Response body for evaluating a policy set.", + "type": "object", + "properties": { + "results": { + "description": "Results of evaluating a policy set.", + "type": "array", + "items": { "$ref": "#/definitions/PolicySetResult" } + } + } + }, + "Event": { + "description": "An event to be notified for.", + "type": "object", + "properties": { + "eventName": { + "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + } + } + }, + "EventFragment": { + "description": "An event to be notified for.", + "type": "object", + "properties": { + "eventName": { + "description": "The event type for which this notification is enabled (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + } + } + }, + "ExportResourceUsageParameters": { + "description": "The parameters of the export operation.", + "type": "object", + "properties": { + "blobStorageAbsoluteSasUri": { + "description": "The blob storage absolute sas uri with write permission to the container which the usage data needs to be uploaded to.", + "type": "string" + }, + "usageStartDate": { + "format": "date-time", + "description": "The start time of the usage. If not provided, usage will be reported since the beginning of data collection.", + "type": "string" + } + } + }, + "ExternalSubnet": { + "description": "Subnet information as returned by the Microsoft.Network API.", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string" + } + } + }, + "ExternalSubnetFragment": { + "description": "Subnet information as returned by the Microsoft.Network API.", + "type": "object", + "properties": { + "id": { + "description": "Gets or sets the identifier.", + "type": "string" + }, + "name": { + "description": "Gets or sets the name.", + "type": "string" + } + } + }, + "Formula": { + "description": "A formula for creating a VM, specifying an image base and other parameters", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/FormulaProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "FormulaFragment": { + "description": "A formula for creating a VM, specifying an image base and other parameters", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/FormulaPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "FormulaList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Formula" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "FormulaProperties": { + "description": "Properties of a formula.", + "type": "object", + "properties": { + "description": { + "description": "The description of the formula.", + "type": "string" + }, + "author": { + "description": "The author of the formula.", + "type": "string" + }, + "osType": { + "description": "The OS type of the formula.", + "type": "string" + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of the formula.", + "type": "string", + "readOnly": true + }, + "formulaContent": { + "$ref": "#/definitions/LabVirtualMachineCreationParameter", + "description": "The content of the formula." + }, + "vm": { + "$ref": "#/definitions/FormulaPropertiesFromVm", + "description": "Information about a VM from which a formula is to be created." + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "FormulaPropertiesFragment": { + "description": "Properties of a formula.", + "type": "object", + "properties": { + "description": { + "description": "The description of the formula.", + "type": "string" + }, + "author": { + "description": "The author of the formula.", + "type": "string" + }, + "osType": { + "description": "The OS type of the formula.", + "type": "string" + }, + "formulaContent": { + "$ref": "#/definitions/LabVirtualMachineCreationParameterFragment", + "description": "The content of the formula." + }, + "vm": { + "$ref": "#/definitions/FormulaPropertiesFromVmFragment", + "description": "Information about a VM from which a formula is to be created." + } + } + }, + "FormulaPropertiesFromVm": { + "description": "Information about a VM from which a formula is to be created.", + "type": "object", + "properties": { + "labVmId": { + "description": "The identifier of the VM from which a formula is to be created.", + "type": "string" + } + } + }, + "FormulaPropertiesFromVmFragment": { + "description": "Information about a VM from which a formula is to be created.", + "type": "object", + "properties": { + "labVmId": { + "description": "The identifier of the VM from which a formula is to be created.", + "type": "string" + } + } + }, + "GalleryImage": { + "description": "A gallery image.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/GalleryImage" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "GalleryImageProperties": { + "description": "Properties of a gallery image.", + "type": "object", + "properties": { + "author": { + "description": "The author of the gallery image.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the gallery image.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the gallery image.", + "type": "string" + }, + "imageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The image reference of the gallery image." + }, + "icon": { + "description": "The icon of the gallery image.", + "type": "string" + }, + "enabled": { + "description": "Indicates whether this gallery image is enabled.", + "type": "boolean" + }, + "planId": { + "description": "The third party plan that applies to this image", + "type": "string" + }, + "isPlanAuthorized": { + "description": "Indicates if the plan has been authorized for programmatic deployment.", + "type": "boolean" + } + } + }, + "GalleryImageReference": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GalleryImageReferenceFragment": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GenerateArmTemplateRequest": { + "description": "Parameters for generating an ARM template for deploying artifacts.", + "type": "object", + "properties": { + "virtualMachineName": { + "description": "The resource name of the virtual machine.", + "type": "string" + }, + "parameters": { + "description": "The parameters of the ARM template.", + "type": "array", + "items": { "$ref": "#/definitions/ParameterInfo" } + }, + "location": { + "description": "The location of the virtual machine.", + "type": "string" + }, + "fileUploadOptions": { + "description": "Options for uploading the files for the artifact. UploadFilesAndGenerateSasTokens is the default value.", + "enum": [ "UploadFilesAndGenerateSasTokens", "None" ], + "type": "string", + "x-ms-enum": { + "name": "FileUploadOptions", + "modelAsString": true + } + } + } + }, + "GenerateUploadUriParameter": { + "description": "Properties for generating an upload URI.", + "type": "object", + "properties": { + "blobName": { + "description": "The blob name of the upload URI.", + "type": "string" + } + } + }, + "GenerateUploadUriResponse": { + "description": "Reponse body for generating an upload URI.", + "type": "object", + "properties": { + "uploadUri": { + "description": "The upload URI for the VHD.", + "type": "string" + } + } + }, + "HourDetails": { + "description": "Properties of an hourly schedule.", + "type": "object", + "properties": { + "minute": { + "format": "int32", + "description": "Minutes of the hour the schedule will run.", + "type": "integer" + } + } + }, + "HourDetailsFragment": { + "description": "Properties of an hourly schedule.", + "type": "object", + "properties": { + "minute": { + "format": "int32", + "description": "Minutes of the hour the schedule will run.", + "type": "integer" + } + } + }, + "IdentityProperties": { + "description": "Properties of a managed identity", + "type": "object", + "properties": { + "type": { + "description": "Managed identity.", + "type": "string" + }, + "principalId": { + "description": "The principal id of resource identity.", + "type": "string" + }, + "tenantId": { + "description": "The tenant identifier of resource.", + "type": "string" + }, + "clientSecretUrl": { + "description": "The client secret URL of the identity.", + "type": "string" + } + } + }, + "ImportLabVirtualMachineRequest": { + "description": "This represents the payload required to import a virtual machine from a different lab into the current one", + "type": "object", + "properties": { + "sourceVirtualMachineResourceId": { + "description": "The full resource ID of the virtual machine to be imported.", + "type": "string" + }, + "destinationVirtualMachineName": { + "description": "The name of the virtual machine in the destination lab", + "type": "string" + } + } + }, + "InboundNatRule": { + "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "The transport protocol for the endpoint.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "frontendPort": { + "format": "int32", + "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", + "type": "integer" + }, + "backendPort": { + "format": "int32", + "description": "The port to which the external traffic will be redirected.", + "type": "integer" + } + } + }, + "InboundNatRuleFragment": { + "description": "A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "The transport protocol for the endpoint.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "frontendPort": { + "format": "int32", + "description": "The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.", + "type": "integer" + }, + "backendPort": { + "format": "int32", + "description": "The port to which the external traffic will be redirected.", + "type": "integer" + } + } + }, + "Lab": { + "description": "A lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabAnnouncementProperties": { + "description": "Properties of a lab's announcement banner", + "type": "object", + "properties": { + "title": { + "description": "The plain text title for the lab announcement", + "type": "string" + }, + "markdown": { + "description": "The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.", + "type": "string" + }, + "enabled": { + "description": "Is the lab announcement active/enabled at this time?", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "expirationDate": { + "format": "date-time", + "description": "The time at which the announcement expires (null for never)", + "type": "string" + }, + "expired": { + "description": "Has this announcement expired?", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "LabAnnouncementPropertiesFragment": { + "description": "Properties of a lab's announcement banner", + "type": "object", + "properties": { + "title": { + "description": "The plain text title for the lab announcement", + "type": "string" + }, + "markdown": { + "description": "The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.", + "type": "string" + }, + "enabled": { + "description": "Is the lab announcement active/enabled at this time?", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "expirationDate": { + "format": "date-time", + "description": "The time at which the announcement expires (null for never)", + "type": "string" + }, + "expired": { + "description": "Has this announcement expired?", + "type": "boolean" + } + } + }, + "LabCost": { + "description": "A cost item.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabCostProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabCostDetailsProperties": { + "description": "The properties of a lab cost item.", + "type": "object", + "properties": { + "date": { + "format": "date-time", + "description": "The date of the cost item.", + "type": "string" + }, + "cost": { + "format": "double", + "description": "The cost component of the cost item.", + "type": "number" + }, + "costType": { + "description": "The type of the cost.", + "enum": [ "Unavailable", "Reported", "Projected" ], + "type": "string", + "x-ms-enum": { + "name": "CostType", + "modelAsString": true + } + } + } + }, + "LabCostProperties": { + "description": "Properties of a cost item.", + "type": "object", + "properties": { + "targetCost": { + "$ref": "#/definitions/TargetCostProperties", + "description": "The target cost properties" + }, + "labCostSummary": { + "$ref": "#/definitions/LabCostSummaryProperties", + "description": "The lab cost summary component of the cost data.", + "readOnly": true + }, + "labCostDetails": { + "description": "The lab cost details component of the cost data.", + "type": "array", + "items": { "$ref": "#/definitions/LabCostDetailsProperties" }, + "readOnly": true + }, + "resourceCosts": { + "description": "The resource cost component of the cost data.", + "type": "array", + "items": { "$ref": "#/definitions/LabResourceCostProperties" }, + "readOnly": true + }, + "currencyCode": { + "description": "The currency code of the cost.", + "type": "string" + }, + "startDateTime": { + "format": "date-time", + "description": "The start time of the cost data.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "The end time of the cost data.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the cost.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "LabCostSummaryProperties": { + "description": "The properties of the cost summary.", + "type": "object", + "properties": { + "estimatedLabCost": { + "format": "double", + "description": "The cost component of the cost item.", + "type": "number" + } + } + }, + "LabFragment": { + "description": "A lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Lab" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "LabProperties": { + "description": "Properties of a lab.", + "type": "object", + "properties": { + "defaultStorageAccount": { + "description": "The lab's default storage account.", + "type": "string", + "readOnly": true + }, + "defaultPremiumStorageAccount": { + "description": "The lab's default premium storage account.", + "type": "string", + "readOnly": true + }, + "artifactsStorageAccount": { + "description": "The lab's artifact storage account.", + "type": "string", + "readOnly": true + }, + "premiumDataDiskStorageAccount": { + "description": "The lab's premium data disk storage account.", + "type": "string", + "readOnly": true + }, + "vaultName": { + "description": "The lab's Key vault.", + "type": "string", + "readOnly": true + }, + "labStorageType": { + "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "mandatoryArtifactsResourceIdsLinux": { + "description": "The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.", + "type": "array", + "items": { "type": "string" } + }, + "mandatoryArtifactsResourceIdsWindows": { + "description": "The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.", + "type": "array", + "items": { "type": "string" } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the lab.", + "type": "string", + "readOnly": true + }, + "premiumDataDisks": { + "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "PremiumDataDisk", + "modelAsString": true + } + }, + "environmentPermission": { + "description": "The access rights to be granted to the user when provisioning an environment", + "enum": [ "Reader", "Contributor" ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentPermission", + "modelAsString": true + } + }, + "announcement": { + "$ref": "#/definitions/LabAnnouncementProperties", + "description": "The properties of any lab announcement associated with this lab" + }, + "support": { + "$ref": "#/definitions/LabSupportProperties", + "description": "The properties of any lab support message associated with this lab" + }, + "vmCreationResourceGroup": { + "description": "The resource group in which lab virtual machines will be created in.", + "type": "string", + "readOnly": true + }, + "publicIpId": { + "description": "The public IP address for the lab's load balancer.", + "type": "string", + "readOnly": true + }, + "loadBalancerId": { + "description": "The load balancer used to for lab VMs that use shared IP address.", + "type": "string", + "readOnly": true + }, + "networkSecurityGroupId": { + "description": "The Network Security Group attached to the lab VMs Network interfaces to restrict open ports.", + "type": "string", + "readOnly": true + }, + "extendedProperties": { + "description": "Extended properties of the lab used for experimental features", + "type": "object", + "additionalProperties": { "type": "string" } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "LabPropertiesFragment": { + "description": "Properties of a lab.", + "type": "object", + "properties": { + "labStorageType": { + "description": "Type of storage used by the lab. It can be either Premium or Standard. Default is Premium.", + "enum": [ "Standard", "Premium" ], + "type": "string", + "x-ms-enum": { + "name": "StorageType", + "modelAsString": true + } + }, + "mandatoryArtifactsResourceIdsLinux": { + "description": "The ordered list of artifact resource IDs that should be applied on all Linux VM creations by default, prior to the artifacts specified by the user.", + "type": "array", + "items": { "type": "string" } + }, + "mandatoryArtifactsResourceIdsWindows": { + "description": "The ordered list of artifact resource IDs that should be applied on all Windows VM creations by default, prior to the artifacts specified by the user.", + "type": "array", + "items": { "type": "string" } + }, + "premiumDataDisks": { + "description": "The setting to enable usage of premium data disks.\r\nWhen its value is 'Enabled', creation of standard or premium data disks is allowed.\r\nWhen its value is 'Disabled', only creation of standard data disks is allowed.", + "enum": [ "Disabled", "Enabled" ], + "type": "string", + "x-ms-enum": { + "name": "PremiumDataDisk", + "modelAsString": true + } + }, + "environmentPermission": { + "description": "The access rights to be granted to the user when provisioning an environment", + "enum": [ "Reader", "Contributor" ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentPermission", + "modelAsString": true + } + }, + "announcement": { + "$ref": "#/definitions/LabAnnouncementPropertiesFragment", + "description": "The properties of any lab announcement associated with this lab" + }, + "support": { + "$ref": "#/definitions/LabSupportPropertiesFragment", + "description": "The properties of any lab support message associated with this lab" + }, + "extendedProperties": { + "description": "Extended properties of the lab used for experimental features", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "LabResourceCostProperties": { + "description": "The properties of a resource cost item.", + "type": "object", + "properties": { + "resourcename": { + "description": "The name of the resource.", + "type": "string" + }, + "resourceUId": { + "description": "The unique identifier of the resource.", + "type": "string" + }, + "resourceCost": { + "format": "double", + "description": "The cost component of the resource cost item.", + "type": "number" + }, + "resourceType": { + "description": "The logical resource type (ex. virtualmachine, storageaccount)", + "type": "string" + }, + "resourceOwner": { + "description": "The owner of the resource (ex. janedoe@microsoft.com)", + "type": "string" + }, + "resourcePricingTier": { + "description": "The category of the resource (ex. Premium_LRS, Standard_DS1)", + "type": "string" + }, + "resourceStatus": { + "description": "The status of the resource (ex. Active)", + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource", + "type": "string" + }, + "externalResourceId": { + "description": "The ID of the external resource", + "type": "string" + } + } + }, + "LabSupportProperties": { + "description": "Properties of a lab's support banner", + "type": "object", + "properties": { + "enabled": { + "description": "Is the lab support banner active/enabled at this time?", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "markdown": { + "description": "The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.", + "type": "string" + } + } + }, + "LabSupportPropertiesFragment": { + "description": "Properties of a lab's support banner", + "type": "object", + "properties": { + "enabled": { + "description": "Is the lab support banner active/enabled at this time?", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "markdown": { + "description": "The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown.", + "type": "string" + } + } + }, + "LabVhd": { + "description": "Properties of a VHD in the lab.", + "type": "object", + "properties": { + "id": { + "description": "The URI to the VHD.", + "type": "string" + } + } + }, + "LabVhdList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/LabVhd" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "LabVirtualMachine": { + "description": "A virtual machine.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachineProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabVirtualMachineCreationParameter": { + "description": "Properties for creating a virtual machine.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachineCreationParameterProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + }, + "name": { + "description": "The name of the virtual machine or environment", + "type": "string" + }, + "location": { + "description": "The location of the new virtual machine or environment", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "LabVirtualMachineCreationParameterFragment": { + "description": "Properties for creating a virtual machine.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachineCreationParameterPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + }, + "name": { + "description": "The name of the virtual machine or environment", + "type": "string" + }, + "location": { + "description": "The location of the new virtual machine or environment", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "LabVirtualMachineCreationParameterProperties": { + "description": "Properties for virtual machine creation.", + "type": "object", + "properties": { + "bulkCreationParameters": { + "$ref": "#/definitions/BulkCreationParameters", + "description": "The number of virtual machine instances to create." + }, + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "computeId": { + "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusProperties", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "planId": { + "description": "The id of the plan associated with the virtual machine image", + "type": "string" + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The network interface properties." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "dataDiskParameters": { + "description": "New or existing data disks to attach to the virtual machine after creation", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskProperties" } + }, + "scheduleParameters": { + "description": "Virtual Machine schedules to be created", + "type": "array", + "items": { "$ref": "#/definitions/ScheduleCreationParameter" } + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string" + } + } + }, + "LabVirtualMachineCreationParameterPropertiesFragment": { + "description": "Properties for virtual machine creation.", + "type": "object", + "properties": { + "bulkCreationParameters": { + "$ref": "#/definitions/BulkCreationParametersFragment", + "description": "The number of virtual machine instances to create." + }, + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "computeId": { + "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallPropertiesFragment" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusPropertiesFragment", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReferenceFragment", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "planId": { + "description": "The id of the plan associated with the virtual machine image", + "type": "string" + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfacePropertiesFragment", + "description": "The network interface properties." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "dataDiskParameters": { + "description": "New or existing data disks to attach to the virtual machine after creation", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskPropertiesFragment" } + }, + "scheduleParameters": { + "description": "Virtual Machine schedules to be created", + "type": "array", + "items": { "$ref": "#/definitions/ScheduleCreationParameterFragment" } + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string" + } + } + }, + "LabVirtualMachineFragment": { + "description": "A virtual machine.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabVirtualMachinePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabVirtualMachineList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/LabVirtualMachine" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "LabVirtualMachineProperties": { + "description": "Properties of a virtual machine.", + "type": "object", + "properties": { + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "computeId": { + "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallProperties" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusProperties", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "planId": { + "description": "The id of the plan associated with the virtual machine image", + "type": "string" + }, + "computeVm": { + "$ref": "#/definitions/ComputeVmProperties", + "description": "The compute virtual machine properties.", + "readOnly": true + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfaceProperties", + "description": "The network interface properties." + }, + "applicableSchedule": { + "$ref": "#/definitions/ApplicableSchedule", + "description": "The applicable schedule for the virtual machine.", + "readOnly": true + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "dataDiskParameters": { + "description": "New or existing data disks to attach to the virtual machine after creation", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskProperties" } + }, + "scheduleParameters": { + "description": "Virtual Machine schedules to be created", + "type": "array", + "items": { "$ref": "#/definitions/ScheduleCreationParameter" } + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "LabVirtualMachinePropertiesFragment": { + "description": "Properties of a virtual machine.", + "type": "object", + "properties": { + "notes": { + "description": "The notes of the virtual machine.", + "type": "string" + }, + "ownerObjectId": { + "description": "The object identifier of the owner of the virtual machine.", + "type": "string" + }, + "ownerUserPrincipalName": { + "description": "The user principal name of the virtual machine owner.", + "type": "string" + }, + "createdByUserId": { + "description": "The object identifier of the creator of the virtual machine.", + "type": "string" + }, + "createdByUser": { + "description": "The email address of creator of the virtual machine.", + "type": "string" + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual machine.", + "type": "string" + }, + "computeId": { + "description": "The resource identifier (Microsoft.Compute) of the virtual machine.", + "type": "string" + }, + "customImageId": { + "description": "The custom image identifier of the virtual machine.", + "type": "string" + }, + "osType": { + "description": "The OS type of the virtual machine.", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine.", + "type": "string" + }, + "userName": { + "description": "The user name of the virtual machine.", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine administrator.", + "type": "string" + }, + "sshKey": { + "description": "The SSH key of the virtual machine administrator.", + "type": "string" + }, + "isAuthenticationWithSshKey": { + "description": "Indicates whether this virtual machine uses an SSH key for authentication.", + "type": "boolean" + }, + "fqdn": { + "description": "The fully-qualified domain name of the virtual machine.", + "type": "string" + }, + "labSubnetName": { + "description": "The lab subnet name of the virtual machine.", + "type": "string" + }, + "labVirtualNetworkId": { + "description": "The lab virtual network identifier of the virtual machine.", + "type": "string" + }, + "disallowPublicIpAddress": { + "description": "Indicates whether the virtual machine is to be created without a public IP address.", + "type": "boolean" + }, + "artifacts": { + "description": "The artifacts to be installed on the virtual machine.", + "type": "array", + "items": { "$ref": "#/definitions/ArtifactInstallPropertiesFragment" } + }, + "artifactDeploymentStatus": { + "$ref": "#/definitions/ArtifactDeploymentStatusPropertiesFragment", + "description": "The artifact deployment status for the virtual machine." + }, + "galleryImageReference": { + "$ref": "#/definitions/GalleryImageReferenceFragment", + "description": "The Microsoft Azure Marketplace image reference of the virtual machine." + }, + "planId": { + "description": "The id of the plan associated with the virtual machine image", + "type": "string" + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterfacePropertiesFragment", + "description": "The network interface properties." + }, + "expirationDate": { + "format": "date-time", + "description": "The expiration date for VM.", + "type": "string" + }, + "allowClaim": { + "description": "Indicates whether another user can take ownership of the virtual machine", + "type": "boolean" + }, + "storageType": { + "description": "Storage type to use for virtual machine (i.e. Standard, Premium).", + "type": "string" + }, + "virtualMachineCreationSource": { + "description": "Tells source of creation of lab virtual machine. Output property only.", + "enum": [ "FromCustomImage", "FromGalleryImage" ], + "type": "string", + "x-ms-enum": { + "name": "VirtualMachineCreationSource", + "modelAsString": true + } + }, + "environmentId": { + "description": "The resource ID of the environment that contains this virtual machine, if any.", + "type": "string" + }, + "dataDiskParameters": { + "description": "New or existing data disks to attach to the virtual machine after creation", + "type": "array", + "items": { "$ref": "#/definitions/DataDiskPropertiesFragment" } + }, + "scheduleParameters": { + "description": "Virtual Machine schedules to be created", + "type": "array", + "items": { "$ref": "#/definitions/ScheduleCreationParameterFragment" } + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string" + } + } + }, + "LinuxOsInfo": { + "description": "Information about a Linux OS.", + "type": "object", + "properties": { + "linuxOsState": { + "description": "The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).", + "enum": [ "NonDeprovisioned", "DeprovisionRequested", "DeprovisionApplied" ], + "type": "string", + "x-ms-enum": { + "name": "LinuxOsState", + "modelAsString": true + } + } + } + }, + "LinuxOsInfoFragment": { + "description": "Information about a Linux OS.", + "type": "object", + "properties": { + "linuxOsState": { + "description": "The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied).", + "enum": [ "NonDeprovisioned", "DeprovisionRequested", "DeprovisionApplied" ], + "type": "string", + "x-ms-enum": { + "name": "LinuxOsState", + "modelAsString": true + } + } + } + }, + "NetworkInterfaceProperties": { + "description": "Properties of a network interface.", + "type": "object", + "properties": { + "virtualNetworkId": { + "description": "The resource ID of the virtual network.", + "type": "string" + }, + "subnetId": { + "description": "The resource ID of the sub net.", + "type": "string" + }, + "publicIpAddressId": { + "description": "The resource ID of the public IP address.", + "type": "string" + }, + "publicIpAddress": { + "description": "The public IP address.", + "type": "string" + }, + "privateIpAddress": { + "description": "The private IP address.", + "type": "string" + }, + "dnsName": { + "description": "The DNS name.", + "type": "string" + }, + "rdpAuthority": { + "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", + "type": "string" + }, + "sshAuthority": { + "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", + "type": "string" + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SharedPublicIpAddressConfiguration", + "description": "The configuration for sharing a public IP address across multiple virtual machines." + } + } + }, + "NetworkInterfacePropertiesFragment": { + "description": "Properties of a network interface.", + "type": "object", + "properties": { + "virtualNetworkId": { + "description": "The resource ID of the virtual network.", + "type": "string" + }, + "subnetId": { + "description": "The resource ID of the sub net.", + "type": "string" + }, + "publicIpAddressId": { + "description": "The resource ID of the public IP address.", + "type": "string" + }, + "publicIpAddress": { + "description": "The public IP address.", + "type": "string" + }, + "privateIpAddress": { + "description": "The private IP address.", + "type": "string" + }, + "dnsName": { + "description": "The DNS name.", + "type": "string" + }, + "rdpAuthority": { + "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", + "type": "string" + }, + "sshAuthority": { + "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", + "type": "string" + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SharedPublicIpAddressConfigurationFragment", + "description": "The configuration for sharing a public IP address across multiple virtual machines." + } + } + }, + "NotificationChannel": { + "description": "A notification.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NotificationChannelProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "NotificationChannelFragment": { + "description": "A notification.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/NotificationChannelPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "NotificationChannelList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/NotificationChannel" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "NotificationChannelProperties": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "webHookUrl": { + "description": "The webhook URL to send notifications to.", + "type": "string" + }, + "emailRecipient": { + "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "type": "string" + }, + "notificationLocale": { + "description": "The locale to use when sending a notification (fallback for unsupported languages is EN).", + "type": "string" + }, + "description": { + "description": "Description of notification.", + "type": "string" + }, + "events": { + "description": "The list of event for which this notification is enabled.", + "type": "array", + "items": { "$ref": "#/definitions/Event" } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the notification channel.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "NotificationChannelPropertiesFragment": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "webHookUrl": { + "description": "The webhook URL to send notifications to.", + "type": "string" + }, + "emailRecipient": { + "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "type": "string" + }, + "notificationLocale": { + "description": "The locale to use when sending a notification (fallback for unsupported languages is EN).", + "type": "string" + }, + "description": { + "description": "Description of notification.", + "type": "string" + }, + "events": { + "description": "The list of event for which this notification is enabled.", + "type": "array", + "items": { "$ref": "#/definitions/EventFragment" } + } + } + }, + "NotificationSettings": { + "description": "Notification settings for a schedule.", + "type": "object", + "properties": { + "status": { + "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "timeInMinutes": { + "format": "int32", + "description": "Time in minutes before event at which notification will be sent.", + "type": "integer" + }, + "webhookUrl": { + "description": "The webhook URL to which the notification will be sent.", + "type": "string" + }, + "emailRecipient": { + "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "type": "string" + }, + "notificationLocale": { + "description": "The locale to use when sending a notification (fallback for unsupported languages is EN).", + "type": "string" + } + } + }, + "NotificationSettingsFragment": { + "description": "Notification settings for a schedule.", + "type": "object", + "properties": { + "status": { + "description": "If notifications are enabled for this schedule (i.e. Enabled, Disabled).", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "timeInMinutes": { + "format": "int32", + "description": "Time in minutes before event at which notification will be sent.", + "type": "integer" + }, + "webhookUrl": { + "description": "The webhook URL to which the notification will be sent.", + "type": "string" + }, + "emailRecipient": { + "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "type": "string" + }, + "notificationLocale": { + "description": "The locale to use when sending a notification (fallback for unsupported languages is EN).", + "type": "string" + } + } + }, + "NotifyParameters": { + "description": "Properties for generating a Notification.", + "type": "object", + "properties": { + "eventName": { + "description": "The type of event (i.e. AutoShutdown, Cost)", + "enum": [ "AutoShutdown", "Cost" ], + "type": "string", + "x-ms-enum": { + "name": "NotificationChannelEventType", + "modelAsString": true + } + }, + "jsonPayload": { + "description": "Properties for the notification in json format.", + "type": "string" + } + } + }, + "OperationError": { + "description": "Error details for the operation in case of a failure.", + "type": "object", + "properties": { + "code": { + "description": "The error code of the operation error.", + "type": "string" + }, + "message": { + "description": "The error message of the operation error.", + "type": "string" + } + } + }, + "OperationMetadata": { + "description": "The REST API operation supported by DevTestLab ResourceProvider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationMetadataDisplay", + "description": "The object that describes the operations" + } + } + }, + "OperationMetadataDisplay": { + "description": "The object that describes the operations", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + }, + "OperationResult": { + "description": "An Operation Result", + "type": "object", + "properties": { + "status": { + "description": "The operation status.", + "type": "string" + }, + "statusCode": { + "description": "The status code for the operation.", + "enum": [ "Continue", "SwitchingProtocols", "OK", "Created", "Accepted", "NonAuthoritativeInformation", "NoContent", "ResetContent", "PartialContent", "MultipleChoices", "MovedPermanently", "Redirect", "SeeOther", "NotModified", "UseProxy", "Unused", "TemporaryRedirect", "BadRequest", "Unauthorized", "PaymentRequired", "Forbidden", "NotFound", "MethodNotAllowed", "NotAcceptable", "ProxyAuthenticationRequired", "RequestTimeout", "Conflict", "Gone", "LengthRequired", "PreconditionFailed", "RequestEntityTooLarge", "RequestUriTooLong", "UnsupportedMediaType", "RequestedRangeNotSatisfiable", "ExpectationFailed", "UpgradeRequired", "InternalServerError", "NotImplemented", "BadGateway", "ServiceUnavailable", "GatewayTimeout", "HttpVersionNotSupported" ], + "type": "string", + "x-ms-enum": { + "name": "HttpStatusCode", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/OperationError", + "description": "Error details for the operation in case of a failure." + } + } + }, + "ParameterInfo": { + "description": "Information about an artifact's parameter.", + "type": "object", + "properties": { + "name": { + "description": "The name of the artifact parameter.", + "type": "string" + }, + "value": { + "description": "The value of the artifact parameter.", + "type": "string" + } + } + }, + "ParametersValueFileInfo": { + "description": "A file containing a set of parameter values for an ARM template.", + "type": "object", + "properties": { + "fileName": { + "description": "File name.", + "type": "string" + }, + "parametersValueInfo": { + "description": "Contents of the file.", + "type": "object" + } + } + }, + "PercentageCostThresholdProperties": { + "description": "Properties of a percentage cost threshold.", + "type": "object", + "properties": { + "thresholdValue": { + "format": "double", + "description": "The cost threshold value.", + "type": "number" + } + } + }, + "Policy": { + "description": "A Policy.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "PolicyFragment": { + "description": "A Policy.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/PolicyPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "PolicyList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Policy" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "PolicyProperties": { + "description": "Properties of a Policy.", + "type": "object", + "properties": { + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "status": { + "description": "The status of the policy.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + }, + "factName": { + "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", + "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost", "EnvironmentTemplate", "ScheduleEditPermission" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyFactName", + "modelAsString": true + } + }, + "factData": { + "description": "The fact data of the policy.", + "type": "string" + }, + "threshold": { + "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", + "type": "string" + }, + "evaluatorType": { + "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", + "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyEvaluatorType", + "modelAsString": true + } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the policy.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "PolicyPropertiesFragment": { + "description": "Properties of a Policy.", + "type": "object", + "properties": { + "description": { + "description": "The description of the policy.", + "type": "string" + }, + "status": { + "description": "The status of the policy.", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyStatus", + "modelAsString": true + } + }, + "factName": { + "description": "The fact name of the policy (e.g. LabVmCount, LabVmSize, MaxVmsAllowedPerLab, etc.", + "enum": [ "UserOwnedLabVmCount", "UserOwnedLabPremiumVmCount", "LabVmCount", "LabPremiumVmCount", "LabVmSize", "GalleryImage", "UserOwnedLabVmCountInSubnet", "LabTargetCost", "EnvironmentTemplate", "ScheduleEditPermission" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyFactName", + "modelAsString": true + } + }, + "factData": { + "description": "The fact data of the policy.", + "type": "string" + }, + "threshold": { + "description": "The threshold of the policy (i.e. a number for MaxValuePolicy, and a JSON array of values for AllowedValuesPolicy).", + "type": "string" + }, + "evaluatorType": { + "description": "The evaluator type of the policy (i.e. AllowedValuesPolicy, MaxValuePolicy).", + "enum": [ "AllowedValuesPolicy", "MaxValuePolicy" ], + "type": "string", + "x-ms-enum": { + "name": "PolicyEvaluatorType", + "modelAsString": true + } + } + } + }, + "PolicySetResult": { + "description": "Result of a policy set evaluation.", + "type": "object", + "properties": { + "hasError": { + "description": "A value indicating whether this policy set evaluation has discovered violations.", + "type": "boolean" + }, + "policyViolations": { + "description": "The list of policy violations.", + "type": "array", + "items": { "$ref": "#/definitions/PolicyViolation" } + } + } + }, + "PolicyViolation": { + "description": "Policy violation.", + "type": "object", + "properties": { + "code": { + "description": "The code of the policy violation.", + "type": "string" + }, + "message": { + "description": "The message of the policy violation.", + "type": "string" + } + } + }, + "Port": { + "description": "Properties of a network port.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "Protocol type of the port.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "backendPort": { + "format": "int32", + "description": "Backend port of the target virtual machine.", + "type": "integer" + } + } + }, + "PortFragment": { + "description": "Properties of a network port.", + "type": "object", + "properties": { + "transportProtocol": { + "description": "Protocol type of the port.", + "enum": [ "Tcp", "Udp" ], + "type": "string", + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + }, + "backendPort": { + "format": "int32", + "description": "Backend port of the target virtual machine.", + "type": "integer" + } + } + }, + "ProviderOperationResult": { + "description": "Result of the request to list REST API operations", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { "$ref": "#/definitions/OperationMetadata" } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "RdpConnection": { + "description": "Represents a .rdp file", + "type": "object", + "properties": { + "contents": { + "description": "The contents of the .rdp file", + "type": "string" + } + } + }, + "ResizeLabVirtualMachineProperties": { + "description": "Request body for resizing a virtual machine.", + "type": "object", + "properties": { + "size": { + "description": "Specifies the size of the virtual machine.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + }, + "x-ms-azure-resource": true + }, + "RetargetScheduleProperties": { + "description": "Properties for retargeting a virtual machine schedule.", + "type": "object", + "properties": { + "currentResourceId": { + "description": "The resource Id of the virtual machine on which the schedule operates", + "type": "string" + }, + "targetResourceId": { + "description": "The resource Id of the virtual machine that the schedule should be retargeted to", + "type": "string" + } + } + }, + "Schedule": { + "description": "A schedule.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ScheduleProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ScheduleCreationParameter": { + "description": "Properties for creating a schedule.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduleCreationParameterProperties", + "description": "The properties of the schedule.", + "x-ms-client-flatten": true + }, + "name": { + "description": "The name of the virtual machine or environment", + "type": "string" + }, + "location": { + "description": "The location of the new virtual machine or environment", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "ScheduleCreationParameterFragment": { + "description": "Properties for creating a schedule.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduleCreationParameterPropertiesFragment", + "description": "The properties of the schedule.", + "x-ms-client-flatten": true + }, + "name": { + "description": "The name of the virtual machine or environment", + "type": "string" + }, + "location": { + "description": "The location of the new virtual machine or environment", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "ScheduleCreationParameterProperties": { + "description": "Properties for schedule creation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetails", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetails", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetails", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettings", + "description": "Notification settings." + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + } + } + }, + "ScheduleCreationParameterPropertiesFragment": { + "description": "Properties for schedule creation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetailsFragment", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetailsFragment", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetailsFragment", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettingsFragment", + "description": "Notification settings." + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + } + } + }, + "ScheduleFragment": { + "description": "A schedule.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SchedulePropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ScheduleList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Schedule" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ScheduleProperties": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetails", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetails", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetails", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettings", + "description": "Notification settings." + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the schedule.", + "type": "string", + "readOnly": true + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "SchedulePropertiesFragment": { + "description": "Properties of a schedule.", + "type": "object", + "properties": { + "status": { + "description": "The status of the schedule (i.e. Enabled, Disabled)", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "EnableStatus", + "modelAsString": true + } + }, + "taskType": { + "description": "The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).", + "type": "string" + }, + "weeklyRecurrence": { + "$ref": "#/definitions/WeekDetailsFragment", + "description": "If the schedule will occur only some days of the week, specify the weekly recurrence." + }, + "dailyRecurrence": { + "$ref": "#/definitions/DayDetailsFragment", + "description": "If the schedule will occur once each day of the week, specify the daily recurrence." + }, + "hourlyRecurrence": { + "$ref": "#/definitions/HourDetailsFragment", + "description": "If the schedule will occur multiple times a day, specify the hourly recurrence." + }, + "timeZoneId": { + "description": "The time zone ID (e.g. Pacific Standard time).", + "type": "string" + }, + "notificationSettings": { + "$ref": "#/definitions/NotificationSettingsFragment", + "description": "Notification settings." + }, + "targetResourceId": { + "description": "The resource ID to which the schedule belongs", + "type": "string" + } + } + }, + "Secret": { + "description": "A secret.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SecretProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "SecretFragment": { + "description": "A secret.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/SecretPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "SecretList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Secret" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "SecretProperties": { + "description": "Properties of a secret.", + "type": "object", + "properties": { + "value": { + "description": "The value of the secret for secret creation.", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "SecretPropertiesFragment": { + "description": "Properties of a secret.", + "type": "object", + "properties": { + "value": { + "description": "The value of the secret for secret creation.", + "type": "string" + } + } + }, + "ServiceFabric": { + "description": "A Service Fabric.", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceFabricProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ServiceFabricFragment": { + "description": "A Service Fabric.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceFabricPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "ServiceFabricList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ServiceFabric" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ServiceFabricProperties": { + "description": "Properties of a service fabric.", + "type": "object", + "properties": { + "externalServiceFabricId": { + "description": "The backing service fabric resource's id", + "type": "string" + }, + "environmentId": { + "description": "The resource id of the environment under which the service fabric resource is present", + "type": "string" + }, + "applicableSchedule": { + "$ref": "#/definitions/ApplicableSchedule", + "description": "The applicable schedule for the virtual machine.", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "ServiceFabricPropertiesFragment": { + "description": "Properties of a service fabric.", + "type": "object", + "properties": { + "externalServiceFabricId": { + "description": "The backing service fabric resource's id", + "type": "string" + }, + "environmentId": { + "description": "The resource id of the environment under which the service fabric resource is present", + "type": "string" + } + } + }, + "ServiceRunner": { + "description": "A container for a managed identity to execute DevTest lab services.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "identity": { + "$ref": "#/definitions/IdentityProperties", + "description": "The identity of the resource." + } + } + }, + "ServiceRunnerList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/ServiceRunner" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "SharedPublicIpAddressConfiguration": { + "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", + "type": "object", + "properties": { + "inboundNatRules": { + "description": "The incoming NAT rules", + "type": "array", + "items": { "$ref": "#/definitions/InboundNatRule" } + } + } + }, + "SharedPublicIpAddressConfigurationFragment": { + "description": "Properties of a virtual machine that determine how it is connected to a load balancer.", + "type": "object", + "properties": { + "inboundNatRules": { + "description": "The incoming NAT rules", + "type": "array", + "items": { "$ref": "#/definitions/InboundNatRuleFragment" } + } + } + }, + "ShutdownNotificationContent": { + "description": "The contents of a shutdown notification. Webhooks can use this type to deserialize the request body when they get notified of an imminent shutdown.", + "type": "object", + "properties": { + "skipUrl": { + "description": "The URL to skip auto-shutdown.", + "type": "string" + }, + "delayUrl60": { + "description": "The URL to delay shutdown by 60 minutes.", + "type": "string" + }, + "delayUrl120": { + "description": "The URL to delay shutdown by 2 hours.", + "type": "string" + }, + "vmName": { + "description": "The virtual machine to be shut down.", + "type": "string" + }, + "guid": { + "description": "The GUID for the virtual machine to be shut down.", + "type": "string" + }, + "owner": { + "description": "The owner of the virtual machine.", + "type": "string" + }, + "vmUrl": { + "description": "The URL of the virtual machine.", + "type": "string" + }, + "minutesUntilShutdown": { + "description": "Minutes remaining until shutdown", + "type": "string" + }, + "eventType": { + "description": "The event for which a notification will be sent.", + "type": "string" + }, + "text": { + "description": "The text for the notification.", + "type": "string" + }, + "subscriptionId": { + "description": "The subscription ID for the schedule.", + "type": "string" + }, + "resourceGroupName": { + "description": "The resource group name for the schedule.", + "type": "string" + }, + "labName": { + "description": "The lab for the schedule.", + "type": "string" + } + } + }, + "Subnet": { + "description": "Subnet information.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name of the subnet as seen in the lab.", + "type": "string" + }, + "allowPublicIp": { + "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + } + } + }, + "SubnetFragment": { + "description": "Subnet information.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name of the subnet as seen in the lab.", + "type": "string" + }, + "allowPublicIp": { + "description": "The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + } + } + }, + "SubnetOverride": { + "description": "Property overrides on a subnet of a virtual network.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name given to the subnet within the lab.", + "type": "string" + }, + "useInVmCreationPermission": { + "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "usePublicIpAddressPermission": { + "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SubnetSharedPublicIpAddressConfiguration", + "description": "Properties that virtual machines on this subnet will share." + }, + "virtualNetworkPoolName": { + "description": "The virtual network pool associated with this subnet.", + "type": "string" + } + } + }, + "SubnetOverrideFragment": { + "description": "Property overrides on a subnet of a virtual network.", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource ID of the subnet.", + "type": "string" + }, + "labSubnetName": { + "description": "The name given to the subnet within the lab.", + "type": "string" + }, + "useInVmCreationPermission": { + "description": "Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "usePublicIpAddressPermission": { + "description": "Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny).", + "enum": [ "Default", "Deny", "Allow" ], + "type": "string", + "x-ms-enum": { + "name": "UsagePermissionType", + "modelAsString": true + } + }, + "sharedPublicIpAddressConfiguration": { + "$ref": "#/definitions/SubnetSharedPublicIpAddressConfigurationFragment", + "description": "Properties that virtual machines on this subnet will share." + }, + "virtualNetworkPoolName": { + "description": "The virtual network pool associated with this subnet.", + "type": "string" + } + } + }, + "SubnetSharedPublicIpAddressConfiguration": { + "description": "Configuration for public IP address sharing.", + "type": "object", + "properties": { + "allowedPorts": { + "description": "Backend ports that virtual machines on this subnet are allowed to expose", + "type": "array", + "items": { "$ref": "#/definitions/Port" } + } + } + }, + "SubnetSharedPublicIpAddressConfigurationFragment": { + "description": "Configuration for public IP address sharing.", + "type": "object", + "properties": { + "allowedPorts": { + "description": "Backend ports that virtual machines on this subnet are allowed to expose", + "type": "array", + "items": { "$ref": "#/definitions/PortFragment" } + } + } + }, + "TargetCostProperties": { + "description": "Properties of a cost target.", + "type": "object", + "properties": { + "status": { + "description": "Target cost status", + "enum": [ "Enabled", "Disabled" ], + "type": "string", + "x-ms-enum": { + "name": "TargetCostStatus", + "modelAsString": true + } + }, + "target": { + "format": "int32", + "description": "Lab target cost", + "type": "integer" + }, + "costThresholds": { + "description": "Cost thresholds.", + "type": "array", + "items": { "$ref": "#/definitions/CostThresholdProperties" } + }, + "cycleStartDateTime": { + "format": "date-time", + "description": "Reporting cycle start date.", + "type": "string" + }, + "cycleEndDateTime": { + "format": "date-time", + "description": "Reporting cycle end date.", + "type": "string" + }, + "cycleType": { + "description": "Reporting cycle type.", + "enum": [ "CalendarMonth", "Custom" ], + "type": "string", + "x-ms-enum": { + "name": "ReportingCycleType", + "modelAsString": true + } + } + } + }, + "UpdateResource": { + "description": "Represents an update resource", + "type": "object", + "properties": { + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "User": { + "description": "Profile of a lab user.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "UserFragment": { + "description": "Profile of a lab user.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "UserIdentity": { + "description": "Identity attributes of a lab user.", + "type": "object", + "properties": { + "principalName": { + "description": "Set to the principal name / UPN of the client JWT making the request.", + "type": "string" + }, + "principalId": { + "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", + "type": "string" + }, + "tenantId": { + "description": "Set to the tenant ID of the client JWT making the request.", + "type": "string" + }, + "objectId": { + "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", + "type": "string" + }, + "appId": { + "description": "Set to the app Id of the client JWT making the request.", + "type": "string" + } + } + }, + "UserIdentityFragment": { + "description": "Identity attributes of a lab user.", + "type": "object", + "properties": { + "principalName": { + "description": "Set to the principal name / UPN of the client JWT making the request.", + "type": "string" + }, + "principalId": { + "description": "Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id.", + "type": "string" + }, + "tenantId": { + "description": "Set to the tenant ID of the client JWT making the request.", + "type": "string" + }, + "objectId": { + "description": "Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available.", + "type": "string" + }, + "appId": { + "description": "Set to the app Id of the client JWT making the request.", + "type": "string" + } + } + }, + "UserList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/User" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "UserProperties": { + "description": "Properties of a lab user profile.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/UserIdentity", + "description": "The identity of the user." + }, + "secretStore": { + "$ref": "#/definitions/UserSecretStore", + "description": "The secret store of the user." + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the user profile.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "UserPropertiesFragment": { + "description": "Properties of a lab user profile.", + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/UserIdentityFragment", + "description": "The identity of the user." + }, + "secretStore": { + "$ref": "#/definitions/UserSecretStoreFragment", + "description": "The secret store of the user." + } + } + }, + "UserSecretStore": { + "description": "Properties of a user's secret store.", + "type": "object", + "properties": { + "keyVaultUri": { + "description": "The URI of the user's Key vault.", + "type": "string" + }, + "keyVaultId": { + "description": "The ID of the user's Key vault.", + "type": "string" + } + } + }, + "UserSecretStoreFragment": { + "description": "Properties of a user's secret store.", + "type": "object", + "properties": { + "keyVaultUri": { + "description": "The URI of the user's Key vault.", + "type": "string" + }, + "keyVaultId": { + "description": "The ID of the user's Key vault.", + "type": "string" + } + } + }, + "VirtualNetwork": { + "description": "A virtual network.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkFragment": { + "description": "A virtual network.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/UpdateResource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/VirtualNetworkPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "VirtualNetworkList": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/VirtualNetwork" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "VirtualNetworkProperties": { + "description": "Properties of a virtual network.", + "type": "object", + "properties": { + "allowedSubnets": { + "description": "The allowed subnets of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/Subnet" } + }, + "description": { + "description": "The description of the virtual network.", + "type": "string" + }, + "externalProviderResourceId": { + "description": "The Microsoft.Network resource identifier of the virtual network.", + "type": "string" + }, + "externalSubnets": { + "description": "The external subnet properties.", + "type": "array", + "items": { "$ref": "#/definitions/ExternalSubnet" }, + "readOnly": true + }, + "subnetOverrides": { + "description": "The subnet overrides of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetOverride" } + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the virtual network.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string", + "readOnly": true + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string", + "readOnly": true + } + } + }, + "VirtualNetworkPropertiesFragment": { + "description": "Properties of a virtual network.", + "type": "object", + "properties": { + "allowedSubnets": { + "description": "The allowed subnets of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetFragment" } + }, + "description": { + "description": "The description of the virtual network.", + "type": "string" + }, + "externalProviderResourceId": { + "description": "The Microsoft.Network resource identifier of the virtual network.", + "type": "string" + }, + "subnetOverrides": { + "description": "The subnet overrides of the virtual network.", + "type": "array", + "items": { "$ref": "#/definitions/SubnetOverrideFragment" } + } + } + }, + "WeekDetails": { + "description": "Properties of a weekly schedule.", + "type": "object", + "properties": { + "weekdays": { + "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", + "type": "array", + "items": { "type": "string" } + }, + "time": { + "description": "The time of the day the schedule will occur.", + "type": "string" + } + } + }, + "WeekDetailsFragment": { + "description": "Properties of a weekly schedule.", + "type": "object", + "properties": { + "weekdays": { + "description": "The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).", + "type": "array", + "items": { "type": "string" } + }, + "time": { + "description": "The time of the day the schedule will occur.", + "type": "string" + } + } + }, + "WindowsOsInfo": { + "description": "Information about a Windows OS.", + "type": "object", + "properties": { + "windowsOsState": { + "description": "The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).", + "enum": [ "NonSysprepped", "SysprepRequested", "SysprepApplied" ], + "type": "string", + "x-ms-enum": { + "name": "WindowsOsState", + "modelAsString": true + } + } + } + }, + "WindowsOsInfoFragment": { + "description": "Information about a Windows OS.", + "type": "object", + "properties": { + "windowsOsState": { + "description": "The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied).", + "enum": [ "NonSysprepped", "SysprepRequested", "SysprepApplied" ], + "type": "string", + "x-ms-enum": { + "name": "WindowsOsState", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "Client API version.", + "required": true, + "type": "string", + "default": "2018-09-15" + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The name of the location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "OAuth2 Implicit Grant", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { "user_impersonation": "Access Microsoft Azure" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json new file mode 100644 index 000000000000..ce186cf5cec0 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ClaimAnyVm.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json new file mode 100644 index 000000000000..e4f72214e0b8 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateEnvironment.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview", + "labVirtualMachineCreationParameter": { + "properties": { + "osType": "Linux", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "password": "{user-password}", + "labSubnetName": "{virtualnetwork-subnet-name}", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "allowClaim": true, + "storageType": "Standard" + }, + "name": "{virtualmachine-name}", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json new file mode 100644 index 000000000000..d80294795e2c --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_CreateOrUpdate.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview", + "lab": { + "properties": { + "labStorageType": "{Standard|Premium}" + }, + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "labStorageType": "Standard", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-10-01T18:40:48.1739018-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}", + "name": "{devtestlab-name}", + "type": "Microsoft.DevTestLab/labs", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "201": { + "body": { + "properties": { + "labStorageType": "Standard", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-10-01T18:40:48.1739018-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}", + "name": "{devtestlab-name}", + "type": "Microsoft.DevTestLab/labs", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json new file mode 100644 index 000000000000..69dc3d95bebe --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json new file mode 100644 index 000000000000..a84e61122adb --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_GenerateUploadUri.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview", + "generateUploadUriParameter": { + "blobName": "{blob-name}" + } + }, + "responses": { + "200": { + "body": { + "uploadUri": "https://{storage-name}.blob.core.windows.net/uploads/{blob-name}?sv=2017-04-17&sr=b&sig={signature}&st=2018-10-02T01:55:24Z&se=2018-10-03T02:10:23Z&sp=rcw" + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json new file mode 100644 index 000000000000..1f56023f25b8 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "defaultStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageaccount-name}", + "defaultPremiumStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageaccount-name}", + "artifactsStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageaccount-name}", + "premiumDataDiskStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/{storageaccount-name}", + "vaultName": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/{keyvault-name}", + "labStorageType": "Standard", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-10-01T18:40:48.1739018-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}", + "name": "{devtestlab-name}", + "type": "Microsoft.DevTestLab/labs", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json new file mode 100644 index 000000000000..6cc3c30ad64d --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vaultName": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/{keyvault-name}", + "labStorageType": "Standard", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-10-02T10:23:20.9573599-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}", + "name": "{devtestlab-name}", + "type": "Microsoft.DevTestLab/labs", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json new file mode 100644 index 000000000000..cdae8b2f96e6 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "defaultStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-1}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-1}", + "defaultPremiumStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-1}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-1}", + "artifactsStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-1}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-1}", + "premiumDataDiskStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-1}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-1}", + "vaultName": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-1}/providers/Microsoft.KeyVault/vaults/{keyvault-name-1}", + "labStorageType": "Premium", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-09-30T08:38:13.1973609-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name-1}/providers/microsoft.devtestlab/labs/{lab-name-1}", + "name": "{lab-name-1}", + "type": "Microsoft.DevTestLab/labs", + "location": "westcentralus", + "tags": {} + }, + { + "properties": { + "defaultStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-2}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-2}", + "defaultPremiumStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-2}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-2}", + "artifactsStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-2}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-2}", + "premiumDataDiskStorageAccount": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-2}/providers/Microsoft.Storage/storageAccounts/{storageaccount-name-2}", + "vaultName": "/subscriptions/{subscription-id}/resourceGroups/{resourcegroup-name-2}/providers/Microsoft.KeyVault/vaults/{keyvault-name-2}", + "labStorageType": "Premium", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-09-30T09:37:52.9675083-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/{resourcegroup-name-2}/providers/microsoft.devtestlab/labs/{lab-name-2}", + "name": "{lab-name-2}", + "type": "Microsoft.DevTestLab/labs", + "location": "japaneast", + "tags": {} + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json new file mode 100644 index 000000000000..242a31478233 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/Labs_Update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "name": "{devtestlab-name}", + "api-version": "2018-10-15-preview", + "lab": { + "properties": { + "labStorageType": "Premium" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "vaultName": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/{keyvault-name}", + "labStorageType": "Standard", + "mandatoryArtifactsResourceIdsLinux": [], + "mandatoryArtifactsResourceIdsWindows": [], + "createdDate": "2018-10-01T18:40:48.1739018-07:00", + "premiumDataDisks": "Disabled", + "environmentPermission": "Reader", + "announcement": { + "title": "", + "markdown": "", + "enabled": "Disabled", + "expired": false + }, + "support": { + "enabled": "Disabled", + "markdown": "" + }, + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}", + "name": "{devtestlab-name}", + "type": "Microsoft.DevTestLab/labs", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json new file mode 100644 index 000000000000..6dd7298e67a5 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json @@ -0,0 +1,859 @@ +{ + "parameters": { + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevTestLab/register/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "register", + "operation": "Register Subscription", + "description": "Registers the subscription" + } + }, + { + "name": "Microsoft.DevTestLab/labs/policySets/EvaluatePolicies/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "policy sets", + "operation": "Evaluate policy", + "description": "Evaluates lab policy." + } + }, + { + "name": "Microsoft.DevTestLab/labs/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Delete labs.", + "description": "Delete labs." + } + }, + { + "name": "Microsoft.DevTestLab/labs/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Read labs.", + "description": "Read labs." + } + }, + { + "name": "Microsoft.DevTestLab/labs/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Add or modify labs.", + "description": "Add or modify labs." + } + }, + { + "name": "Microsoft.DevTestLab/labs/ListVhds/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "List VHDs", + "description": "List disk images available for custom image creation." + } + }, + { + "name": "Microsoft.DevTestLab/labs/GenerateUploadUri/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Generate image upload URI", + "description": "Generate a URI for uploading custom disk images to a Lab." + } + }, + { + "name": "Microsoft.DevTestLab/labs/CreateEnvironment/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Create a virtual machine", + "description": "Create virtual machines in a lab." + } + }, + { + "name": "Microsoft.DevTestLab/labs/ClaimAnyVm/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Claim Any Virtual Machine", + "description": "Claim a random claimable virtual machine in the lab." + } + }, + { + "name": "Microsoft.DevTestLab/labs/ExportResourceUsage/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Exports the lab resource usage into a storage account", + "description": "Exports the lab resource usage into a storage account" + } + }, + { + "name": "Microsoft.DevTestLab/labs/ImportVirtualMachine/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Labs", + "operation": "Import a virtual machine", + "description": "Import a virtual machine into a different lab." + } + }, + { + "name": "Microsoft.DevTestLab/labs/policySets/policies/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "policies", + "operation": "Delete policies.", + "description": "Delete policies." + } + }, + { + "name": "Microsoft.DevTestLab/labs/policySets/policies/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "policies", + "operation": "Read policies.", + "description": "Read policies." + } + }, + { + "name": "Microsoft.DevTestLab/labs/policySets/policies/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "policies", + "operation": "Add or modify policies.", + "description": "Add or modify policies." + } + }, + { + "name": "Microsoft.DevTestLab/labs/schedules/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Delete schedules.", + "description": "Delete schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/schedules/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Read schedules.", + "description": "Read schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/schedules/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Add or modify schedules.", + "description": "Add or modify schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/schedules/Execute/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Execute schedule", + "description": "Execute a schedule." + } + }, + { + "name": "Microsoft.DevTestLab/labs/schedules/ListApplicable/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "List all applicable schedules", + "description": "Lists all applicable schedules" + } + }, + { + "name": "Microsoft.DevTestLab/schedules/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Delete schedules.", + "description": "Delete schedules." + } + }, + { + "name": "Microsoft.DevTestLab/schedules/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Read schedules.", + "description": "Read schedules." + } + }, + { + "name": "Microsoft.DevTestLab/schedules/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Add or modify schedules.", + "description": "Add or modify schedules." + } + }, + { + "name": "Microsoft.DevTestLab/schedules/Execute/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Execute schedule", + "description": "Execute a schedule." + } + }, + { + "name": "Microsoft.DevTestLab/schedules/Retarget/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Retarget schedule.", + "description": "Updates a schedule's target resource Id." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/schedules/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Delete schedules.", + "description": "Delete schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/schedules/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Read schedules.", + "description": "Read schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/schedules/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Add or modify schedules.", + "description": "Add or modify schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/schedules/Execute/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Execute schedule", + "description": "Execute a schedule." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/schedules/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Delete schedules.", + "description": "Delete schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/schedules/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Read schedules.", + "description": "Read schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/schedules/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Add or modify schedules.", + "description": "Add or modify schedules." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/schedules/Execute/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "schedules", + "operation": "Execute schedule", + "description": "Execute a schedule." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Artifact sources", + "operation": "Delete artifact sources.", + "description": "Delete artifact sources." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Artifact sources", + "operation": "Read artifact sources.", + "description": "Read artifact sources." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Artifact sources", + "operation": "Add or modify artifact sources.", + "description": "Add or modify artifact sources." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/artifacts/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Artifacts", + "operation": "Read artifacts.", + "description": "Read artifacts." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/artifacts/GenerateArmTemplate/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Artifacts", + "operation": "Generates an ARM template for the given artifact", + "description": "Generates an ARM template for the given artifact, uploads the required files to a storage account, and validates the generated artifact." + } + }, + { + "name": "Microsoft.DevTestLab/labs/galleryImages/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "gallery images", + "operation": "Read gallery images.", + "description": "Read gallery images." + } + }, + { + "name": "Microsoft.DevTestLab/labs/customImages/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "custom images", + "operation": "Delete custom images.", + "description": "Delete custom images." + } + }, + { + "name": "Microsoft.DevTestLab/labs/customImages/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "custom images", + "operation": "Read custom images.", + "description": "Read custom images." + } + }, + { + "name": "Microsoft.DevTestLab/labs/customImages/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "custom images", + "operation": "Add or modify custom images.", + "description": "Add or modify custom images." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualNetworks/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "virtual networks", + "operation": "Delete virtual networks.", + "description": "Delete virtual networks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualNetworks/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "virtual networks", + "operation": "Read virtual networks.", + "description": "Read virtual networks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualNetworks/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "virtual networks", + "operation": "Add or modify virtual networks.", + "description": "Add or modify virtual networks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Delete virtual machines.", + "description": "Delete virtual machines." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Read virtual machines.", + "description": "Read virtual machines." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Add or modify virtual machines.", + "description": "Add or modify virtual machines." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Start/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Start virtual machine", + "description": "Start a virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Stop/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Stop virtual machine", + "description": "Stop a virtual machine" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Restart/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Restart virtual machine", + "description": "Restart a virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Redeploy/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Redeploy a virtual machine", + "description": "Redeploy a virtual machine" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Resize/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Resize Virtual Machine.", + "description": "Resize Virtual Machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/ApplyArtifacts/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Apply artifacts to virtual machine", + "description": "Apply artifacts to virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/AddDataDisk/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Add or attach a data disk", + "description": "Attach a new or existing data disk to virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/DetachDataDisk/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Detach the specified disk from the virtual machine", + "description": "Detach the specified disk from the virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/Claim/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Claim a virtual machine", + "description": "Take ownership of an existing virtual machine" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/UnClaim/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Unclaim a virtual machine", + "description": "Release ownership of an existing virtual machine" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/TransferDisks/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Transfer data disks to yourself", + "description": "Transfer ownership of virtual machine data disks to yourself" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/ListApplicableSchedules/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "List all applicable schedules", + "description": "Lists all applicable schedules" + } + }, + { + "name": "Microsoft.DevTestLab/labs/virtualMachines/GetRdpFileContents/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Virtual machines", + "operation": "Get RDP file contents", + "description": "Gets a string that represents the contents of the RDP file for the virtual machine" + } + }, + { + "name": "Microsoft.DevTestLab/labs/formulas/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Formulas", + "operation": "Delete formulas.", + "description": "Delete formulas." + } + }, + { + "name": "Microsoft.DevTestLab/labs/formulas/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Formulas", + "operation": "Read formulas.", + "description": "Read formulas." + } + }, + { + "name": "Microsoft.DevTestLab/labs/formulas/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Formulas", + "operation": "Add or modify formulas.", + "description": "Add or modify formulas." + } + }, + { + "name": "Microsoft.DevTestLab/labs/costs/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "costs", + "operation": "Read costs.", + "description": "Read costs." + } + }, + { + "name": "Microsoft.DevTestLab/labs/costs/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "costs", + "operation": "Add or modify costs.", + "description": "Add or modify costs." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/disks/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "disks", + "operation": "Delete disks.", + "description": "Delete disks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/disks/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "disks", + "operation": "Read disks.", + "description": "Read disks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/disks/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "disks", + "operation": "Add or modify disks.", + "description": "Add or modify disks." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/disks/Attach/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "disks", + "operation": "Attach disk", + "description": "Attach and create the lease of the disk to the virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/disks/Detach/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "disks", + "operation": "Detach and break the lease of the disk attached to the virtual machine", + "description": "Detach and break the lease of the disk attached to the virtual machine." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "user profiles", + "operation": "Delete user profiles.", + "description": "Delete user profiles." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "user profiles", + "operation": "Read user profiles.", + "description": "Read user profiles." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "user profiles", + "operation": "Add or modify user profiles.", + "description": "Add or modify user profiles." + } + }, + { + "name": "Microsoft.DevTestLab/labs/notificationChannels/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "notificationChannels", + "operation": "Delete notificationchannels.", + "description": "Delete notificationchannels." + } + }, + { + "name": "Microsoft.DevTestLab/labs/notificationChannels/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "notificationChannels", + "operation": "Read notificationchannels.", + "description": "Read notificationchannels." + } + }, + { + "name": "Microsoft.DevTestLab/labs/notificationChannels/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "notificationChannels", + "operation": "Add or modify notificationchannels.", + "description": "Add or modify notificationchannels." + } + }, + { + "name": "Microsoft.DevTestLab/labs/notificationChannels/Notify/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "notificationChannels", + "operation": "Notify", + "description": "Send notification to provided channel." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/secrets/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "secrets", + "operation": "Delete secrets.", + "description": "Delete secrets." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/secrets/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "secrets", + "operation": "Read secrets.", + "description": "Read secrets." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/secrets/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "secrets", + "operation": "Add or modify secrets.", + "description": "Add or modify secrets." + } + }, + { + "name": "Microsoft.DevTestLab/locations/operations/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "operations", + "operation": "Read operations.", + "description": "Read operations." + } + }, + { + "name": "Microsoft.DevTestLab/labs/artifactSources/armTemplates/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Azure Resource Manager templates", + "operation": "Read azure resource manager templates.", + "description": "Read azure resource manager templates." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/environments/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "environments", + "operation": "Delete environments.", + "description": "Delete environments." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/environments/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "environments", + "operation": "Read environments.", + "description": "Read environments." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/environments/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "environments", + "operation": "Add or modify environments.", + "description": "Add or modify environments." + } + }, + { + "name": "Microsoft.DevTestLab/labs/serviceRunners/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service runners", + "operation": "Delete service runners.", + "description": "Delete service runners." + } + }, + { + "name": "Microsoft.DevTestLab/labs/serviceRunners/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service runners", + "operation": "Read service runners.", + "description": "Read service runners." + } + }, + { + "name": "Microsoft.DevTestLab/labs/serviceRunners/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service runners", + "operation": "Add or modify service runners.", + "description": "Add or modify service runners." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/delete", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "Delete service fabrics.", + "description": "Delete service fabrics." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/read", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "Read service fabrics.", + "description": "Read service fabrics." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/write", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "Add or modify service fabrics.", + "description": "Add or modify service fabrics." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/Start/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "Start service fabric", + "description": "Start a service fabric." + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/Stop/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "Stop service fabric", + "description": "Stop a service fabric" + } + }, + { + "name": "Microsoft.DevTestLab/labs/users/serviceFabrics/ListApplicableSchedules/action", + "display": { + "provider": "Microsoft DevTest Labs", + "resource": "Service Fabrics", + "operation": "List all applicable schedules", + "description": "Lists all applicable schedules" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json new file mode 100644 index 000000000000..735b68da17b0 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Claim.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json new file mode 100644 index 000000000000..dfe3a0c00834 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_CreateOrUpdate.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "labVirtualMachine": { + "properties": { + "osType": "Linux", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "password": "{user-password}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "allowClaim": true, + "storageType": "Standard" + }, + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ownerObjectId": "", + "ownerUserPrincipalName": "", + "createdByUserId": "", + "createdByUser": "", + "createdDate": "2018-10-01T16:53:02.4830866-07:00", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "artifactDeploymentStatus": { + "artifactsApplied": 0, + "totalArtifacts": 0 + }, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "networkInterface": {}, + "allowClaim": true, + "storageType": "Standard", + "virtualMachineCreationSource": "FromGalleryImage", + "dataDiskParameters": [], + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualmachines/{virtualmachine-name}", + "name": "{virtualmachine-name}", + "type": "Microsoft.DevTestLab/labs/virtualMachines", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "201": { + "body": { + "properties": { + "ownerObjectId": "", + "ownerUserPrincipalName": "", + "createdByUserId": "", + "createdByUser": "", + "createdDate": "2018-10-01T16:53:02.4830866-07:00", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "artifactDeploymentStatus": { + "artifactsApplied": 0, + "totalArtifacts": 0 + }, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "networkInterface": {}, + "allowClaim": true, + "storageType": "Standard", + "virtualMachineCreationSource": "FromGalleryImage", + "dataDiskParameters": [], + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualmachines/{virtualmachine-name}", + "name": "{virtualmachine-name}", + "type": "Microsoft.DevTestLab/labs/virtualMachines", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json new file mode 100644 index 000000000000..ae456eab47a4 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json new file mode 100644 index 000000000000..a09a6fa966fa --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "ownerObjectId": "", + "ownerUserPrincipalName": "", + "createdByUserId": "", + "createdByUser": "", + "createdDate": "2018-10-01T16:53:02.4830866-07:00", + "computeId": "/subscriptions/{subscription-id}/resourceGroups/{devtestlab-name}-{virtualmachine-name}-{random-suffix}/providers/Microsoft.Compute/virtualMachines/{virtualmachine-name}", + "osType": "Linux", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "artifactDeploymentStatus": { + "artifactsApplied": 0, + "totalArtifacts": 0 + }, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "networkInterface": {}, + "allowClaim": true, + "storageType": "Standard", + "virtualMachineCreationSource": "FromGalleryImage", + "dataDiskParameters": [], + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualmachines/{virtualmachine-name}", + "name": "{virtualmachine-name}", + "type": "Microsoft.DevTestLab/labs/virtualMachines", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json new file mode 100644 index 000000000000..6fc0184759c7 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_GetRdpFileContents.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "contents": "full address:s:10.0.0.4\r\nprompt for credentials:i:1\r\nusername:s:{virtualmachine-name}\\{user-name}\r\n" + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json new file mode 100644 index 000000000000..c8d5079322db --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "ownerObjectId": "", + "ownerUserPrincipalName": "", + "createdByUserId": "", + "createdByUser": "", + "createdDate": "2018-10-01T16:53:02.4830866-07:00", + "computeId": "/subscriptions/{subscription-id}/resourceGroups/{devtestlab-name}-{virtualmachine-name}-{random-suffix}/providers/Microsoft.Compute/virtualMachines/{virtualmachine-name}", + "osType": "Linux", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "artifactDeploymentStatus": { + "artifactsApplied": 0, + "totalArtifacts": 0 + }, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "networkInterface": {}, + "allowClaim": true, + "storageType": "Standard", + "virtualMachineCreationSource": "FromGalleryImage", + "dataDiskParameters": [], + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualmachines/{virtualmachine-name}", + "name": "{virtualmachine-name}", + "type": "Microsoft.DevTestLab/labs/virtualMachines", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json new file mode 100644 index 000000000000..9f39bf9443c4 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Redeploy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json new file mode 100644 index 000000000000..8bb556bf7b27 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Resize.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "monitor": "true", + "resizeLabVirtualMachineProperties": { + "size": "Standard_A4_v2" + } + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json new file mode 100644 index 000000000000..9f39bf9443c4 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Restart.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json new file mode 100644 index 000000000000..9f39bf9443c4 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Start.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json new file mode 100644 index 000000000000..735b68da17b0 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Stop.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json new file mode 100644 index 000000000000..9f39bf9443c4 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_UnClaim.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json new file mode 100644 index 000000000000..991168c9b4e7 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualMachines_Update.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualmachine-name}", + "api-version": "2018-10-15-preview", + "labVirtualMachine": { + "properties": { + "notes": "Updated notes" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "ownerObjectId": "", + "ownerUserPrincipalName": "", + "createdByUserId": "", + "createdByUser": "", + "createdDate": "2018-10-01T16:53:02.4830866-07:00", + "computeId": "/subscriptions/{subscription-id}/resourceGroups/{devtestlab-name}-{virtualmachine-name}-{random-suffix}/providers/Microsoft.Compute/virtualMachines/{virtualmachine-name}", + "osType": "Linux", + "size": "Standard_A2_v2", + "userName": "{user-name}", + "labSubnetName": "{virtualnetwork-name}Subnet", + "labVirtualNetworkId": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "disallowPublicIpAddress": true, + "artifactDeploymentStatus": { + "artifactsApplied": 0, + "totalArtifacts": 0 + }, + "galleryImageReference": { + "offer": "UbuntuServer", + "publisher": "Canonical", + "sku": "16.04-LTS", + "osType": "Linux", + "version": "Latest" + }, + "networkInterface": {}, + "allowClaim": true, + "storageType": "Standard", + "virtualMachineCreationSource": "FromGalleryImage", + "dataDiskParameters": [], + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualmachines/{virtualmachine-name}", + "name": "{virtualmachine-name}", + "type": "Microsoft.DevTestLab/labs/virtualMachines", + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json new file mode 100644 index 000000000000..3412abbdc64d --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_CreateOrUpdate.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualnetwork-name}", + "api-version": "2018-10-15-preview", + "virtualNetwork": { + "location": "{azure-location}", + "tags": { + "MyTag": "MyValue" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "createdDate": "2018-10-01T13:01:44.6005134-07:00", + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "name": "{virtualnetwork-name}", + "type": "Microsoft.DevTestLab/labs/virtualNetworks", + "tags": { + "MyTag": "MyValue" + } + } + }, + "201": { + "body": { + "properties": { + "createdDate": "2018-10-01T13:01:44.6005134-07:00", + "provisioningState": "Creating", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "name": "{virtualnetwork-name}", + "type": "Microsoft.DevTestLab/labs/virtualNetworks", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json new file mode 100644 index 000000000000..045990ab9fa5 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualnetwork-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json new file mode 100644 index 000000000000..7104de5c9cda --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Get.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualnetwork-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "allowedSubnets": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "labSubnetName": "{virtualnetwork-name}Subnet", + "allowPublicIp": "Allow" + } + ], + "externalProviderResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}", + "subnetOverrides": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "labSubnetName": "{virtualnetwork-name}Subnet", + "useInVmCreationPermission": "Allow", + "usePublicIpAddressPermission": "Allow", + "sharedPublicIpAddressConfiguration": { + "allowedPorts": [ + { + "transportProtocol": "Tcp", + "backendPort": 3389 + }, + { + "transportProtocol": "Tcp", + "backendPort": 22 + } + ] + } + } + ], + "createdDate": "2018-10-01T13:01:44.6005134-07:00", + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "name": "{virtualnetwork-name}", + "type": "Microsoft.DevTestLab/labs/virtualNetworks", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json new file mode 100644 index 000000000000..b905f79e2338 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "api-version": "2018-10-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "allowedSubnets": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "labSubnetName": "{virtualnetwork-name}Subnet", + "allowPublicIp": "Allow" + } + ], + "externalProviderResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}", + "subnetOverrides": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "labSubnetName": "{virtualnetwork-name}Subnet", + "useInVmCreationPermission": "Allow", + "usePublicIpAddressPermission": "Allow", + "sharedPublicIpAddressConfiguration": { + "allowedPorts": [ + { + "transportProtocol": "Tcp", + "backendPort": 3389 + }, + { + "transportProtocol": "Tcp", + "backendPort": 22 + } + ] + } + } + ], + "createdDate": "2018-10-01T13:01:44.6005134-07:00", + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "name": "{virtualnetwork-name}", + "type": "Microsoft.DevTestLab/labs/virtualNetworks", + "tags": { + "MyTag": "MyValue" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json new file mode 100644 index 000000000000..d439c40e4cd7 --- /dev/null +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/VirtualNetworks_Update.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labName": "{devtestlab-name}", + "name": "{virtualnetwork-name}", + "api-version": "2018-10-15-preview", + "virtualNetwork": { + "properties": { + "subnetOverrides": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "useInVmCreationPermission": "Allow", + "usePublicIpAddressPermission": "Deny", + "sharedPublicIpAddressConfiguration": { + "allowedPorts": [ + { + "transportProtocol": "Tcp", + "backendPort": 3389 + }, + { + "transportProtocol": "Tcp", + "backendPort": 22 + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "externalProviderResourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}", + "subnetOverrides": [ + { + "resourceId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{virtualnetwork-name}/subnets/{virtualnetwork-name}Subnet", + "labSubnetName": "{virtualnetwork-name}Subnet", + "useInVmCreationPermission": "Allow", + "usePublicIpAddressPermission": "Allow", + "sharedPublicIpAddressConfiguration": { + "allowedPorts": [ + { + "transportProtocol": "Tcp", + "backendPort": 3389 + }, + { + "transportProtocol": "Tcp", + "backendPort": 22 + } + ] + } + } + ], + "createdDate": "2018-10-01T13:01:44.6005134-07:00", + "provisioningState": "Succeeded", + "uniqueIdentifier": "{unique-identifier}" + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/{devtestlab-name}/virtualnetworks/{virtualnetwork-name}", + "name": "{virtualnetwork-name}", + "type": "Microsoft.DevTestLab/labs/virtualNetworks", + "tags": { + "MyTag": "MyValue" + } + } + } + } +} \ No newline at end of file diff --git a/specification/devtestlabs/resource-manager/readme.go.md b/specification/devtestlabs/resource-manager/readme.go.md index 2aaa918a3746..e5db00b37552 100644 --- a/specification/devtestlabs/resource-manager/readme.go.md +++ b/specification/devtestlabs/resource-manager/readme.go.md @@ -13,10 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-09 - tag: package-2016-05 - tag: package-2015-05-preview ``` +### Tag: package-2018-09 and go + +These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/devtestlabs/mgmt/2015-09-15/$(namespace) +``` ### Tag: package-2016-05 and go diff --git a/specification/devtestlabs/resource-manager/readme.md b/specification/devtestlabs/resource-manager/readme.md index 3edfb48da9d4..5d9e5b5b70ae 100644 --- a/specification/devtestlabs/resource-manager/readme.md +++ b/specification/devtestlabs/resource-manager/readme.md @@ -26,10 +26,19 @@ These are the global settings for the DevTestLab API. ``` yaml openapi-type: arm -tag: package-2016-05 +tag: package-2018-09 ``` +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: +- Microsoft.DevTestLab/stable/2018-09-15/DTL.json +``` + ### Tag: package-2016-05 These settings apply only when `--tag=package-2016-05` is specified on the command line. @@ -134,10 +143,24 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-devtestlabs ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-09 - tag: package-2016-05 - tag: package-2015-05-preview ``` +### Tag: package-2018-09 and java + +These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.devtestlab.v2018_09_15 + output-folder: $(azure-libraries-for-java-folder)/devtestlab/resource-manager/v2018_09_15 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2016-05 and java These settings apply only when `--tag=package-2016-05 --java` is specified on the command line. diff --git a/specification/devtestlabs/resource-manager/readme.ruby.md b/specification/devtestlabs/resource-manager/readme.ruby.md index 9c3d05b949be..8ce602c508f0 100644 --- a/specification/devtestlabs/resource-manager/readme.ruby.md +++ b/specification/devtestlabs/resource-manager/readme.ruby.md @@ -12,9 +12,20 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2018-09 - tag: package-2016-05 ``` +### Tag: package-2018-09 and ruby + +These settings apply only when `--tag=package-2018-09 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09' && $(ruby) +namespace: "Azure::DevTestLabs::Mgmt::V2018_09_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_devtestlabs/lib +``` + ### Tag: package-2016-05 and ruby These settings apply only when `--tag=package-2016-05 --ruby` is specified on the command line. From d4365e634050481a5d6966cd6dd2e4a361d519dd Mon Sep 17 00:00:00 2001 From: Abhinav Ghai Date: Wed, 31 Oct 2018 15:44:03 -0700 Subject: [PATCH 078/464] Add list and get software to GuestConfiguration (#4343) * Add list and get software to GuestConfiguration * Use newer API version for software --- .../examples/getSoftware.json | 25 +++ .../examples/listSoftware.json | 49 ++++++ .../guestconfiguration.json | 146 ++++++++++++++++++ 3 files changed, 220 insertions(+) create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json new file mode 100644 index 000000000000..1322178b366c --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "softwareId": "57b536b9-0945-486a-b694-3e3151541452", + "api-version": "2018-01-20-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/57b536b9-0945-486a-b694-3e3151541452", + "name": "57b536b9-0945-486a-b694-3e3151541452", + "type": "Microsoft.GuestConfiguration/software", + "properties": { + "name": "Microsoft SQL Server 2017", + "version": "17.1.2034.35", + "publisher": "Microsoft Corporation", + "lastRefreshDate": "2018-01-01T04:35:00Z" + } + } + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json new file mode 100644 index 000000000000..897fce4dbdad --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "softwareId": "57b536b9-0945-486a-b694-3e3151541452", + "api-version": "2018-01-20-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/57b536b9-0945-486a-b694-3e3151541452", + "name": "57b536b9-0945-486a-b694-3e3151541452", + "type": "Microsoft.GuestConfiguration/software", + "properties": { + "name": "Microsoft SQL Server 2017", + "version": "17.1.2034.35", + "publisher": "Microsoft Corporation", + "lastRefreshDate": "2018-01-01T04:35:00Z" + } + }, + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/67b536b9-0945-486a-b694-3e3151541452", + "name": "67b536b9-0945-486a-b694-3e3151541452", + "type": "Microsoft.GuestConfiguration/software", + "properties": { + "name": "Slack", + "version": "3.3.3", + "publisher": "Slack Technologies", + "lastRefreshDate": "2018-01-01T04:35:00Z" + } + }, + { + "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/77b536b9-0945-486a-b694-3e3151541452", + "name": "77b536b9-0945-486a-b694-3e3151541452", + "type": "Microsoft.GuestConfiguration/software", + "properties": { + "name": "Node.js", + "version": "8.12.0", + "publisher": "Node.js Foundation", + "lastRefreshDate": "2018-01-01T04:35:00Z" + } + } + ] + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json index d8ebd72c88e2..4290eff7f2d0 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json @@ -354,6 +354,100 @@ "application/json" ] } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/software/{softwareId}": { + "get": { + "tags": [ + "Software" + ], + "operationId": "Software_Get", + "description": "Get information about a software installed on the given virtual machine", + "x-ms-examples": { + "Get a software": { + "$ref": "./examples/getSoftware.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "name": "softwareId", + "in": "path", + "required": true, + "type": "string", + "description": "The software Id." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Software" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/software": { + "get": { + "tags": [ + "Software" + ], + "operationId": "Software_List", + "description": "Get information about list of software installed on the given virtual machine", + "x-ms-examples": { + "List software": { + "$ref": "./examples/listSoftware.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoftwareList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } } }, "definitions": { @@ -777,6 +871,58 @@ } }, "description": "Reason and code for the compliance of the guest configuration assignment resource." + }, + "SoftwareList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Software" + }, + "description": "The list of software installed on a given virtual machine." + } + }, + "description": "The list of software installed on a given virtual machine." + }, + "Software": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/SoftwareProperties", + "description": "Properties of the software." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Describes a specific software installed on the given virtual machine." + }, + "SoftwareProperties": { + "description": "Properties of the software object.", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the software" + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Version of the software" + }, + "publisher": { + "type": "string", + "readOnly": true, + "description": "Publisher of the software" + }, + "lastRefreshDate": { + "type": "string", + "readOnly": true, + "description": "Last refresh date for the software" + } + } } }, "parameters": {} From 018cd1a3d1b3f06045689de9f68553400fb4180f Mon Sep 17 00:00:00 2001 From: EvgenyAgafonchikov Date: Thu, 1 Nov 2018 19:45:55 +0300 Subject: [PATCH 079/464] Move parameter to keep order in SDK (#4376) --- .../stable/2018-08-01/virtualNetwork.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json index 43bd4a45dc6b..87e5d1e41915 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/virtualNetwork.json @@ -739,13 +739,6 @@ "operationId": "VirtualNetworks_CheckIPAddressAvailability", "description": "Checks whether a private IP address is available for use.", "parameters": [ - { - "name": "ipAddress", - "in": "query", - "required": true, - "type": "string", - "description": "The private IP address to be verified." - }, { "name": "resourceGroupName", "in": "path", @@ -760,6 +753,13 @@ "type": "string", "description": "The name of the virtual network." }, + { + "name": "ipAddress", + "in": "query", + "required": true, + "type": "string", + "description": "The private IP address to be verified." + }, { "$ref": "./network.json#/parameters/ApiVersionParameter" }, From bc29ad1548fa6676d30d20cd4d2021b87a2f7798 Mon Sep 17 00:00:00 2001 From: shurd Date: Thu, 1 Nov 2018 10:19:58 -0700 Subject: [PATCH 080/464] adding property ignoreMissingVNetServiceEndpoint to VirtualNetworkRule object in Cosmos DB (#4371) --- .../Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json | 4 ++++ .../2015-04-08/examples/CosmosDBDatabaseAccountCreateMax.json | 3 ++- .../examples/CosmosDBDatabaseAccountCreateMulti.json | 3 ++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json index 64c15ce756b3..192858572183 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json @@ -1890,6 +1890,10 @@ "id":{ "type": "string", "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint":{ + "type": "boolean", + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." } } }, diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMax.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMax.json index 320bb71bf35d..353a2462d9a7 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMax.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMax.json @@ -14,7 +14,8 @@ "isVirtualNetworkFilterEnabled": true, "virtualNetworkRules": [ { - "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false } ], "locations": [ diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMulti.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMulti.json index 62fb15aabfcd..65db2f69123f 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMulti.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/examples/CosmosDBDatabaseAccountCreateMulti.json @@ -15,7 +15,8 @@ "enableMultipleWriteLocations": true, "virtualNetworkRules": [ { - "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false } ], "locations": [ From 6cf0272826371c207bc1216b2fd1f573d1b22da2 Mon Sep 17 00:00:00 2001 From: mozehgir <32183061+mozehgir@users.noreply.github.com> Date: Thu, 1 Nov 2018 12:28:37 -0700 Subject: [PATCH 081/464] Update openapi-authoring-automated-guidelines.md (#4369) --- documentation/openapi-authoring-automated-guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index dbfd12d71e4f..326b84b08960 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -32,7 +32,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | Id | Rule Name | Applies to | | --- | --- | --- | -| [R3012](#R3012) | [APIVersionPattern](#R3012) | ARM OpenAPI(swagger) specs | +| [R3012](#r3012) | [APIVersionPattern](#r3012) | ARM OpenAPI(swagger) specs | | [R3019](#R3019) | [ARMResourcePropertiesBag](#R3019) | ARM and Data plane OpenAPI(swagger) specs | | [R3014](#R3014) | [BodyPropertiesNamesCamelCase](#R3014) | ARM and Data plane OpenAPI(swagger) specs | | [R3016](#R3016) | [DefinitionsPropertiesNamesCamelCase](#R3016) | ARM and Data plane OpenAPI(swagger) specs | @@ -129,7 +129,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an ## Rule Descriptions -### R3012 APIVersionPattern +### R3012 APIVersionPattern **Category** : ARM Error **Applies to**: ARM OpenAPI(swagger) specs From 47a559db83871c015645104065f8bc18ba62f898 Mon Sep 17 00:00:00 2001 From: michimune Date: Thu, 1 Nov 2018 13:23:13 -0700 Subject: [PATCH 082/464] Fix network trace API bugs (Retake) (#4363) * Fix network trace API bugs * Fix network trace API V2 --- .../stable/2018-02-01/WebApps.json | 46 ++++++++++++++----- .../GetWebSiteNetworkTraceOperation.json | 12 +++-- .../GetWebSiteNetworkTraceOperationV2.json | 29 ------------ .../StartWebSiteNetworkTraceOperation.json | 8 +++- 4 files changed, 51 insertions(+), 44 deletions(-) delete mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index 08e0da54a7e8..4830bbdf2bfa 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -5149,7 +5149,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5214,7 +5217,7 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { "type": "string" } @@ -5287,7 +5290,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5449,7 +5455,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -5461,7 +5470,7 @@ }, "x-ms-examples": { "Get the current status of a network trace operation for a site": { - "$ref": "./examples/GetWebSiteNetworkTraceOperationV2.json" + "$ref": "./examples/GetWebSiteNetworkTraceOperation.json" } } } @@ -12617,7 +12626,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -12689,7 +12701,7 @@ ], "responses": { "200": { - "description": "OK.", + "description": "OK", "schema": { "type": "string" } @@ -12769,7 +12781,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -12952,7 +12967,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -15253,7 +15271,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { @@ -16858,7 +16879,10 @@ "202": { "description": "Operation is in progress.", "schema": { - "$ref": "./CommonDefinitions.json#/definitions/Operation" + "type": "array", + "items": { + "$ref": "#/definitions/NetworkTrace" + } } }, "default": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperation.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperation.json index 72a7fd4e6b1e..cce0885ef8af 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperation.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperation.json @@ -20,10 +20,16 @@ }, "202": { "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" + "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", + "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" }, - "body": { } + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] } } } \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json deleted file mode 100644 index 0921bcd01c37..000000000000 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/GetWebSiteNetworkTraceOperationV2.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", - "resourceGroupName": "testrg123", - "name": "SampleApp", - "slot": "Production", - "operationId": "c291433b-53ad-4c49-8cae-0a293eae1c6d", - "api-version": "2018-02-01" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", - "status": "Succeeded", - "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" - } - ] - }, - "202": { - "headers": { - "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", - "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/networktraces/current/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" - }, - "body": { } - } - } -} \ No newline at end of file diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/StartWebSiteNetworkTraceOperation.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/StartWebSiteNetworkTraceOperation.json index 4259fde0568a..24465b2d26ee 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/StartWebSiteNetworkTraceOperation.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/examples/StartWebSiteNetworkTraceOperation.json @@ -23,7 +23,13 @@ "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d", "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/SampleApp/operationresults/c291433b-53ad-4c49-8cae-0a293eae1c6d" }, - "body": {} + "body": [ + { + "path": "D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip", + "status": "Succeeded", + "message": "Trace file has been saved as D:\\home\\LogFiles\\networktrace\\10.0.0.1_2018_02_01T00_00_00.zip" + } + ] } } } \ No newline at end of file From ffc3493b987a3a2b3e4c7d93731d45bc3fea97e0 Mon Sep 17 00:00:00 2001 From: Tony Xu Date: Fri, 2 Nov 2018 07:32:09 -0700 Subject: [PATCH 083/464] Update swagger with DNSConfig and GPU (#4373) --- .../stable/2018-10-01/containerInstance.json | 64 +++++++++++++++++++ .../ContainerGroupsCreateOrUpdate.json | 31 ++++++++- 2 files changed, 92 insertions(+), 3 deletions(-) diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json index c160d9793841..4c680ff8b8a7 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json @@ -712,6 +712,10 @@ "description": "The CPU request of this container instance.", "type": "number", "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" } } }, @@ -728,6 +732,38 @@ "description": "The CPU limit of this container instance.", "type": "number", "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } } } }, @@ -1020,6 +1056,10 @@ "networkProfile": { "description": "The network profile information for a container group.", "$ref": "#/definitions/ContainerGroupNetworkProfile" + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" } }, "required": [ @@ -1457,6 +1497,30 @@ } } }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, "Resource": { "type": "object", "description": "The Resource model definition.", diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsCreateOrUpdate.json index 312d72858129..8218af17be94 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsCreateOrUpdate.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsCreateOrUpdate.json @@ -30,7 +30,11 @@ "resources": { "requests": { "cpu": 1, - "memoryInGB": 1.5 + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } } }, "volumeMounts": [ @@ -66,6 +70,11 @@ "networkProfile": { "id": "test-network-profile-id" }, + "dnsConfig": { + "nameServers": [ "1.1.1.1" ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, "imageRegistryCredentials": [], "ipAddress": { "ports": [ @@ -126,7 +135,11 @@ "resources": { "requests": { "cpu": 1, - "memoryInGB": 1.5 + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } } }, "volumeMounts": [ @@ -155,6 +168,11 @@ "workspaceKey": "" } }, + "dnsConfig": { + "nameServers": [ "1.1.1.1" ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, "imageRegistryCredentials": [], "ipAddress": { "ip": "10.0.0.1", @@ -212,7 +230,11 @@ "resources": { "requests": { "cpu": 1, - "memoryInGB": 1.5 + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } } }, "volumeMounts": [ @@ -235,6 +257,9 @@ } } ], + "dnsConfig": { + "nameServers": [ "1.1.1.1" ] + }, "imageRegistryCredentials": [], "ipAddress": { "ip": "10.0.0.1", From 97f8b3a634ea40de831efa83a543399b46004ca5 Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Fri, 2 Nov 2018 08:46:33 -0700 Subject: [PATCH 084/464] Move version 2018-01-01 to stable folder (#4384) * Move version 2018-01-01 to stable folder * remove stable folder --- .../2018-01-01/apimanagement.json | 0 .../2018-01-01/apimapis.json | 0 .../2018-01-01/apimauthorizationservers.json | 0 .../2018-01-01/apimbackends.json | 0 .../2018-01-01/apimcertificates.json | 0 .../2018-01-01/apimdeployment.json | 0 .../2018-01-01/apimdiagnostics.json | 0 .../2018-01-01/apimemailtemplate.json | 0 .../2018-01-01/apimgroups.json | 0 .../2018-01-01/apimidentityprovider.json | 0 .../2018-01-01/apimissues.json | 0 .../2018-01-01/apimloggers.json | 0 .../2018-01-01/apimnetworkstatus.json | 0 .../2018-01-01/apimnotifications.json | 0 .../apimopenidconnectproviders.json | 0 .../2018-01-01/apimportalsettings.json | 0 .../2018-01-01/apimproducts.json | 0 .../2018-01-01/apimproperties.json | 0 .../2018-01-01/apimquotas.json | 0 .../2018-01-01/apimreports.json | 0 .../2018-01-01/apimsubscriptions.json | 0 .../2018-01-01/apimtagresources.json | 0 .../2018-01-01/apimtags.json | 0 .../2018-01-01/apimtenant.json | 0 .../2018-01-01/apimusers.json | 0 .../2018-01-01/apimversionsets.json | 0 ...ementApplyNetworkConfigurationUpdates.json | 0 .../ApiManagementBackendReconnect.json | 0 .../examples/ApiManagementCreateAILogger.json | 0 .../examples/ApiManagementCreateApi.json | 0 .../ApiManagementCreateApiDiagnostic.json | 0 ...piManagementCreateApiDiagnosticLogger.json | 0 .../examples/ApiManagementCreateApiIssue.json | 0 ...ApiManagementCreateApiIssueAttachment.json | 0 .../ApiManagementCreateApiIssueComment.json | 0 .../ApiManagementCreateApiOperation.json | 0 ...ApiManagementCreateApiOperationPolicy.json | 0 .../ApiManagementCreateApiPolicy.json | 0 ...anagementCreateApiPolicyNonXmlEncoded.json | 0 .../ApiManagementCreateApiRelease.json | 0 .../ApiManagementCreateApiRevision.json | 0 .../ApiManagementCreateApiSchema.json | 0 .../examples/ApiManagementCreateApiTag.json | 0 .../ApiManagementCreateApiTagDescription.json | 0 ...ManagementCreateApiUsingSwaggerImport.json | 0 ...ApiManagementCreateApiUsingWadlImport.json | 0 .../ApiManagementCreateApiVersionSet.json | 0 ...iManagementCreateApiWithOpenIdConnect.json | 0 ...piManagementCreateAuthorizationServer.json | 0 ...piManagementCreateBackendProxyBackend.json | 0 ...iManagementCreateBackendServiceFabric.json | 0 .../examples/ApiManagementCreateBackup.json | 0 .../ApiManagementCreateCertificate.json | 0 .../ApiManagementCreateDiagnostic.json | 0 .../ApiManagementCreateDiagnosticLogger.json | 0 .../examples/ApiManagementCreateEHLogger.json | 0 .../ApiManagementCreateEmailTemplate.json | 0 .../examples/ApiManagementCreateGroup.json | 0 .../ApiManagementCreateGroupExternal.json | 0 .../ApiManagementCreateGroupUser.json | 0 .../ApiManagementCreateIdentityProvider.json | 0 ...eMultiRegionServiceWithCustomHostname.json | 0 ...ManagementCreateOpenIdConnectProvider.json | 0 .../ApiManagementCreateOperationTag.json | 0 .../examples/ApiManagementCreatePolicy.json | 0 .../ApiManagementCreateProductApi.json | 0 .../ApiManagementCreateProductBasic.json | 0 .../ApiManagementCreateProductGroup.json | 0 .../ApiManagementCreateProductPolicy.json | 0 .../ApiManagementCreateProductTag.json | 0 .../examples/ApiManagementCreateProperty.json | 0 .../ApiManagementCreateRecipientEmail.json | 0 .../ApiManagementCreateRecipientUser.json | 0 .../examples/ApiManagementCreateService.json | 0 .../ApiManagementCreateServiceHavingMsi.json | 0 ...ntCreateServiceWithSystemCertificates.json | 0 ...eateSoapPassThroughApiUsingWsdlImport.json | 0 ...entCreateSoapToRestApiUsingWsdlImport.json | 0 .../ApiManagementCreateSubscription.json | 0 .../examples/ApiManagementCreateTag.json | 0 .../ApiManagementCreateUserBasic.json | 0 .../examples/ApiManagementDeleteApi.json | 0 .../ApiManagementDeleteApiDiagnostic.json | 0 ...piManagementDeleteApiDiagnosticLogger.json | 0 .../examples/ApiManagementDeleteApiIssue.json | 0 ...ApiManagementDeleteApiIssueAttachment.json | 0 .../ApiManagementDeleteApiIssueComment.json | 0 .../ApiManagementDeleteApiOperation.json | 0 .../ApiManagementDeleteApiPolicy.json | 0 .../ApiManagementDeleteApiRelease.json | 0 .../ApiManagementDeleteApiSchema.json | 0 .../examples/ApiManagementDeleteApiTag.json | 0 .../ApiManagementDeleteApiTagDescription.json | 0 .../ApiManagementDeleteApiVersionSet.json | 0 ...piManagementDeleteAuthorizationServer.json | 0 .../examples/ApiManagementDeleteBackend.json | 0 .../ApiManagementDeleteCertificate.json | 0 .../ApiManagementDeleteDiagnostic.json | 0 .../ApiManagementDeleteDiagnosticLogger.json | 0 .../ApiManagementDeleteEmailTemplate.json | 0 .../examples/ApiManagementDeleteGroup.json | 0 .../ApiManagementDeleteGroupUser.json | 0 .../ApiManagementDeleteIdentityProvider.json | 0 .../examples/ApiManagementDeleteLogger.json | 0 ...ementDeleteNotificationRecipientEmail.json | 0 ...gementDeleteNotificationRecipientUser.json | 0 ...ManagementDeleteOpenIdConnectProvider.json | 0 .../ApiManagementDeleteOperationPolicy.json | 0 .../ApiManagementDeleteOperationTag.json | 0 .../examples/ApiManagementDeletePolicy.json | 0 .../examples/ApiManagementDeleteProduct.json | 0 .../ApiManagementDeleteProductApi.json | 0 .../ApiManagementDeleteProductGroup.json | 0 .../ApiManagementDeleteProductPolicy.json | 0 .../ApiManagementDeleteProductTag.json | 0 .../examples/ApiManagementDeleteProperty.json | 0 .../ApiManagementDeleteSubscription.json | 0 .../examples/ApiManagementDeleteTag.json | 0 .../examples/ApiManagementDeleteUser.json | 0 .../examples/ApiManagementGetApiContract.json | 0 .../ApiManagementGetApiDiagnostic.json | 0 ...iManagementGetApiExportInOpenApi2dot0.json | 0 .../examples/ApiManagementGetApiIssue.json | 0 .../ApiManagementGetApiIssueAttachment.json | 0 .../ApiManagementGetApiIssueComment.json | 0 .../ApiManagementGetApiOperation.json | 0 .../ApiManagementGetApiOperationPolicy.json | 0 .../examples/ApiManagementGetApiPolicy.json | 0 .../examples/ApiManagementGetApiRelease.json | 0 .../examples/ApiManagementGetApiRevision.json | 0 .../examples/ApiManagementGetApiSchema.json | 0 .../examples/ApiManagementGetApiTag.json | 0 .../ApiManagementGetApiTagDescription.json | 0 .../ApiManagementGetApiVersionSet.json | 0 .../ApiManagementGetAuthorizationServer.json | 0 .../examples/ApiManagementGetBackend.json | 0 .../examples/ApiManagementGetCertificate.json | 0 .../examples/ApiManagementGetDiagnostic.json | 0 .../ApiManagementGetEmailTemplate.json | 0 .../examples/ApiManagementGetGroup.json | 0 .../ApiManagementGetIdentityProvider.json | 0 .../examples/ApiManagementGetLogger.json | 0 .../ApiManagementGetNotification.json | 0 ...ApiManagementGetOpenIdConnectProvider.json | 0 .../ApiManagementGetOperationTag.json | 0 .../examples/ApiManagementGetPolicy.json | 0 .../examples/ApiManagementGetProduct.json | 0 .../ApiManagementGetProductPolicy.json | 0 .../examples/ApiManagementGetProductTag.json | 0 .../ApiManagementGetProductsForApi.json | 0 .../examples/ApiManagementGetProperty.json | 0 .../ApiManagementGetQuotaCounteryKeys.json | 0 ...mentGetQuotaCounteryKeysByQuotaPeriod.json | 0 .../ApiManagementGetReportsByApi.json | 0 .../ApiManagementGetReportsByGeo.json | 0 .../ApiManagementGetReportsByOperation.json | 0 .../ApiManagementGetReportsByProduct.json | 0 .../ApiManagementGetReportsByRequest.json | 0 ...ApiManagementGetReportsBySubscription.json | 0 .../ApiManagementGetReportsByTime.json | 0 .../ApiManagementGetReportsByUser.json | 0 .../ApiManagementGetSubscription.json | 0 .../examples/ApiManagementGetTag.json | 0 ...ApiManagementGetTagDescriptionsForApi.json | 0 .../examples/ApiManagementGetTagsForApi.json | 0 .../ApiManagementGetTagsForOperation.json | 0 .../ApiManagementGetTagsForProduct.json | 0 .../ApiManagementGetTenantAccess.json | 0 .../examples/ApiManagementGetUser.json | 0 .../examples/ApiManagementHeadApi.json | 0 .../ApiManagementHeadApiDiagnostic.json | 0 .../ApiManagementHeadApiDiagnosticLogger.json | 0 .../examples/ApiManagementHeadApiIssue.json | 0 .../ApiManagementHeadApiIssueAttachment.json | 0 .../ApiManagementHeadApiIssueComment.json | 0 .../ApiManagementHeadApiOperation.json | 0 .../ApiManagementHeadApiOperationPolicy.json | 0 .../examples/ApiManagementHeadApiPolicy.json | 0 .../examples/ApiManagementHeadApiRelease.json | 0 .../examples/ApiManagementHeadApiSchema.json | 0 .../examples/ApiManagementHeadApiTag.json | 0 .../ApiManagementHeadApiTagDescription.json | 0 .../ApiManagementHeadApiVersionSet.json | 0 .../ApiManagementHeadAuthorizationServer.json | 0 .../examples/ApiManagementHeadBackend.json | 0 .../ApiManagementHeadCertificate.json | 0 .../ApiManagementHeadDelegationSettings.json | 0 .../examples/ApiManagementHeadDiagnostic.json | 0 .../ApiManagementHeadDiagnosticLogger.json | 0 .../ApiManagementHeadEmailTemplate.json | 0 .../examples/ApiManagementHeadGroup.json | 0 .../examples/ApiManagementHeadGroupUser.json | 0 .../ApiManagementHeadIdentityProvider.json | 0 .../examples/ApiManagementHeadLogger.json | 0 ...agementHeadNotificationRecipientEmail.json | 0 ...nagementHeadNotificationRecipientUser.json | 0 ...piManagementHeadOpenIdConnectProvider.json | 0 .../ApiManagementHeadOperationTag.json | 0 .../examples/ApiManagementHeadPolicy.json | 0 .../examples/ApiManagementHeadProduct.json | 0 .../examples/ApiManagementHeadProductApi.json | 0 .../ApiManagementHeadProductGroup.json | 0 .../ApiManagementHeadProductPolicy.json | 0 .../examples/ApiManagementHeadProductTag.json | 0 .../examples/ApiManagementHeadProperty.json | 0 .../ApiManagementHeadSignInSettings.json | 0 .../ApiManagementHeadSignUpSettings.json | 0 .../ApiManagementHeadSubscription.json | 0 .../examples/ApiManagementHeadTag.json | 0 .../examples/ApiManagementHeadUser.json | 0 ...ApiManagementListApiDiagnosticLoggers.json | 0 .../ApiManagementListApiDiagnostics.json | 0 .../ApiManagementListApiIssueAttachments.json | 0 .../ApiManagementListApiIssueComments.json | 0 .../examples/ApiManagementListApiIssues.json | 0 ...ApiManagementListApiOperationPolicies.json | 0 .../ApiManagementListApiOperations.json | 0 .../ApiManagementListApiPolicies.json | 0 .../ApiManagementListApiReleases.json | 0 .../ApiManagementListApiRevisions.json | 0 .../examples/ApiManagementListApiSchemas.json | 0 .../ApiManagementListApiVersionSets.json | 0 .../examples/ApiManagementListApis.json | 0 .../examples/ApiManagementListApisByTags.json | 0 ...ApiManagementListAuthorizationServers.json | 0 .../examples/ApiManagementListBackends.json | 0 .../ApiManagementListCertificates.json | 0 .../ApiManagementListDiagnosticLoggers.json | 0 .../ApiManagementListDiagnostics.json | 0 .../ApiManagementListEmailTemplates.json | 0 .../examples/ApiManagementListGroupUsers.json | 0 .../examples/ApiManagementListGroups.json | 0 .../ApiManagementListIdentityProviders.json | 0 .../examples/ApiManagementListIssues.json | 0 .../examples/ApiManagementListLoggers.json | 0 ...agementListNotificationRecipientEmail.json | 0 ...nagementListNotificationRecipientUser.json | 0 .../ApiManagementListNotifications.json | 0 ...iManagementListOpenIdConnectProviders.json | 0 .../examples/ApiManagementListOperations.json | 0 .../ApiManagementListOperationsByTags.json | 0 .../examples/ApiManagementListPolicies.json | 0 .../ApiManagementListPolicySnippets.json | 0 .../ApiManagementListProductApis.json | 0 .../ApiManagementListProductGroups.json | 0 .../ApiManagementListProductPolicy.json | 0 ...ApiManagementListProductSubscriptions.json | 0 .../examples/ApiManagementListProducts.json | 0 .../examples/ApiManagementListProperties.json | 0 .../examples/ApiManagementListRegions.json | 0 ...piManagementListServiceBySubscription.json | 0 ...ServiceBySubscriptionAndResourceGroup.json | 0 .../ApiManagementListSubscriptions.json | 0 .../ApiManagementListTagResources.json | 0 .../examples/ApiManagementListTags.json | 0 .../examples/ApiManagementListUserGroups.json | 0 .../ApiManagementListUserSubscriptions.json | 0 .../examples/ApiManagementListUsers.json | 0 .../ApiManagementListUsersIdentities.json | 0 ...ManagementPortalSettingsGetDelegation.json | 0 .../ApiManagementPortalSettingsGetSignIn.json | 0 .../ApiManagementPortalSettingsGetSignUp.json | 0 ...ManagementPortalSettingsPutDelegation.json | 0 .../ApiManagementPortalSettingsPutSignIn.json | 0 .../ApiManagementPortalSettingsPutSignUp.json | 0 ...agementPortalSettingsUpdateDelegation.json | 0 ...iManagementPortalSettingsUpdateSignIn.json | 0 ...iManagementPortalSettingsUpdateSignUp.json | 0 .../examples/ApiManagementRestoreService.json | 0 ...anagementServiceCheckNameAvailability.json | 0 .../ApiManagementServiceDeleteService.json | 0 ...mentServiceGetMultiRegionInternalVnet.json | 0 .../ApiManagementServiceGetNetworkStatus.json | 0 ...mentServiceGetNetworkStatusByLocation.json | 0 .../ApiManagementServiceGetService.json | 0 ...iManagementServiceGetServiceHavingMsi.json | 0 .../ApiManagementServiceGetSsoToken.json | 0 .../ApiManagementServiceUpdateHostName.json | 0 ...nagementServiceUploadProxyCertificate.json | 0 ...piManagementSubscriptionRegenerateKey.json | 0 ...piManagementTenantAccessRegenerateKey.json | 0 .../ApiManagementTenantAccessSyncState.json | 0 ...piManagementTenantConfigurationDeploy.json | 0 .../ApiManagementTenantConfigurationSave.json | 0 ...ManagementTenantConfigurationValidate.json | 0 .../examples/ApiManagementUpdateApi.json | 0 .../ApiManagementUpdateApiDiagnostic.json | 0 .../ApiManagementUpdateApiOperation.json | 0 .../ApiManagementUpdateApiRelease.json | 0 .../ApiManagementUpdateApiVersionSet.json | 0 ...piManagementUpdateAuthorizationServer.json | 0 .../examples/ApiManagementUpdateBackend.json | 0 .../ApiManagementUpdateDiagnostic.json | 0 .../ApiManagementUpdateEmailTemplate.json | 0 .../examples/ApiManagementUpdateGroup.json | 0 .../ApiManagementUpdateIdentityProvider.json | 0 .../examples/ApiManagementUpdateLogger.json | 0 ...ManagementUpdateOpenIdConnectProvider.json | 0 .../ApiManagementUpdateProductBasic.json | 0 .../examples/ApiManagementUpdateProperty.json | 0 .../ApiManagementUpdateQuotaCounterKey.json | 0 ...entUpdateQuotaCounterKeyByQuotaPeriod.json | 0 ...piManagementUpdateServiceDisableTls10.json | 0 ...nagementUpdateServicePublisherDetails.json | 0 .../ApiManagementUpdateSubscription.json | 0 .../examples/ApiManagementUpdateTag.json | 0 .../ApiManagementUpdateTenantAccess.json | 0 .../ApiManagementUpdateUserBasic.json | 0 .../ApiManagementUsersGenerateSsoUrl.json | 0 .../examples/ApiManagementUsersGetToken.json | 0 .../resource-manager/readme.go.md | 2 +- .../apimanagement/resource-manager/readme.md | 50 +++++++++---------- 312 files changed, 26 insertions(+), 26 deletions(-) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimanagement.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimapis.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimauthorizationservers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimbackends.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimcertificates.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimdeployment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimdiagnostics.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimemailtemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimgroups.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimidentityprovider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimissues.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimloggers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimnetworkstatus.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimnotifications.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimopenidconnectproviders.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimportalsettings.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimproducts.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimproperties.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimquotas.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimreports.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimsubscriptions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimtagresources.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimtags.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimtenant.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimusers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/apimversionsets.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementBackendReconnect.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateAILogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiIssue.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiIssueAttachment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiIssueComment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiOperationPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiRelease.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiRevision.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiSchema.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiTagDescription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiUsingSwaggerImport.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiUsingWadlImport.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiVersionSet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateApiWithOpenIdConnect.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateAuthorizationServer.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateBackendProxyBackend.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateBackendServiceFabric.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateBackup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateCertificate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateEHLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateEmailTemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateGroupExternal.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateGroupUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateIdentityProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateOpenIdConnectProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateOperationTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreatePolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProductApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProductBasic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProductGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProductPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProductTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateProperty.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateRecipientEmail.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateRecipientUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateService.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateServiceHavingMsi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateServiceWithSystemCertificates.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateSubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementCreateUserBasic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiIssue.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiRelease.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiSchema.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiTagDescription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteApiVersionSet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteAuthorizationServer.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteBackend.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteCertificate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteEmailTemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteGroupUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteIdentityProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteNotificationRecipientEmail.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteNotificationRecipientUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteOpenIdConnectProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteOperationPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteOperationTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeletePolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProduct.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProductApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProductGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProductPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProductTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteProperty.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteSubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementDeleteUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiContract.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiIssue.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiIssueAttachment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiIssueComment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiOperationPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiRelease.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiRevision.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiSchema.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiTagDescription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetApiVersionSet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetAuthorizationServer.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetBackend.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetCertificate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetEmailTemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetIdentityProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetNotification.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetOpenIdConnectProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetOperationTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetProduct.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetProductPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetProductTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetProductsForApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetProperty.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByGeo.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByProduct.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByRequest.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsBySubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByTime.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetReportsByUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetSubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTagDescriptionsForApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTagsForApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTagsForOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTagsForProduct.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetTenantAccess.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementGetUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiIssue.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiIssueAttachment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiIssueComment.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiOperationPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiRelease.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiSchema.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiTagDescription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadApiVersionSet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadAuthorizationServer.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadBackend.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadCertificate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadDelegationSettings.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadDiagnosticLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadEmailTemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadGroupUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadIdentityProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadNotificationRecipientEmail.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadNotificationRecipientUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadOpenIdConnectProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadOperationTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProduct.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProductApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProductGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProductPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProductTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadProperty.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadSignInSettings.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadSignUpSettings.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadSubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementHeadUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiDiagnosticLoggers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiDiagnostics.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiIssueAttachments.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiIssueComments.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiIssues.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiOperationPolicies.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiOperations.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiPolicies.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiReleases.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiRevisions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiSchemas.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApiVersionSets.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApis.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListApisByTags.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListAuthorizationServers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListBackends.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListCertificates.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListDiagnosticLoggers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListDiagnostics.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListEmailTemplates.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListGroupUsers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListGroups.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListIdentityProviders.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListIssues.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListLoggers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListNotificationRecipientEmail.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListNotificationRecipientUser.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListNotifications.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListOpenIdConnectProviders.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListOperations.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListOperationsByTags.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListPolicies.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListPolicySnippets.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProductApis.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProductGroups.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProductPolicy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProductSubscriptions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProducts.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListProperties.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListRegions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListServiceBySubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListSubscriptions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListTagResources.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListTags.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListUserGroups.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListUserSubscriptions.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListUsers.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementListUsersIdentities.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsGetDelegation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsGetSignIn.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsGetSignUp.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsPutDelegation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsPutSignIn.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsPutSignUp.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsUpdateDelegation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignIn.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignUp.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementRestoreService.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceCheckNameAvailability.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceDeleteService.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetService.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetServiceHavingMsi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceGetSsoToken.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceUpdateHostName.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementServiceUploadProxyCertificate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementSubscriptionRegenerateKey.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementTenantAccessRegenerateKey.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementTenantAccessSyncState.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementTenantConfigurationDeploy.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementTenantConfigurationSave.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementTenantConfigurationValidate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateApi.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateApiDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateApiOperation.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateApiRelease.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateApiVersionSet.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateAuthorizationServer.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateBackend.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateDiagnostic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateEmailTemplate.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateGroup.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateIdentityProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateLogger.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateOpenIdConnectProvider.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateProductBasic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateProperty.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateQuotaCounterKey.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateServiceDisableTls10.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateServicePublisherDetails.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateSubscription.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateTag.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateTenantAccess.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUpdateUserBasic.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUsersGenerateSsoUrl.json (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/{preview => stable}/2018-01-01/examples/ApiManagementUsersGetToken.json (100%) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimanagement.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimanagement.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimapis.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimauthorizationservers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimauthorizationservers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimauthorizationservers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimauthorizationservers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimbackends.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimcertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimcertificates.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimcertificates.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimcertificates.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimdeployment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimdiagnostics.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimemailtemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimemailtemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimemailtemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimemailtemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimgroups.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimidentityprovider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimidentityprovider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimidentityprovider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimidentityprovider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimissues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimissues.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimissues.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimissues.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimloggers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimloggers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimloggers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimnetworkstatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimnetworkstatus.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimnetworkstatus.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimnetworkstatus.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimnotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimnotifications.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimnotifications.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimnotifications.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimopenidconnectproviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimopenidconnectproviders.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimopenidconnectproviders.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimopenidconnectproviders.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimportalsettings.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimportalsettings.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimproperties.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimquotas.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimreports.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimsubscriptions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtagresources.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtags.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimusers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimversionsets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimversionsets.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/apimversionsets.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimversionsets.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementApplyNetworkConfigurationUpdates.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementBackendReconnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementBackendReconnect.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementBackendReconnect.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementBackendReconnect.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateAILogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateAILogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateAILogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateAILogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssue.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssue.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssue.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssueAttachment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssueAttachment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssueAttachment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssueComment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiIssueComment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiIssueComment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiOperationPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiOperationPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiOperationPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiPolicyNonXmlEncoded.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiRelease.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRelease.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiRelease.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiRevision.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiRevision.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiRevision.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiSchema.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiSchema.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiSchema.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiTagDescription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiTagDescription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiTagDescription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiUsingSwaggerImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiUsingSwaggerImport.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiUsingSwaggerImport.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiUsingSwaggerImport.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiUsingWadlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiUsingWadlImport.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiUsingWadlImport.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiUsingWadlImport.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiVersionSet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiVersionSet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiVersionSet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiWithOpenIdConnect.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiWithOpenIdConnect.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateApiWithOpenIdConnect.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateApiWithOpenIdConnect.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateAuthorizationServer.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateAuthorizationServer.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateAuthorizationServer.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackendProxyBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackendProxyBackend.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackendProxyBackend.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackendProxyBackend.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackendServiceFabric.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackendServiceFabric.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackendServiceFabric.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackendServiceFabric.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateBackup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateBackup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateCertificate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateCertificate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateCertificate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateEHLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateEHLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateEHLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateEHLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateEmailTemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateEmailTemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateEmailTemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroupExternal.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroupExternal.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroupExternal.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroupExternal.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroupUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateGroupUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateGroupUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateIdentityProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateIdentityProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateIdentityProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateMultiRegionServiceWithCustomHostname.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateOpenIdConnectProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateOpenIdConnectProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateOpenIdConnectProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateOperationTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateOperationTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateOperationTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreatePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreatePolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreatePolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreatePolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductBasic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductBasic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductBasic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProductTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProductTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProperty.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateProperty.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateProperty.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateRecipientEmail.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateRecipientEmail.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateRecipientEmail.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateRecipientUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateRecipientUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateRecipientUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateService.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateService.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateService.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateServiceHavingMsi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateServiceHavingMsi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateServiceHavingMsi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateServiceWithSystemCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateServiceWithSystemCertificates.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateServiceWithSystemCertificates.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateServiceWithSystemCertificates.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSoapPassThroughApiUsingWsdlImport.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSoapToRestApiUsingWsdlImport.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateSubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateSubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateUserBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateUserBasic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementCreateUserBasic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementCreateUserBasic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssue.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssue.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssue.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssueAttachment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiIssueComment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiRelease.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiRelease.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiRelease.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiSchema.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiSchema.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiSchema.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiTagDescription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiTagDescription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiTagDescription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiVersionSet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteApiVersionSet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteApiVersionSet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteAuthorizationServer.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteAuthorizationServer.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteAuthorizationServer.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteBackend.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteBackend.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteBackend.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteCertificate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteCertificate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteCertificate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteEmailTemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteEmailTemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteEmailTemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteGroupUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteGroupUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteGroupUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteIdentityProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteIdentityProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteIdentityProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteNotificationRecipientEmail.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteNotificationRecipientEmail.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteNotificationRecipientEmail.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteNotificationRecipientUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteNotificationRecipientUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteNotificationRecipientUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOpenIdConnectProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOpenIdConnectProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOpenIdConnectProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOperationPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOperationPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOperationPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOperationTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteOperationTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteOperationTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeletePolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeletePolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeletePolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeletePolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProduct.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProduct.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProduct.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProductTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProductTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProperty.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteProperty.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteProperty.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteSubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteSubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteSubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementDeleteUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementDeleteUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiContract.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiContract.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiContract.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiContract.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiExportInOpenApi2dot0.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssue.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssue.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssue.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssueAttachment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssueAttachment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssueAttachment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssueComment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiIssueComment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiIssueComment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiOperationPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiOperationPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiOperationPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiRelease.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRelease.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiRelease.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiRevision.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiRevision.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiRevision.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiSchema.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiSchema.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiSchema.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiTagDescription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiTagDescription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiTagDescription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiVersionSet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetApiVersionSet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetApiVersionSet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetAuthorizationServer.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetAuthorizationServer.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetAuthorizationServer.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetBackend.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetBackend.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetBackend.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetCertificate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetCertificate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetCertificate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetEmailTemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetEmailTemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetEmailTemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetIdentityProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetIdentityProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetIdentityProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetNotification.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetNotification.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetNotification.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetNotification.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetOpenIdConnectProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetOpenIdConnectProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetOpenIdConnectProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetOperationTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetOperationTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetOperationTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProduct.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProduct.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProduct.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductsForApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProductsForApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProductsForApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProperty.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetProperty.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetProperty.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByGeo.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByGeo.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByGeo.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByGeo.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByProduct.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByProduct.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByProduct.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByRequest.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByRequest.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByRequest.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByRequest.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsBySubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsBySubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsBySubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByTime.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByTime.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByTime.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByTime.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetReportsByUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetReportsByUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetSubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetSubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetSubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagDescriptionsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagDescriptionsForApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagDescriptionsForApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagDescriptionsForApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForProduct.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTagsForProduct.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTagsForProduct.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTenantAccess.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetTenantAccess.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetTenantAccess.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementGetUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssue.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssue.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssue.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssueAttachment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssueAttachment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssueAttachment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssueAttachment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssueComment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssueComment.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiIssueComment.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiIssueComment.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiOperationPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiOperationPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiOperationPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiOperationPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiRelease.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiRelease.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiRelease.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiSchema.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiSchema.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiSchema.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiSchema.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiTagDescription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiTagDescription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiTagDescription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiTagDescription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiVersionSet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadApiVersionSet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadApiVersionSet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadAuthorizationServer.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadAuthorizationServer.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadAuthorizationServer.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadBackend.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadBackend.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadBackend.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadCertificate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadCertificate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadCertificate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDelegationSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDelegationSettings.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDelegationSettings.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDelegationSettings.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDiagnosticLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDiagnosticLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadDiagnosticLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadDiagnosticLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadEmailTemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadEmailTemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadEmailTemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadGroupUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadGroupUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadGroupUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadGroupUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadIdentityProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadIdentityProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadIdentityProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadNotificationRecipientEmail.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadNotificationRecipientEmail.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadNotificationRecipientEmail.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadNotificationRecipientUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadNotificationRecipientUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadNotificationRecipientUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadOpenIdConnectProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadOpenIdConnectProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadOpenIdConnectProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadOperationTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadOperationTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadOperationTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadOperationTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProduct.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProduct.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProduct.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProduct.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProductTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProductTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProperty.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadProperty.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadProperty.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSignInSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSignInSettings.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSignInSettings.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSignInSettings.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSignUpSettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSignUpSettings.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSignUpSettings.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSignUpSettings.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadSubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadSubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementHeadUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementHeadUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiDiagnosticLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiDiagnosticLoggers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiDiagnosticLoggers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiDiagnosticLoggers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiDiagnostics.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiDiagnostics.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiDiagnostics.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssueAttachments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssueAttachments.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssueAttachments.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssueAttachments.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssueComments.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssueComments.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssueComments.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssueComments.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssues.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiIssues.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiIssues.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiOperationPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiOperationPolicies.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiOperationPolicies.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiOperationPolicies.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiOperations.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiOperations.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiOperations.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiPolicies.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiPolicies.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiPolicies.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiReleases.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiReleases.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiReleases.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiReleases.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiRevisions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiRevisions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiRevisions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiRevisions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiSchemas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiSchemas.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiSchemas.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiSchemas.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiVersionSets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiVersionSets.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApiVersionSets.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApiVersionSets.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApis.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApis.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApis.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApisByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApisByTags.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListApisByTags.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListApisByTags.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListAuthorizationServers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListAuthorizationServers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListAuthorizationServers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListAuthorizationServers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListBackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListBackends.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListBackends.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListBackends.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListCertificates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListCertificates.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListCertificates.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListCertificates.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListDiagnosticLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListDiagnosticLoggers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListDiagnosticLoggers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListDiagnosticLoggers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListDiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListDiagnostics.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListDiagnostics.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListDiagnostics.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListEmailTemplates.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListEmailTemplates.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListEmailTemplates.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListEmailTemplates.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListGroupUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListGroupUsers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListGroupUsers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListGroupUsers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListGroups.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListGroups.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListGroups.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListIdentityProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListIdentityProviders.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListIdentityProviders.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListIdentityProviders.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListIssues.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListIssues.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListIssues.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListIssues.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListLoggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListLoggers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListLoggers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListLoggers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotificationRecipientEmail.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotificationRecipientEmail.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotificationRecipientEmail.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotificationRecipientEmail.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotificationRecipientUser.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotificationRecipientUser.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotificationRecipientUser.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotificationRecipientUser.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotifications.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotifications.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListNotifications.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListNotifications.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOpenIdConnectProviders.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOpenIdConnectProviders.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOpenIdConnectProviders.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOperations.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOperations.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOperations.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOperations.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOperationsByTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOperationsByTags.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListOperationsByTags.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListOperationsByTags.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListPolicies.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListPolicies.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListPolicies.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListPolicies.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListPolicySnippets.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListPolicySnippets.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListPolicySnippets.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListPolicySnippets.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductApis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductApis.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductApis.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductApis.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductGroups.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductGroups.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductGroups.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductPolicy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductPolicy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductPolicy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductPolicy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductSubscriptions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProductSubscriptions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProductSubscriptions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProducts.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProducts.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProducts.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProperties.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListProperties.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListProperties.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListRegions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListRegions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListRegions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListRegions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListServiceBySubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListServiceBySubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListServiceBySubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListServiceBySubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListServiceBySubscriptionAndResourceGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSubscriptions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListSubscriptions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSubscriptions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListTagResources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListTagResources.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListTagResources.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListTagResources.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListTags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListTags.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListTags.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListTags.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUserGroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUserGroups.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUserGroups.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUserGroups.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUserSubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUserSubscriptions.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUserSubscriptions.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUserSubscriptions.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUsers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUsers.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUsers.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUsers.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUsersIdentities.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUsersIdentities.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementListUsersIdentities.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListUsersIdentities.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetDelegation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetDelegation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetDelegation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetSignIn.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetSignIn.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetSignIn.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetSignUp.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsGetSignUp.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsGetSignUp.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutDelegation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutDelegation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutDelegation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutSignIn.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutSignIn.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutSignIn.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutSignUp.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsPutSignUp.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsPutSignUp.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateDelegation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateDelegation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateDelegation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateDelegation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignIn.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignIn.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignIn.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignIn.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignUp.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignUp.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignUp.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementPortalSettingsUpdateSignUp.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementRestoreService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementRestoreService.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementRestoreService.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementRestoreService.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceCheckNameAvailability.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceCheckNameAvailability.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceCheckNameAvailability.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceCheckNameAvailability.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceDeleteService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceDeleteService.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceDeleteService.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceDeleteService.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetMultiRegionInternalVnet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetNetworkStatus.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetNetworkStatusByLocation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetService.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetService.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetService.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetService.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetServiceHavingMsi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetServiceHavingMsi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetServiceHavingMsi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetServiceHavingMsi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetSsoToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetSsoToken.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceGetSsoToken.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceGetSsoToken.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceUpdateHostName.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceUpdateHostName.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceUpdateHostName.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceUpdateHostName.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceUploadProxyCertificate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceUploadProxyCertificate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementServiceUploadProxyCertificate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementServiceUploadProxyCertificate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementSubscriptionRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementSubscriptionRegenerateKey.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementSubscriptionRegenerateKey.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementSubscriptionRegenerateKey.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantAccessRegenerateKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantAccessRegenerateKey.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantAccessRegenerateKey.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantAccessRegenerateKey.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantAccessSyncState.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantAccessSyncState.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantAccessSyncState.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantAccessSyncState.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationDeploy.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationDeploy.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationDeploy.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationDeploy.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationSave.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationSave.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationSave.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationSave.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationValidate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationValidate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementTenantConfigurationValidate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementTenantConfigurationValidate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApi.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApi.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApi.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApi.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiOperation.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiOperation.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiOperation.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiOperation.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiRelease.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiRelease.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiRelease.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiRelease.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiVersionSet.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiVersionSet.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateApiVersionSet.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiVersionSet.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateAuthorizationServer.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateAuthorizationServer.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateAuthorizationServer.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateAuthorizationServer.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateBackend.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateBackend.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateBackend.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateBackend.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateDiagnostic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateDiagnostic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateDiagnostic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateDiagnostic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateEmailTemplate.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateEmailTemplate.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateEmailTemplate.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateEmailTemplate.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateGroup.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateGroup.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateGroup.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateGroup.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateIdentityProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateIdentityProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateIdentityProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateIdentityProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateLogger.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateLogger.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateLogger.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateLogger.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateOpenIdConnectProvider.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateOpenIdConnectProvider.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateOpenIdConnectProvider.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateProductBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateProductBasic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateProductBasic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateProductBasic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateProperty.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateProperty.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateProperty.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateProperty.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateQuotaCounterKey.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateQuotaCounterKey.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateQuotaCounterKey.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateServiceDisableTls10.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateServiceDisableTls10.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateServiceDisableTls10.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateServiceDisableTls10.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateServicePublisherDetails.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateServicePublisherDetails.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateServicePublisherDetails.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateServicePublisherDetails.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateSubscription.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateSubscription.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateSubscription.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateSubscription.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateTag.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateTag.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateTag.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateTag.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateTenantAccess.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateTenantAccess.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateTenantAccess.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateTenantAccess.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateUserBasic.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateUserBasic.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUpdateUserBasic.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateUserBasic.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUsersGenerateSsoUrl.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUsersGenerateSsoUrl.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUsersGenerateSsoUrl.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUsersGenerateSsoUrl.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUsersGetToken.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUsersGetToken.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-01-01/examples/ApiManagementUsersGetToken.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUsersGetToken.json diff --git a/specification/apimanagement/resource-manager/readme.go.md b/specification/apimanagement/resource-manager/readme.go.md index d569b68cb750..c2745e3fdc61 100644 --- a/specification/apimanagement/resource-manager/readme.go.md +++ b/specification/apimanagement/resource-manager/readme.go.md @@ -35,7 +35,7 @@ These settings apply only when `--tag=package-2018-01 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-01' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-01-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-01-01/$(namespace) ``` ### Tag: package-2017-03 and go diff --git a/specification/apimanagement/resource-manager/readme.md b/specification/apimanagement/resource-manager/readme.md index 9ac8d31299df..c6417823ac04 100644 --- a/specification/apimanagement/resource-manager/readme.md +++ b/specification/apimanagement/resource-manager/readme.md @@ -81,31 +81,31 @@ These settings apply only when `--tag=package-2018-01` is specified on the comma ``` yaml $(tag) == 'package-2018-01' input-file: -- Microsoft.ApiManagement/preview/2018-01-01/apimanagement.json -- Microsoft.ApiManagement/preview/2018-01-01/apimapis.json -- Microsoft.ApiManagement/preview/2018-01-01/apimauthorizationservers.json -- Microsoft.ApiManagement/preview/2018-01-01/apimbackends.json -- Microsoft.ApiManagement/preview/2018-01-01/apimcertificates.json -- Microsoft.ApiManagement/preview/2018-01-01/apimdeployment.json -- Microsoft.ApiManagement/preview/2018-01-01/apimdiagnostics.json -- Microsoft.ApiManagement/preview/2018-01-01/apimemailtemplate.json -- Microsoft.ApiManagement/preview/2018-01-01/apimgroups.json -- Microsoft.ApiManagement/preview/2018-01-01/apimidentityprovider.json -- Microsoft.ApiManagement/preview/2018-01-01/apimloggers.json -- Microsoft.ApiManagement/preview/2018-01-01/apimnotifications.json -- Microsoft.ApiManagement/preview/2018-01-01/apimnetworkstatus.json -- Microsoft.ApiManagement/preview/2018-01-01/apimopenidconnectproviders.json -- Microsoft.ApiManagement/preview/2018-01-01/apimportalsettings.json -- Microsoft.ApiManagement/preview/2018-01-01/apimproducts.json -- Microsoft.ApiManagement/preview/2018-01-01/apimproperties.json -- Microsoft.ApiManagement/preview/2018-01-01/apimquotas.json -- Microsoft.ApiManagement/preview/2018-01-01/apimreports.json -- Microsoft.ApiManagement/preview/2018-01-01/apimsubscriptions.json -- Microsoft.ApiManagement/preview/2018-01-01/apimtagresources.json -- Microsoft.ApiManagement/preview/2018-01-01/apimtags.json -- Microsoft.ApiManagement/preview/2018-01-01/apimtenant.json -- Microsoft.ApiManagement/preview/2018-01-01/apimusers.json -- Microsoft.ApiManagement/preview/2018-01-01/apimversionsets.json +- Microsoft.ApiManagement/stable/2018-01-01/apimanagement.json +- Microsoft.ApiManagement/stable/2018-01-01/apimapis.json +- Microsoft.ApiManagement/stable/2018-01-01/apimauthorizationservers.json +- Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json +- Microsoft.ApiManagement/stable/2018-01-01/apimcertificates.json +- Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json +- Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json +- Microsoft.ApiManagement/stable/2018-01-01/apimemailtemplate.json +- Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json +- Microsoft.ApiManagement/stable/2018-01-01/apimidentityprovider.json +- Microsoft.ApiManagement/stable/2018-01-01/apimloggers.json +- Microsoft.ApiManagement/stable/2018-01-01/apimnotifications.json +- Microsoft.ApiManagement/stable/2018-01-01/apimnetworkstatus.json +- Microsoft.ApiManagement/stable/2018-01-01/apimopenidconnectproviders.json +- Microsoft.ApiManagement/stable/2018-01-01/apimportalsettings.json +- Microsoft.ApiManagement/stable/2018-01-01/apimproducts.json +- Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json +- Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json +- Microsoft.ApiManagement/stable/2018-01-01/apimreports.json +- Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json +- Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json +- Microsoft.ApiManagement/stable/2018-01-01/apimtags.json +- Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json +- Microsoft.ApiManagement/stable/2018-01-01/apimusers.json +- Microsoft.ApiManagement/stable/2018-01-01/apimversionsets.json ``` ## Suppression From 4769aa2bc9b091c5a74c7aca2a291c46b9d86389 Mon Sep 17 00:00:00 2001 From: Abhinav Ghai Date: Fri, 2 Nov 2018 09:55:56 -0700 Subject: [PATCH 085/464] Revert Software List and GET from GuestConfig RP (private preview only) (#4380) * Add list and get software to GuestConfiguration * Use newer API version for software * Revert software Swagger spec since these are private preview only --- .../examples/getSoftware.json | 25 --- .../examples/listSoftware.json | 49 ------ .../guestconfiguration.json | 146 ------------------ 3 files changed, 220 deletions(-) delete mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json delete mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json deleted file mode 100644 index 1322178b366c..000000000000 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getSoftware.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "mySubscriptionId", - "resourceGroupName": "myResourceGroupName", - "vmName": "myVMName", - "softwareId": "57b536b9-0945-486a-b694-3e3151541452", - "api-version": "2018-01-20-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/57b536b9-0945-486a-b694-3e3151541452", - "name": "57b536b9-0945-486a-b694-3e3151541452", - "type": "Microsoft.GuestConfiguration/software", - "properties": { - "name": "Microsoft SQL Server 2017", - "version": "17.1.2034.35", - "publisher": "Microsoft Corporation", - "lastRefreshDate": "2018-01-01T04:35:00Z" - } - } - } - } - } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json deleted file mode 100644 index 897fce4dbdad..000000000000 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listSoftware.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "subscriptionId": "mySubscriptionId", - "resourceGroupName": "myResourceGroupName", - "vmName": "myVMName", - "softwareId": "57b536b9-0945-486a-b694-3e3151541452", - "api-version": "2018-01-20-preview" - }, - "responses": { - "200": { - "headers": {}, - "body": [ - { - "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/57b536b9-0945-486a-b694-3e3151541452", - "name": "57b536b9-0945-486a-b694-3e3151541452", - "type": "Microsoft.GuestConfiguration/software", - "properties": { - "name": "Microsoft SQL Server 2017", - "version": "17.1.2034.35", - "publisher": "Microsoft Corporation", - "lastRefreshDate": "2018-01-01T04:35:00Z" - } - }, - { - "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/67b536b9-0945-486a-b694-3e3151541452", - "name": "67b536b9-0945-486a-b694-3e3151541452", - "type": "Microsoft.GuestConfiguration/software", - "properties": { - "name": "Slack", - "version": "3.3.3", - "publisher": "Slack Technologies", - "lastRefreshDate": "2018-01-01T04:35:00Z" - } - }, - { - "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myVMName/providers/Microsoft.GuestConfiguration/software/77b536b9-0945-486a-b694-3e3151541452", - "name": "77b536b9-0945-486a-b694-3e3151541452", - "type": "Microsoft.GuestConfiguration/software", - "properties": { - "name": "Node.js", - "version": "8.12.0", - "publisher": "Node.js Foundation", - "lastRefreshDate": "2018-01-01T04:35:00Z" - } - } - ] - } - } - } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json index 4290eff7f2d0..d8ebd72c88e2 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json @@ -354,100 +354,6 @@ "application/json" ] } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/software/{softwareId}": { - "get": { - "tags": [ - "Software" - ], - "operationId": "Software_Get", - "description": "Get information about a software installed on the given virtual machine", - "x-ms-examples": { - "Get a software": { - "$ref": "./examples/getSoftware.json" - } - }, - "parameters": [ - { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" - }, - { - "name": "softwareId", - "in": "path", - "required": true, - "type": "string", - "description": "The software Id." - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Software" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/software": { - "get": { - "tags": [ - "Software" - ], - "operationId": "Software_List", - "description": "Get information about list of software installed on the given virtual machine", - "x-ms-examples": { - "List software": { - "$ref": "./examples/listSoftware.json" - } - }, - "parameters": [ - { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SoftwareList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } } }, "definitions": { @@ -871,58 +777,6 @@ } }, "description": "Reason and code for the compliance of the guest configuration assignment resource." - }, - "SoftwareList": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Software" - }, - "description": "The list of software installed on a given virtual machine." - } - }, - "description": "The list of software installed on a given virtual machine." - }, - "Software": { - "properties": { - "properties": { - "x-ms-client-flatten": false, - "$ref": "#/definitions/SoftwareProperties", - "description": "Properties of the software." - } - }, - "allOf": [ - { - "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" - } - ], - "description": "Describes a specific software installed on the given virtual machine." - }, - "SoftwareProperties": { - "description": "Properties of the software object.", - "properties": { - "name": { - "type": "string", - "readOnly": true, - "description": "Name of the software" - }, - "version": { - "type": "string", - "readOnly": true, - "description": "Version of the software" - }, - "publisher": { - "type": "string", - "readOnly": true, - "description": "Publisher of the software" - }, - "lastRefreshDate": { - "type": "string", - "readOnly": true, - "description": "Last refresh date for the software" - } - } } }, "parameters": {} From 301939dccb105cbce5e759d5e7f9886b65c404da Mon Sep 17 00:00:00 2001 From: vchske Date: Fri, 2 Nov 2018 11:22:51 -0700 Subject: [PATCH 086/464] Explicitly add MongoDbTasks.json to 2018-07-15 (#4358) * Update MongoDbTasks.json * Update readme.md --- specification/datamigration/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 4b8ab5ac8c3f..8a725f2e71a0 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -74,6 +74,7 @@ input-file: - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlDbTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrationValidation.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Projects.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Services.json From 1492026317c61dfffee046f454b1d064d98a2367 Mon Sep 17 00:00:00 2001 From: mozehgir <32183061+mozehgir@users.noreply.github.com> Date: Fri, 2 Nov 2018 11:29:28 -0700 Subject: [PATCH 087/464] Update openapi-authoring-automated-guidelines.md (#4381) --- .../openapi-authoring-automated-guidelines.md | 278 +++++++++--------- 1 file changed, 139 insertions(+), 139 deletions(-) diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 326b84b08960..e8798bb49a47 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -33,33 +33,33 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | Id | Rule Name | Applies to | | --- | --- | --- | | [R3012](#r3012) | [APIVersionPattern](#r3012) | ARM OpenAPI(swagger) specs | -| [R3019](#R3019) | [ARMResourcePropertiesBag](#R3019) | ARM and Data plane OpenAPI(swagger) specs | -| [R3014](#R3014) | [BodyPropertiesNamesCamelCase](#R3014) | ARM and Data plane OpenAPI(swagger) specs | -| [R3016](#R3016) | [DefinitionsPropertiesNamesCamelCase](#R3016) | ARM and Data plane OpenAPI(swagger) specs | -| [R3006](#R3006) | [BodyTopLevelProperties](#R3006) | ARM OpenAPI(swagger) specs | -| [R3008](#R3008) | [CollectionObjectPropertiesNaming](#R3008) | ARM and Data plane OpenAPI(swagger) specs | -| [R2044](#R2044) | [InvalidVerbUsed](#R2044) | ARM and Data plane OpenAPI(swagger) specs | -| [R3023](#R3023) | [OperationsAPIImplementation](#R3023) | ARM OpenAPI(swagger) specs | -| [R3007](#R3007) | [PutGetPatchResponseSchema](#R3007) | ARM and Data plane OpenAPI(swagger) specs | -| [R3025](#R3025) | [TrackedResourceGetOperation](#R3025) | ARM OpenAPI(swagger) specs | -| [R3026](#R3026) | [TrackedResourcePatchOperation](#R3026) | ARM OpenAPI(swagger) specs | -| [R2059](#R2059) | [UniqueResourcePaths](#R2059) | ARM OpenAPI(swagger) specs | -| [R2016](#R2016) | [PatchBodyParametersSchema](#R2016) | ARM and Data plane OpenAPI(swagger) specs | -| [R2062](#R2062) | [XmsResourceInPutResponse](#R2062) | ARM OpenAPI(swagger) specs | -| [R3027](#R3027) | [TrackedResourceListByResourceGroup](#R3027) | ARM OpenAPI(swagger) specs | -| [R3028](#R3028) | [TrackedResourceListBySubscription](#R3028) | ARM OpenAPI(swagger) specs | -| [R3011](#R3011) | [DescriptionMustNotBeNodeName](#R3011) | ARM and Data plane OpenAPI(swagger) specs | -| [R2020](#R2020) | [RequiredPropertiesMissingInResourceModel](#R2020) | ARM OpenAPI(swagger) specs | +| [R3019](#r3019) | [ARMResourcePropertiesBag](#r3019) | ARM and Data plane OpenAPI(swagger) specs | +| [R3014](#r3014) | [BodyPropertiesNamesCamelCase](#r3014) | ARM and Data plane OpenAPI(swagger) specs | +| [R3016](#r3016) | [DefinitionsPropertiesNamesCamelCase](#r3016) | ARM and Data plane OpenAPI(swagger) specs | +| [R3006](#r3006) | [BodyTopLevelProperties](#r3006) | ARM OpenAPI(swagger) specs | +| [R3008](#r3008) | [CollectionObjectPropertiesNaming](#r3008) | ARM and Data plane OpenAPI(swagger) specs | +| [R2044](#r2044) | [InvalidVerbUsed](#r2044) | ARM and Data plane OpenAPI(swagger) specs | +| [R3023](#r3023) | [OperationsAPIImplementation](#r3023) | ARM OpenAPI(swagger) specs | +| [R3007](#r3007) | [PutGetPatchResponseSchema](#r3007) | ARM and Data plane OpenAPI(swagger) specs | +| [R3025](#r3025) | [TrackedResourceGetOperation](#r3025) | ARM OpenAPI(swagger) specs | +| [R3026](#r3026) | [TrackedResourcePatchOperation](#r3026) | ARM OpenAPI(swagger) specs | +| [R2059](#r2059) | [UniqueResourcePaths](#r2059) | ARM OpenAPI(swagger) specs | +| [R2016](#r2016) | [PatchBodyParametersSchema](#r2016) | ARM and Data plane OpenAPI(swagger) specs | +| [R2062](#r2062) | [XmsResourceInPutResponse](#r2062) | ARM OpenAPI(swagger) specs | +| [R3027](#r3027) | [TrackedResourceListByResourceGroup](#r3027) | ARM OpenAPI(swagger) specs | +| [R3028](#r3028) | [TrackedResourceListBySubscription](#r3028) | ARM OpenAPI(swagger) specs | +| [R3011](#r3011) | [DescriptionMustNotBeNodeName](#r3011) | ARM and Data plane OpenAPI(swagger) specs | +| [R2020](#r2020) | [RequiredPropertiesMissingInResourceModel](#r2020) | ARM OpenAPI(swagger) specs | #### ARM Warnings | Id | Rule Name | Applies to | | --- | --- | --- | -| [R3018](#R3018) | [EnumInsteadOfBoolean](#R3018) | ARM and Data plane OpenAPI(swagger) specs | -| [R3017](#R3017) | [GuidUsage](#R3017) | ARM and Data plane OpenAPI(swagger) specs | -| [R2057](#R2057) | [InvalidSkuModel](#R2057) | ARM OpenAPI(swagger) specs | -| [R3010](#R3010) | [TrackedResourceListByImmediateParent](#R3010) | ARM OpenAPI(swagger) specs | -| [R2004](#R2004) | [NonApplicationJsonType](#R2004) | ARM OpenAPI(swagger) specs | +| [R3018](#r3018) | [EnumInsteadOfBoolean](#r3018) | ARM and Data plane OpenAPI(swagger) specs | +| [R3017](#r3017) | [GuidUsage](#r3017) | ARM and Data plane OpenAPI(swagger) specs | +| [R2057](#r2057) | [InvalidSkuModel](#r2057) | ARM OpenAPI(swagger) specs | +| [R3010](#r3010) | [TrackedResourceListByImmediateParent](#r3010) | ARM OpenAPI(swagger) specs | +| [R2004](#r2004) | [NonApplicationJsonType](#r2004) | ARM OpenAPI(swagger) specs | ### SDK Violations @@ -67,57 +67,57 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | Id | Rule Name | Applies to | | --- | --- | --- | -| [R2024](#R2024) | [AnonymousBodyParameter](#R2024) | ARM and Data plane OpenAPI(swagger) specs | -| [R2026](#R2026) | [AvoidAnonymousTypes](#R2026) | ARM and Data plane OpenAPI(swagger) specs | -| [R2014](#R2014) | [SubscriptionIdParameterInOperations](#R2014) | ARM and Data plane OpenAPI(swagger) specs | -| [R2027](#R2027) | [DefaultMustBeInEnum](#R2027) | ARM and Data plane OpenAPI(swagger) specs | -| [R1001](#R1001) | [OperationIdNounInVerb](#R1001) | ARM and Data plane OpenAPI(swagger) specs | -| [R2055](#R2055) | [OneUnderscoreInOperationId](#R2055) | ARM and Data plane OpenAPI(swagger) specs | -| [R2003](#R2003) | [ValidFormats](#R2003) | ARM and Data plane OpenAPI(swagger) specs | -| [R2005](#R2005) | [LongRunningResponseStatusCode](#R2005) | ARM and Data plane OpenAPI(swagger) specs | -| [R2008](#R2008) | [MutabilityWithReadOnlyRule](#R2008) | ARM and Data plane OpenAPI(swagger) specs | -| [R2025](#R2025) | [NextLinkPropertyMustExist](#R2025) | ARM and Data plane OpenAPI(swagger) specs | -| [R2028](#R2028) | [NonEmptyClientName](#R2028) | ARM and Data plane OpenAPI(swagger) specs | -| [R2060](#R2060) | [PageableRequires200Response](#R2060) | ARM and Data plane OpenAPI(swagger) specs | -| [R2019](#R2019) | [ResourceHasXMsResourceEnabled](#R2019) | ARM OpenAPI(swagger) specs | -| [R2058](#R2058) | [XmsPathsMustOverloadPaths](#R2058) | ARM and Data plane OpenAPI(swagger) specs | -| [R2012](#R2012) | [XmsClientNameParameter](#R2012) | ARM and Data plane OpenAPI(swagger) specs | -| [R2013](#R2013) | [XmsClientNameProperty](#R2013) | ARM and Data plane OpenAPI(swagger) specs | -| [R2047](#R2047) | [NamePropertyDefinitionInParameter](#R2047) | ARM and Data plane OpenAPI(swagger) specs | -| [R2056](#R2056) | [RequiredReadOnlyProperties](#R2056) | ARM and Data plane OpenAPI(swagger) specs | -| [R2054](#R2054) | [SecurityDefinitionsStructure](#R2054) | ARM OpenAPI(swagger) specs | -| [R2006](#R2006) | [ControlCharactersNotAllowed](#R2006) | ARM and Data plane OpenAPI(swagger) specs | -| [R2009](#R2009) | [ArraySchemaMustHaveItems](#R2009) | ARM and Data plane OpenAPI(swagger) specs | -| [R3013](#R3013) | [DeleteMustNotHaveRequestBody](#R3013) | ARM and Data plane OpenAPI(swagger) specs | -| [R4001](#R4001) | [XmsParameterLocation](#R4001) | ARM and Data plan OpenAPI(swagger) specs | +| [R2024](#r2024) | [AnonymousBodyParameter](#r2024) | ARM and Data plane OpenAPI(swagger) specs | +| [R2026](#r2026) | [AvoidAnonymousTypes](#r2026) | ARM and Data plane OpenAPI(swagger) specs | +| [R2014](#r2014) | [SubscriptionIdParameterInOperations](#r2014) | ARM and Data plane OpenAPI(swagger) specs | +| [R2027](#r2027) | [DefaultMustBeInEnum](#r2027) | ARM and Data plane OpenAPI(swagger) specs | +| [R1001](#r1001) | [OperationIdNounInVerb](#r1001) | ARM and Data plane OpenAPI(swagger) specs | +| [R2055](#r2055) | [OneUnderscoreInOperationId](#r2055) | ARM and Data plane OpenAPI(swagger) specs | +| [R2003](#r2003) | [ValidFormats](#r2003) | ARM and Data plane OpenAPI(swagger) specs | +| [R2005](#r2005) | [LongRunningResponseStatusCode](#r2005) | ARM and Data plane OpenAPI(swagger) specs | +| [R2008](#r2008) | [MutabilityWithReadOnlyRule](#r2008) | ARM and Data plane OpenAPI(swagger) specs | +| [R2025](#r2025) | [NextLinkPropertyMustExist](#r2025) | ARM and Data plane OpenAPI(swagger) specs | +| [R2028](#r2028) | [NonEmptyClientName](#r2028) | ARM and Data plane OpenAPI(swagger) specs | +| [R2060](#r2060) | [PageableRequires200Response](#r2060) | ARM and Data plane OpenAPI(swagger) specs | +| [R2019](#r2019) | [ResourceHasXMsResourceEnabled](#r2019) | ARM OpenAPI(swagger) specs | +| [R2058](#r2058) | [XmsPathsMustOverloadPaths](#r2058) | ARM and Data plane OpenAPI(swagger) specs | +| [R2012](#r2012) | [XmsClientNameParameter](#r2012) | ARM and Data plane OpenAPI(swagger) specs | +| [R2013](#r2013) | [XmsClientNameProperty](#r2013) | ARM and Data plane OpenAPI(swagger) specs | +| [R2047](#r2047) | [NamePropertyDefinitionInParameter](#r2047) | ARM and Data plane OpenAPI(swagger) specs | +| [R2056](#r2056) | [RequiredReadOnlyProperties](#r2056) | ARM and Data plane OpenAPI(swagger) specs | +| [R2054](#r2054) | [SecurityDefinitionsStructure](#r2054) | ARM OpenAPI(swagger) specs | +| [R2006](#r2006) | [ControlCharactersNotAllowed](#r2006) | ARM and Data plane OpenAPI(swagger) specs | +| [R2009](#r2009) | [ArraySchemaMustHaveItems](#r2009) | ARM and Data plane OpenAPI(swagger) specs | +| [R3013](#r3013) | [DeleteMustNotHaveRequestBody](#r3013) | ARM and Data plane OpenAPI(swagger) specs | +| [R4001](#r4001) | [XmsParameterLocation](#r4001) | ARM and Data plan OpenAPI(swagger) specs | #### SDK Warnings | Id | Rule Name | Applies to | | --- | --- | --- | -| [R4000](#R4000-2) | [ParameterDescriptionRequired](#R4000-2) | ARM and Data plane OpenAPI(swagger) specs | -| [R4000](#R4000-3) | [DescriptiveDescriptionRequired](#R4000-3) | ARM and Data plane OpenAPI(swagger) specs | -| [R4000](#R4000-4) | [DescriptionAndTitleMissing](#R4000-4) | ARM and Data plane OpenAPI(swagger) specs | -| [R4000](#R4000-5) | [OperationDescriptionOrSummaryRequired](#R4000-5) | ARM and Data plane OpenAPI(swagger) specs | -| [R2001](#R2001) | [AvoidNestedProperties](#R2001) | ARM and Data plane OpenAPI(swagger) specs | -| [R4002](#R4002) | [LocationMustHaveXmsMutability](#R4002) | ARM OpenAPI(swagger) specs | -| [R2066](#R2066) | [PostOperationIdContainsUrlVerb](#R2066) | ARM and Data plane OpenAPI(swagger) specs | -| [R2015](#R2015) | [ParameterNotDefinedInGlobalParameters](#R2015) | ARM and Data plane OpenAPI(swagger) specs | -| [R1010](#R1010) | [AvoidMSDNReferences](#R1010) | ARM and Data plane OpenAPI(swagger) specs | -| [R2017](#R2017) | [PutRequestResponseScheme](#R2017) | ARM and Data plane OpenAPI(swagger) specs | -| [R1009](#R1009) | [DeleteInOperationName](#R1009) | ARM and Data plane OpenAPI(swagger) specs | -| [R1005](#R1005) | [GetInOperationName](#R1005) | ARM and Data plane OpenAPI(swagger) specs | -| [R1003](#R1003) | [ListInOperationName](#R1003) | ARM and Data plane OpenAPI(swagger) specs | -| [R1006](#R1006) | [PutInOperationName](#R1006) | ARM and Data plane OpenAPI(swagger) specs | -| [R1007](#R1007) | [PatchInOperationName](#R1007) | ARM and Data plane OpenAPI(swagger) specs | -| [R1011](#R1011) | [HttpsSupportedScheme](#R1011) | ARM OpenAPI(swagger) specs | -| [R2065](#R2065) | [LicenseHeaderMustNotBeSpecified](#R2065) | ARM and Data plane OpenAPI(swagger) specs | -| [R2018](#R2018) | [XmsEnumValidation](#R2018) | ARM and Data plane OpenAPI(swagger) specs | -| [R3060](#R3060) | [XmsPageableListByRGAndSubscriptions](#R3060) | ARM OpenAPI(swagger) specs | -| [R2063](#R2063) | [OperationIdNounConflictingModelNames](#R2063) | ARM and Data plane OpenAPI(swagger) specs | -| [R2064](#R2064) | [LROStatusCodesReturnTypeSchema](#R2064) | ARM and Data plane OpenAPI(swagger) specs | -| [R2023](#R2023) | [SummaryAndDescriptionMustNotBeSame](#R2023) | ARM and Data plane OpenAPI(swagger) specs | -| [R2010](#R2010) | [LongRunningOperationsOptionsValidator](#R2010) | ARM and Data plane OpenAPI(swagger) specs | +| [R4000](#r4000-2) | [ParameterDescriptionRequired](#r4000-2) | ARM and Data plane OpenAPI(swagger) specs | +| [R4000](#r4000-3) | [DescriptiveDescriptionRequired](#r4000-3) | ARM and Data plane OpenAPI(swagger) specs | +| [R4000](#r4000-4) | [DescriptionAndTitleMissing](#r4000-4) | ARM and Data plane OpenAPI(swagger) specs | +| [R4000](#r4000-5) | [OperationDescriptionOrSummaryRequired](#r4000-5) | ARM and Data plane OpenAPI(swagger) specs | +| [R2001](#r2001) | [AvoidNestedProperties](#r2001) | ARM and Data plane OpenAPI(swagger) specs | +| [R4002](#r4002) | [LocationMustHaveXmsMutability](#r4002) | ARM OpenAPI(swagger) specs | +| [R2066](#r2066) | [PostOperationIdContainsUrlVerb](#r2066) | ARM and Data plane OpenAPI(swagger) specs | +| [R2015](#r2015) | [ParameterNotDefinedInGlobalParameters](#r2015) | ARM and Data plane OpenAPI(swagger) specs | +| [R1010](#r1010) | [AvoidMSDNReferences](#r1010) | ARM and Data plane OpenAPI(swagger) specs | +| [R2017](#r2017) | [PutRequestResponseScheme](#r2017) | ARM and Data plane OpenAPI(swagger) specs | +| [R1009](#r1009) | [DeleteInOperationName](#r1009) | ARM and Data plane OpenAPI(swagger) specs | +| [R1005](#r1005) | [GetInOperationName](#r1005) | ARM and Data plane OpenAPI(swagger) specs | +| [R1003](#r1003) | [ListInOperationName](#r1003) | ARM and Data plane OpenAPI(swagger) specs | +| [R1006](#r1006) | [PutInOperationName](#r1006) | ARM and Data plane OpenAPI(swagger) specs | +| [R1007](#r1007) | [PatchInOperationName](#r1007) | ARM and Data plane OpenAPI(swagger) specs | +| [R1011](#r1011) | [HttpsSupportedScheme](#r1011) | ARM OpenAPI(swagger) specs | +| [R2065](#r2065) | [LicenseHeaderMustNotBeSpecified](#r2065) | ARM and Data plane OpenAPI(swagger) specs | +| [R2018](#r2018) | [XmsEnumValidation](#r2018) | ARM and Data plane OpenAPI(swagger) specs | +| [R3060](#r3060) | [XmsPageableListByRGAndSubscriptions](#r3060) | ARM OpenAPI(swagger) specs | +| [R2063](#r2063) | [OperationIdNounConflictingModelNames](#r2063) | ARM and Data plane OpenAPI(swagger) specs | +| [R2064](#r2064) | [LROStatusCodesReturnTypeSchema](#r2064) | ARM and Data plane OpenAPI(swagger) specs | +| [R2023](#r2023) | [SummaryAndDescriptionMustNotBeSame](#r2023) | ARM and Data plane OpenAPI(swagger) specs | +| [R2010](#r2010) | [LongRunningOperationsOptionsValidator](#r2010) | ARM and Data plane OpenAPI(swagger) specs | ### Documentation @@ -125,7 +125,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | Id | Rule Name | Applies to | | --- | --- | --- | -| [D5001](#D5001) | [XmsExamplesRequired](#D5001) | ARM and Data plane OpenAPI(swagger) specs | +| [D5001](#d5001) | [XmsExamplesRequired](#d5001) | ARM and Data plane OpenAPI(swagger) specs | ## Rule Descriptions @@ -165,10 +165,10 @@ The date MAY optionally be followed by one of: Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3014 BodyPropertiesNamesCamelCase - Please refer to [R3016](#R3016) +### R3014 BodyPropertiesNamesCamelCase + Please refer to [R3016](#r3016) -### R3016 DefinitionsPropertiesNamesCamelCase +### R3016 DefinitionsPropertiesNamesCamelCase **Category** : ARM Error **Applies to** : ARM and Data Plane OpenAPI(swagger) specs @@ -207,7 +207,7 @@ For more capitalization guidance, see: [https://msdn.microsoft.com/en-us/library Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3025 TrackedResourceGetOperation +### R3025 TrackedResourceGetOperation **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -228,7 +228,7 @@ If the resource pointed by the rule is not a tracked resource, this warning may Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3026 TrackedResourcePatchOperation +### R3026 TrackedResourcePatchOperation **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -249,7 +249,7 @@ If the resource pointed by the rule is not a tracked resource, this warning may Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3027 TrackedResourceListByResourceGroup +### R3027 TrackedResourceListByResourceGroup **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -270,7 +270,7 @@ If the resource pointed by the rule is not a tracked resource or the operation t Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3028 TrackedResourceListBySubscription +### R3028 TrackedResourceListBySubscription **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -291,7 +291,7 @@ If the resource pointed by the rule is not a tracked resource or the operation t Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3010 TrackedResourceListByImmediateParent +### R3010 TrackedResourceListByImmediateParent **Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -312,7 +312,7 @@ If the resource pointed by the rule is not a tracked resource this warning may b Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3018 EnumInsteadOfBoolean +### R3018 EnumInsteadOfBoolean **Category** : ARM Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -331,7 +331,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4002 LocationMustHaveXmsMutability +### R4002 LocationMustHaveXmsMutability **Category** : SDK Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -354,7 +354,7 @@ For example: Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2028 NonEmptyClientName +### R2028 NonEmptyClientName **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -378,7 +378,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2066 PostOperationIdContainsUrlVerb +### R2066 PostOperationIdContainsUrlVerb **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -403,7 +403,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2009 ArraySchemaMustHaveItems +### R2009 ArraySchemaMustHaveItems **Category** : SDK Error **Applies to** : ARM and Data Plane OpenAPI(swagger) specs @@ -438,7 +438,7 @@ Example with object reference type Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2012 XmsClientNameParameter +### R2012 XmsClientNameParameter **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -480,7 +480,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2013 XmsClientNameProperty +### R2013 XmsClientNameProperty **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -513,7 +513,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1010 AvoidMsdnReferences +### R1010 AvoidMsdnReferences **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -532,7 +532,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1009 DeleteInOperationName +### R1009 DeleteInOperationName **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -555,7 +555,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1005 GetInOperationName +### R1005 GetInOperationName **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -578,7 +578,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1003 ListInOperationName +### R1003 ListInOperationName **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -600,7 +600,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1006 PutInOperationName +### R1006 PutInOperationName **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -622,7 +622,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1007 PatchInOperationName +### R1007 PatchInOperationName **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -643,7 +643,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3017 GuidUsage +### R3017 GuidUsage **Category** : ARM Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -662,7 +662,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1011 HttpsSupportedScheme +### R1011 HttpsSupportedScheme **Category** : SDK Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -686,7 +686,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2004 NonApplicationJsonType +### R2004 NonApplicationJsonType **Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -703,7 +703,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2059 UniqueResourcePaths +### R2059 UniqueResourcePaths **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -759,7 +759,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2006 ControlCharactersNotAllowed +### R2006 ControlCharactersNotAllowed **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -777,7 +777,7 @@ Control characters are not allowed in a specification. Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2008 MutabilityWithReadOnly +### R2008 MutabilityWithReadOnly **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -809,7 +809,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2058 XmsPathsMustOverloadPaths +### R2058 XmsPathsMustOverloadPaths **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -851,7 +851,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2001 AvoidNestedProperties +### R2001 AvoidNestedProperties **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -866,7 +866,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3008 CollectionObjectPropertiesNaming +### R3008 CollectionObjectPropertiesNaming **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -881,7 +881,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2027 DefaultMustBeInEnum +### R2027 DefaultMustBeInEnum **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -910,7 +910,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2047 NamePropertyDefinitionInParameter +### R2047 NamePropertyDefinitionInParameter **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -944,7 +944,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R1001 OperationIdNounVerb +### R1001 OperationIdNounVerb **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -969,7 +969,7 @@ Certificate_Activate Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2055 OneUnderscoreInOperationId +### R2055 OneUnderscoreInOperationId **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -993,7 +993,7 @@ PrimaryCertificate_Activate Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3023 OperationsAPIImplementation +### R3023 OperationsAPIImplementation **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1089,7 +1089,7 @@ A typical `OperationsList` and `Operation` model would look like Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2015 ParameterNotDefinedInGlobalParameters +### R2015 ParameterNotDefinedInGlobalParameters **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1106,7 +1106,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2020 RequiredPropertiesMissingInResourceModel +### R2020 RequiredPropertiesMissingInResourceModel **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1121,7 +1121,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2056 RequiredReadOnlyProperties +### R2056 RequiredReadOnlyProperties **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1150,7 +1150,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2014 SubscriptionIdParameterInOperations +### R2014 SubscriptionIdParameterInOperations **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1165,7 +1165,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2003 ValidFormats +### R2003 ValidFormats **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1180,7 +1180,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### D5001 XmsExamplesRequired +### D5001 XmsExamplesRequired **Category** : Documentation Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1199,7 +1199,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2065 LicenseHeaderMustNotBeSpecified +### R2065 LicenseHeaderMustNotBeSpecified **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1212,7 +1212,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2025 NextLinkPropertyMustExist +### R2025 NextLinkPropertyMustExist **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1231,7 +1231,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2060 PageableRequires200Response +### R2060 PageableRequires200Response **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1250,7 +1250,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2024 AnonymousBodyParameter +### R2024 AnonymousBodyParameter **Category** : SDK Error **Applies to** : ARM specs @@ -1265,7 +1265,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2026 AvoidAnonymousTypes +### R2026 AvoidAnonymousTypes **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1341,7 +1341,7 @@ public class FooCreationSettings { Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3019 ArmResourcePropertiesBag +### R3019 ArmResourcePropertiesBag **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1396,7 +1396,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ``` Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3006 BodyTopLevelProperties +### R3006 BodyTopLevelProperties **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1448,7 +1448,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ``` Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2057 InvalidSkuModel +### R2057 InvalidSkuModel **Category** : ARM Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -1465,7 +1465,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2018 XmsEnumValidation +### R2018 XmsEnumValidation **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1482,7 +1482,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2063 OperationIdNounConflictingModelNames +### R2063 OperationIdNounConflictingModelNames **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1497,7 +1497,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2054 SecurityDefinitionsStructure +### R2054 SecurityDefinitionsStructure **Category** : SDK Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1512,7 +1512,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2019 ResourceHasXMsResourceEnabled +### R2019 ResourceHasXMsResourceEnabled **Category** : SDK Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1527,7 +1527,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2017 PutRequestResponseScheme +### R2017 PutRequestResponseScheme **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1542,7 +1542,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2005 LongRunningResponseStatusCode +### R2005 LongRunningResponseStatusCode **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1557,7 +1557,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2044 InvalidVerbUsed +### R2044 InvalidVerbUsed **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1572,7 +1572,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3007 PutGetPatchResponseSchema +### R3007 PutGetPatchResponseSchema **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1587,7 +1587,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3013 DeleteMustNotHaveRequestBody +### R3013 DeleteMustNotHaveRequestBody **Category** : SDK Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1602,7 +1602,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2062 XmsResourceInPutResponse +### R2062 XmsResourceInPutResponse **Category** : ARM Error **Applies to** : ARM OpenAPI(swagger) specs @@ -1617,7 +1617,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3060 XmsPageableListByRGAndSubscriptions +### R3060 XmsPageableListByRGAndSubscriptions **Category** : SDK Warning **Applies to** : ARM OpenAPI(swagger) specs @@ -1632,7 +1632,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2064 LROStatusCodesReturnTypeSchema +### R2064 LROStatusCodesReturnTypeSchema **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1647,7 +1647,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2016 PatchBodyParametersSchema +### R2016 PatchBodyParametersSchema **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1662,7 +1662,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4000 ParameterDescriptionRequired +### R4000 ParameterDescriptionRequired **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1677,7 +1677,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4000 DescriptiveDescriptionRequired +### R4000 DescriptiveDescriptionRequired **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1692,7 +1692,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4000 DescriptionAndTitleMissing +### R4000 DescriptionAndTitleMissing **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1707,7 +1707,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4000 OperationDescriptionOrSummaryRequired +### R4000 OperationDescriptionOrSummaryRequired **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1722,7 +1722,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2023 SummaryAndDescriptionMustNotBeSame +### R2023 SummaryAndDescriptionMustNotBeSame **Category** : SDK Warning **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1765,7 +1765,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R3011 DescriptionMustNotBeNodeName +### R3011 DescriptionMustNotBeNodeName **Category** : ARM Error **Applies to** : ARM and Data plane OpenAPI(swagger) specs @@ -1780,7 +1780,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4001 XmsParameterLocation +### R4001 XmsParameterLocation **Category** : SDK Error @@ -1807,7 +1807,7 @@ or Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R2010 LongRunningOperationsOptionsValidator +### R2010 LongRunningOperationsOptionsValidator **Category** : SDK Warning From 4e6184df3502fc874c17035242d8f8d40525450c Mon Sep 17 00:00:00 2001 From: luluRagdoll <32974210+luluRagdoll@users.noreply.github.com> Date: Fri, 2 Nov 2018 11:29:59 -0700 Subject: [PATCH 088/464] Reservations RP 2018-06-01 Preview: Add new reserved resource enum type RedHat (#4370) * Reservations RP 2018-06-01 Preview: Add new reserved resource type RedHat * Update python version from 0.2.2 to 0.2.3 since this is a minor change * Update the python version * move Go codegen under preview directory * Update readme.go.md --- .../Microsoft.Capacity/preview/2018-06-01/reservations.json | 3 ++- specification/reservations/resource-manager/readme.go.md | 4 ++-- specification/reservations/resource-manager/readme.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json index e427f2010cc4..52a9b8f9407a 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json @@ -1132,7 +1132,8 @@ "VirtualMachines", "SqlDatabases", "SuseLinux", - "CosmosDb" + "CosmosDb", + "RedHat" ], "x-ms-enum": { "name": "ReservedResourceType", diff --git a/specification/reservations/resource-manager/readme.go.md b/specification/reservations/resource-manager/readme.go.md index 777397b7e615..5083fae1d771 100644 --- a/specification/reservations/resource-manager/readme.go.md +++ b/specification/reservations/resource-manager/readme.go.md @@ -23,7 +23,7 @@ These settings apply only when `--tag=package-2018-06 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag)=='package-2018-06' && $(go) -output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-06-01/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-06-01/$(namespace) ``` ### Tag: package-2017-11 and go @@ -33,4 +33,4 @@ Please also specify `--go-sdk-folder= Date: Fri, 2 Nov 2018 12:46:31 -0700 Subject: [PATCH 089/464] fix Go SDK regex (#4388) --- specification/resources/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resources/resource-manager/readme.go.md b/specification/resources/resource-manager/readme.go.md index 109a5fa7fa82..ffbb701fc5e1 100644 --- a/specification/resources/resource-manager/readme.go.md +++ b/specification/resources/resource-manager/readme.go.md @@ -8,7 +8,7 @@ These settings apply only when `--go` is specified on the command line. directive: from: swagger-document # do it globally where: $.paths..parameters[?(@.name == "resourceGroupName" || @.name == "sourceResourceGroupName")].pattern - set: ^[-\p{L}\._\(\)]+$ + set: ^[-\p{L}\._\(\)\w]+$ reason: Necessary to match Unicode characters in the Go regexp engine. ``` From 83b9a56290d6b837d54e5f31e8eb84c3052bd2c4 Mon Sep 17 00:00:00 2001 From: deepak abburi Date: Fri, 2 Nov 2018 13:01:50 -0700 Subject: [PATCH 090/464] Added patch API to swagger doc in Visual studio RP (#4368) * Added patch API to swagger doc for Visual Studio RP * Fixed validation error * Added properties to definition * Fixed Account tag request --- .../preview/2014-04-01-preview/Csm.json | 64 +++++++++++++++++++ .../examples/UpdateTags.json | 27 ++++++++ 2 files changed, 91 insertions(+) create mode 100644 specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateTags.json diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json index c5cd03b281d5..b9a74fdbc55b 100644 --- a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/Csm.json @@ -517,6 +517,57 @@ "$ref": "./examples/GetResource.json" } } + }, + "patch": { + "tags": [ + "Accounts" + ], + "summary": "Accounts_Update", + "description": "Updates tags for Visual Studio Team Services account resource.", + "operationId": "Accounts_Update", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "in": "body", + "name": "body", + "description": "The request data.", + "required": true, + "schema": { + "$ref": "#/definitions/AccountTagRequest" + } + }, + { + "in": "path", + "name": "resourceName", + "description": "Name of the resource.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The operation succeeded. The Visual Studio Team Services account resource was updated.", + "schema": { + "$ref": "#/definitions/AccountResource" + } + }, + "404": { + "description": "The Visual Studio Team Services account does not exist." + } + }, + "x-ms-examples": { + "Create an account resource": { + "$ref": "./examples/UpdateTags.json" + } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.visualstudio/account/{rootResourceName}/project": { @@ -839,6 +890,19 @@ } } }, + "AccountTagRequest": { + "description": "The body of a Patch request to add tags to a Visual Studio account resource.", + "type": "object", + "properties": { + "tags": { + "description": "The custom tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, "AccountResourceRequest": { "description": "The body of a PUT request to modify a Visual Studio account resource.", "type": "object", diff --git a/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateTags.json b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateTags.json new file mode 100644 index 000000000000..a4a1c9582eab --- /dev/null +++ b/specification/visualstudio/resource-manager/Microsoft.VisualStudio/preview/2014-04-01-preview/examples/UpdateTags.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "body": { + "tags": {"tag1":"value1"} + }, + "subscriptionId": "0de7f055-dbea-498d-8e9e-da287eedca90", + "resourceGroupName": "VS-Example-Group", + "resourceName": "Example", + "api-version": "2014-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0de7f055-dbea-498d-8e9e-da287eedca90/resourceGroups/VS-Example-Group/providers/Microsoft.VisualStudio/account/Example", + "name": "VS-Example-Group", + "type": "Microsoft.VisualStudio/account", + "location": "Central US", + "tags": {}, + "properties": { + "AccountURL": "" + } + } + }, + "404": { + } + } + } \ No newline at end of file From 85131eff259c620e36035029d2303ec9b2efceb2 Mon Sep 17 00:00:00 2001 From: Jeanine Burke <41650461+jaysterp@users.noreply.github.com> Date: Fri, 2 Nov 2018 13:06:59 -0700 Subject: [PATCH 091/464] ACR: Add contextAccessToken to Task step (#4389) * update ACR swagger with contextAccessToken * format json --- .../stable/2018-09-01/containerregistry_build.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json index 6dccd3221145..38cbcb137517 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json @@ -1173,6 +1173,10 @@ "contextPath": { "description": "The URL(absolute or relative) of the source context for the task step.", "type": "string" + }, + "contextAccessToken": { + "description": "The token (git PAT or SAS token of storage account blob) associated with the context for a step.", + "type": "string" } }, "discriminator": "type" @@ -1507,6 +1511,10 @@ "contextPath": { "description": "The URL(absolute or relative) of the source context for the task step.", "type": "string" + }, + "contextAccessToken": { + "description": "The token (git PAT or SAS token of storage account blob) associated with the context for a step.", + "type": "string" } }, "discriminator": "type" From 4833cfa04025bb34d5bae0a0caf75e70864db816 Mon Sep 17 00:00:00 2001 From: Jiho Chang Date: Mon, 29 Oct 2018 14:41:50 -0700 Subject: [PATCH 092/464] Domain Services Swagger: Fix Put and Patch Domain Service Input --- .../stable/2017-01-01/domainservices.json | 72 +++++-------------- .../examples/CreateDomainService.json | 44 ++++++------ .../examples/UpdateDomainService.json | 40 ++++++----- .../stable/2017-06-01/domainservices.json | 72 +++++-------------- .../examples/CreateDomainService.json | 44 ++++++------ .../examples/UpdateDomainService.json | 42 ++++++----- 6 files changed, 125 insertions(+), 189 deletions(-) diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json index 921541f8e455..4d1abcce0f8f 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/domainservices.json @@ -147,18 +147,14 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" }, { - "name": "properties", + "name": "domainService", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainServiceProperties" + "$ref": "#/definitions/DomainService" }, "description": "Properties supplied to the Create or Update a Domain Service operation." } @@ -208,11 +204,7 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" } ], "responses": { @@ -247,11 +239,7 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" } ], "responses": { @@ -290,18 +278,14 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" }, { - "name": "properties", + "name": "domainService", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainServicePatchProperties" + "$ref": "#/definitions/DomainService" }, "description": "Properties supplied to the Update a Domain Service operation." } @@ -365,9 +349,6 @@ "description": "Resource etag" } }, - "required": [ - "location" - ], "x-ms-azure-resource": true }, "DomainService": { @@ -492,35 +473,6 @@ } } }, - "DomainServicePatchProperties": { - "description": "Update Properties of the Domain Service.", - "properties": { - "ldapsSettings": { - "$ref": "#/definitions/LdapsSettings", - "description": "Secure LDAP Settings" - }, - "notificationSettings": { - "$ref": "#/definitions/NotificationSettings", - "description": "Notification Settings" - }, - "domainSecuritySettings": { - "$ref": "#/definitions/DomainSecuritySettings", - "description": "DomainSecurity Settings" - }, - "filteredSync": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "description": "Enabled or Disabled flag to turn on Group-based filtered sync", - "x-ms-enum": { - "name": "filteredSync", - "modelAsString": true - } - } - } - }, "LdapsSettings": { "description": "Secure LDAP Settings", "properties": { @@ -803,6 +755,14 @@ "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/CreateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/CreateDomainService.json index b20f42e912d9..543eb2165bbb 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/CreateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/CreateDomainService.json @@ -4,26 +4,30 @@ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", "resourceGroupName": "sva-tt-WUS", "domainServiceName": "zdomain.zforest.com", - "location": "westus", - "properties": { - "domainName": "zdomain.zforest.com", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/Default-Networking/providers/Microsoft.ClassicNetwork/virtualNetworks/DCIaasTmpWusNet/subnets/Subnet-1", - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] - }, - "filteredSync": "Enabled", - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "Password01", - "externalAccess": "Enabled" + "domainService": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/sva-tt-WUS/providers/Microsoft.AAD/domainServices/zdomain.zforest.com", + "location": "westus", + "name": "zdomain.zforest.com", + "properties": { + "domainName": "zdomain.zforest.com", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/Default-Networking/providers/Microsoft.ClassicNetwork/virtualNetworks/DCIaasTmpWusNet/subnets/Subnet-1", + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] + }, + "filteredSync": "Enabled", + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "Password01", + "externalAccess": "Enabled" + } } } }, diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/UpdateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/UpdateDomainService.json index 80996d72a894..1231c5c52bda 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/UpdateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-01-01/examples/UpdateDomainService.json @@ -4,24 +4,28 @@ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", "resourceGroupName": "sva-tt-WUS", "domainServiceName": "zdomain.zforest.com", - "location": "westus", - "properties": { - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] - }, - "filteredSync": "Enabled", - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "Password01", - "externalAccess": "Enabled" + "domainService": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/sva-tt-WUS/providers/Microsoft.AAD/domainServices/zdomain.zforest.com", + "location": "westus", + "name": "zdomain.zforest.com", + "properties": { + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] + }, + "filteredSync": "Enabled", + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "Password01", + "externalAccess": "Enabled" + } } } }, diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/domainservices.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/domainservices.json index a99ee09b1b70..efd7d90fc48a 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/domainservices.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/domainservices.json @@ -147,18 +147,14 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" }, { - "name": "properties", + "name": "domainService", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainServiceProperties" + "$ref": "#/definitions/DomainService" }, "description": "Properties supplied to the Create or Update a Domain Service operation." } @@ -208,11 +204,7 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" } ], "responses": { @@ -247,11 +239,7 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" } ], "responses": { @@ -290,18 +278,14 @@ "$ref": "#/parameters/ResourceGroupNameParameter" }, { - "name": "domainServiceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the domain service in the specified subscription and resource group." + "$ref": "#/parameters/DomainServiceNameParameter" }, { - "name": "properties", + "name": "domainService", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/DomainServicePatchProperties" + "$ref": "#/definitions/DomainService" }, "description": "Properties supplied to the Update a Domain Service operation." } @@ -365,9 +349,6 @@ "description": "Resource etag" } }, - "required": [ - "location" - ], "x-ms-azure-resource": true }, "DomainService": { @@ -492,35 +473,6 @@ } } }, - "DomainServicePatchProperties": { - "description": "Update Properties of the Domain Service.", - "properties": { - "ldapsSettings": { - "$ref": "#/definitions/LdapsSettings", - "description": "Secure LDAP Settings" - }, - "notificationSettings": { - "$ref": "#/definitions/NotificationSettings", - "description": "Notification Settings" - }, - "domainSecuritySettings": { - "$ref": "#/definitions/DomainSecuritySettings", - "description": "DomainSecurity Settings" - }, - "filteredSync": { - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "description": "Enabled or Disabled flag to turn on Group-based filtered sync", - "x-ms-enum": { - "name": "filteredSync", - "modelAsString": true - } - } - } - }, "LdapsSettings": { "description": "Secure LDAP Settings", "properties": { @@ -803,6 +755,14 @@ "minLength": 1, "maxLength": 90, "x-ms-parameter-location": "method" + }, + "DomainServiceNameParameter": { + "name": "domainServiceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the domain service.", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateDomainService.json index a733b630636a..ea349d8ce14c 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/CreateDomainService.json @@ -4,26 +4,30 @@ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", "resourceGroupName": "sva-tt-WUS", "domainServiceName": "zdomain.zforest.com", - "location": "westus", - "properties": { - "domainName": "zdomain.zforest.com", - "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/Default-Networking/providers/Microsoft.Network/virtualNetworks/DCIaasTmpWusNet/subnets/Subnet-1", - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] - }, - "filteredSync": "Enabled", - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "Password01", - "externalAccess": "Enabled" + "domainService": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/sva-tt-WUS/providers/Microsoft.AAD/domainServices/zdomain.zforest.com", + "location": "westus", + "name": "zdomain.zforest.com", + "properties": { + "domainName": "zdomain.zforest.com", + "subnetId": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/Default-Networking/providers/Microsoft.Network/virtualNetworks/DCIaasTmpWusNet/subnets/Subnet-1", + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] + }, + "filteredSync": "Enabled", + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "Password01", + "externalAccess": "Enabled" + } } } }, diff --git a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateDomainService.json b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateDomainService.json index 5d1d78faff69..af5cf9b20c3c 100644 --- a/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateDomainService.json +++ b/specification/domainservices/resource-manager/Microsoft.AAD/stable/2017-06-01/examples/UpdateDomainService.json @@ -4,24 +4,28 @@ "subscriptionId": "1639790a-76a2-4ac4-98d9-8562f5dfcb4d", "resourceGroupName": "sva-tt-WUS", "domainServiceName": "zdomain.zforest.com", - "location": "westus", - "properties": { - "domainSecuritySettings": { - "ntlmV1": "Enabled", - "tlsV1": "Disabled", - "syncNtlmPasswords": "Enabled" - }, - "notificationSettings": { - "notifyGlobalAdmins": "Enabled", - "notifyDcAdmins": "Enabled", - "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] - }, - "filteredSync": "Enabled", - "ldapsSettings": { - "ldaps": "Enabled", - "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", - "pfxCertificatePassword": "Password01", - "externalAccess": "Enabled" + "domainService": { + "id": "/subscriptions/1639790a-76a2-4ac4-98d9-8562f5dfcb4d/resourceGroups/sva-tt-WUS/providers/Microsoft.AAD/domainServices/zdomain.zforest.com", + "location": "westus", + "name": "zdomain.zforest.com", + "properties": { + "domainSecuritySettings": { + "ntlmV1": "Enabled", + "tlsV1": "Disabled", + "syncNtlmPasswords": "Enabled" + }, + "notificationSettings": { + "notifyGlobalAdmins": "Enabled", + "notifyDcAdmins": "Enabled", + "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] + }, + "filteredSync": "Enabled", + "ldapsSettings": { + "ldaps": "Enabled", + "pfxCertificate": "MIIDPDCCAiSgAwIBAgIQQUI9P6tq2p9OFIJa7DLNvTANBgkqhkiG9w0BAQsFADAgMR4w...", + "pfxCertificatePassword": "Password01", + "externalAccess": "Enabled" + } } } }, @@ -96,7 +100,7 @@ "additionalRecipients": [ "jicha@microsoft.com", "caalmont@microsoft.com" ] }, "filteredSync": "Enabled", - "provisioningState": "Accepted" + "provisioningState": "Accepted" } } } From 05ca89f4ab362b74f6479dbfe287ffa484b18ff0 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Fri, 2 Nov 2018 14:38:43 -0700 Subject: [PATCH 093/464] add datamigration tags to Go SDK build (#4391) --- .../resource-manager/readme.go.md | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/specification/datamigration/resource-manager/readme.go.md b/specification/datamigration/resource-manager/readme.go.md index 91483d023c19..bb3a6ffef642 100644 --- a/specification/datamigration/resource-manager/readme.go.md +++ b/specification/datamigration/resource-manager/readme.go.md @@ -15,6 +15,8 @@ go: batch: - tag: package-2017-11-15-preview - tag: package-2018-03-31-preview + - tag: package-2018-04-19 + - tag: package-2018-07-15-preview ``` @@ -34,4 +36,22 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-04-19' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-04-19/$(namespace) +``` + +### Tag: package-2018-07-15-preview and go + +These settings apply only when `--tag=package-2018-07-15-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-07-15-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-07-15-preview/$(namespace) +``` From 560f88b1a65242923970900297c7e2c8b564872c Mon Sep 17 00:00:00 2001 From: mozehgir <32183061+mozehgir@users.noreply.github.com> Date: Fri, 2 Nov 2018 16:58:24 -0700 Subject: [PATCH 094/464] Update PULL_REQUEST_TEMPLATE.md (#4392) --- .github/PULL_REQUEST_TEMPLATE.md | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index c545e3b3fbe0..e453a4fc63bc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,7 @@ -This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process. - -### PR information -- [ ] The title of the PR is clear and informative. -- [ ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, [see this page](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/cleaning-up-commits.md). -- [ ] Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch. -- [ ] If applicable, the PR references the bug/issue that it fixes. -- [ ] Swagger files are correctly named (e.g. the `api-version` in the path should match the `api-version` in the spec). - -### Quality of Swagger -- [ ] I have read the [contribution guidelines](https://github.com/Azure/azure-rest-api-specs/blob/master/.github/CONTRIBUTING.md). -- [ ] My spec meets the review criteria: - - [ ] The spec conforms to the [Swagger 2.0 specification](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md). - - [ ] The spec follows the guidelines described in the [Swagger checklist](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md) document. - - [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. +### Latest improvements: +MSFT employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapiportal) - one location for using our validation tools and finding your workflow. +
+### Contribution checklist: +- [ ] I have reviewed the [documentation](https://github.com/Azure/azure-rest-api-specs#basics) for the workflow. +- [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. +- [ ] The [OpenAPI Hub](https://aka.ms/openapiportal) was used for checking validation status and next steps. From 8485d072827a78cee190b14239ff7855918149e9 Mon Sep 17 00:00:00 2001 From: shakao <34112083+shakao@users.noreply.github.com> Date: Mon, 5 Nov 2018 08:57:20 -0800 Subject: [PATCH 095/464] [Visual Search API] Update encoding format documentation per PM request (#4383) --- .../data-plane/VisualSearch/preview/v1.0/VisualSearch.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json index a6edb49ecbe5..e25d36c02a3d 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -488,7 +488,7 @@ "type": "string" }, "encodingFormat": { - "description": "Encoding format (e.g., mp3, mp4, jpeg, etc).", + "description": "Encoding format (e.g., png, gif, jpeg, etc).", "readOnly": true, "type": "string" }, From 1cf6698325c9224ef309640c70e545df9c8998f9 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Mon, 5 Nov 2018 10:08:13 -0800 Subject: [PATCH 096/464] enable swagger-to-sdk in visual search for Go SDK (#4398) --- .../cognitiveservices/data-plane/VisualSearch/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cognitiveservices/data-plane/VisualSearch/readme.md b/specification/cognitiveservices/data-plane/VisualSearch/readme.md index cc2205e5e5d1..b79e7a9cc468 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/readme.md +++ b/specification/cognitiveservices/data-plane/VisualSearch/readme.md @@ -39,6 +39,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-sdk-for-go ``` ## CSharp Settings From 845d69ebfc099f69630e725b43f3167866d970c3 Mon Sep 17 00:00:00 2001 From: Ilia Demianenko Date: Mon, 5 Nov 2018 11:21:34 -0800 Subject: [PATCH 097/464] Add facet sortBy and filter to ResourceGraph swagger (#4390) --- .../examples/ResourcesFacetQuery.json | 96 +++++++++++++++++-- .../2018-09-01-preview/resourcegraph.json | 10 +- .../resource-manager/readme.python.md | 2 +- 3 files changed, 100 insertions(+), 8 deletions(-) diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourcesFacetQuery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourcesFacetQuery.json index b3e83ee11a0f..1f921397d927 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourcesFacetQuery.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/examples/ResourcesFacetQuery.json @@ -7,7 +7,7 @@ "subscriptions": [ "cfbbd179-59d2-4052-aa06-9270a38aa9d6" ], - "query": "where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, properties.storageProfile.osDisk.osType | limit 5", + "query": "where type =~ 'Microsoft.Compute/virtualMachines' | project id, name, location, resourceGroup, properties.storageProfile.osDisk.osType | limit 5", "facets": [ { "expression": "location", @@ -29,6 +29,21 @@ "sortOrder": "desc", "$top": 3 } + }, + { + "expression": "resourceGroup", + "options": { + "sortBy": "tolower(resourceGroup)", + "sortOrder": "asc", + "$top": 3 + } + }, + { + "expression": "resourceGroup", + "options": { + "filter": "resourceGroup contains 'test'", + "$top": 3 + } } ] } @@ -53,6 +68,10 @@ "name": "location", "type": "string" }, + { + "name": "resourceGroup", + "type": "string" + }, { "name": "properties_storageProfile_osDisk_osType", "type": "object" @@ -60,33 +79,38 @@ ], "rows": [ [ - "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myTestVm", + "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/B-TEST-RG/providers/Microsoft.Compute/virtualMachines/myTestVm", "myTestVm", "eastus", + "B-TEST-RG", "Windows" ], [ - "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/myTestAccountVm", + "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/c-rg/providers/Microsoft.Compute/virtualMachines/myTestAccountVm", "myTestAccountVm", "westcentralus", + "c-rg", "Windows" ], [ - "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG1/providers/Microsoft.Compute/virtualMachines/yetanothertest", + "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/I-RG/providers/Microsoft.Compute/virtualMachines/yetanothertest", "yetanothertest", "eastus", + "I-RG", "Linux" ], [ - "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw", + "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/x-test-rg/providers/Microsoft.Compute/virtualMachines/drafttest1bux4cv7a7q3aw", "drafttest1bux4cv7a7q3aw", "southcentralus", + "x-test-rg", "Linux" ], [ - "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/RG2/providers/Microsoft.Compute/virtualMachines/testvmntp25370", + "/subscriptions/cfbbd179-59d2-4052-aa06-9270a38aa9d6/resourceGroups/y-rg/providers/Microsoft.Compute/virtualMachines/testvmntp25370", "testvmntp25370", "eastus", + "y-rg", "Windows" ] ] @@ -165,6 +189,66 @@ "message": "Invalid column names: [nonExistingColumn]." } ] + }, + { + "expression": "resourceGroup", + "resultType": "FacetResult", + "totalRecords": 5, + "count": 3, + "data": { + "columns": [ + { + "name": "resourceGroup", + "type": "string" + }, + { + "name": "count", + "type": "integer" + } + ], + "rows": [ + [ + "B-TEST-RG", + 1 + ], + [ + "c-rg", + 1 + ], + [ + "I-RG", + 1 + ] + ] + } + }, + { + "expression": "resourceGroup", + "resultType": "FacetResult", + "totalRecords": 2, + "count": 2, + "data": { + "columns": [ + { + "name": "resourceGroup", + "type": "string" + }, + { + "name": "count", + "type": "integer" + } + ], + "rows": [ + [ + "B-TEST-RG", + 1 + ], + [ + "x-test-rg", + 1 + ] + ] + } } ] } diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json index eb77d2581965..14f879b17922 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/resourcegraph.json @@ -193,8 +193,12 @@ "FacetRequestOptions": { "description": "The options for facet evaluation", "properties": { + "sortBy": { + "description": "The column name or query expression to sort on. Defaults to count if not present.", + "type": "string" + }, "sortOrder": { - "description": "The sorting order by the hit count", + "description": "The sorting order by the selected column (count by default).", "type": "string", "default": "desc", "enum": [ @@ -206,6 +210,10 @@ "modelAsString": false } }, + "filter": { + "description": "Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.", + "type": "string" + }, "$top": { "description": "The maximum number of facet rows that should be returned.", "type": "integer", diff --git a/specification/resourcegraph/resource-manager/readme.python.md b/specification/resourcegraph/resource-manager/readme.python.md index 52b63cad819c..94222d62d54e 100644 --- a/specification/resourcegraph/resource-manager/readme.python.md +++ b/specification/resourcegraph/resource-manager/readme.python.md @@ -12,7 +12,7 @@ python: payload-flattening-threshold: 2 namespace: azure.mgmt.resourcegraph package-name: azure-mgmt-resourcegraph - package-version: 0.6.0 + package-version: 0.7.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' From 1f3cc4eada45a048c8287981f1e04d9850abf5a6 Mon Sep 17 00:00:00 2001 From: Sarangan Rajamanickam Date: Mon, 5 Nov 2018 12:58:00 -0800 Subject: [PATCH 098/464] Fix Version value to fix Ruby SDK Generation (#4400) --- .../MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json index 48ba15192fb0..510011b864ba 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Azure Database Migration Service Resource Provider", - "version": "2017-11-15-preview" + "version": "2018-07-15-preview" }, "securityDefinitions": { "azure_auth": { From 4f7b51c6764bb0a58fab257c446941a8c477d3ef Mon Sep 17 00:00:00 2001 From: Jianghao Lu Date: Mon, 5 Nov 2018 17:13:12 -0800 Subject: [PATCH 099/464] Add java multi api versions for network (#4402) --- .../network/resource-manager/readme.md | 38 ++++++++++++++++--- 1 file changed, 33 insertions(+), 5 deletions(-) diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index eeecf3860b3a..bd698584a1b0 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -817,20 +817,35 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-network ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-08 + - tag: package-2018-07 - tag: package-2018-06 - tag: package-2018-04 - tag: package-2017-10 ``` -### Tag: package-2018-04 and java +### Tag: package-2018-08 and java -These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +These settings apply only when `--tag=package-2018-08 --java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. -``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-2018-08' && $(java) && $(multiapi) java: - namespace: com.microsoft.azure.management.network.v2018_04_01 - output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_04_01 + namespace: com.microsoft.azure.management.network.v2018_08_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_08_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-07 and java + +These settings apply only when `--tag=package-2018-07 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-07' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.network.v2018_07_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_07_01 regenerate-manager: true generate-interface: true ``` @@ -848,6 +863,19 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.network.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/network/resource-manager/v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2017-10 and java These settings apply only when `--tag=package-2017-10 --java` is specified on the command line. From 2eca3f66cd9ced72416548929d3f5112bb78e9de Mon Sep 17 00:00:00 2001 From: grlin <42353527+grlin@users.noreply.github.com> Date: Mon, 5 Nov 2018 17:45:37 -0800 Subject: [PATCH 100/464] Grlin/adding principal typeto ra (#4399) * adding principal type to putRA * updating version to 2018-09-01-preview * base commit, version 2018-01-01-preview * adding principal type + updating version number * refactoring swagger to separate out API calls * updating 2018-01-01-preview * adding PrincipalType * removing incorrect 2018-09-01 json file * Fix package-2018-09-01-preview-only --- ...authorization-ProviderOperationsCalls.json | 249 ++++ .../authorization-RoleAssignmentsCalls.json | 623 ++++++++ .../authorization-RoleBasedCalls.json | 1230 ---------------- .../authorization-RoleDefinitionsCalls.json | 527 +++++++ .../authorization-RoleAssignmentsCalls.json | 643 +++++++++ .../authorization-RoleBasedCalls.json | 1250 ----------------- .../examples/PutRoleAssignmentById.json | 2 +- .../authorization/resource-manager/readme.md | 29 +- 8 files changed, 2066 insertions(+), 2487 deletions(-) create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json delete mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json delete mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json new file mode 100644 index 000000000000..1aa6eba61b6a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json @@ -0,0 +1,249 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2018-01-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These calls handle provider operations." + }, + "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.Authorization/providerOperations/{resourceProviderNamespace}": { + "get": { + "tags": [ + "ProviderOperationsMetadata" + ], + "operationId": "ProviderOperationsMetadata_Get", + "description": "Gets provider operations metadata for the specified resource provider.", + "parameters": [ + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "default": "resourceTypes", + "description": "Specifies whether to expand the values." + } + ], + "responses": { + "200": { + "description": "OK - Returns the operations metadata.", + "schema": { + "$ref": "#/definitions/ProviderOperationsMetadata" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetProviderOperationsRP.json" + } + } + } + }, + "/providers/Microsoft.Authorization/providerOperations": { + "get": { + "tags": [ + "ProviderOperationsMetadata" + ], + "operationId": "ProviderOperationsMetadata_List", + "description": "Gets provider operations metadata for all resource providers.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "default": "resourceTypes", + "description": "Specifies whether to expand the values." + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of the operations metadata.", + "schema": { + "$ref": "#/definitions/ProviderOperationsMetadataListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetAllProviderOperations.json" + } + } + } + } + }, + "definitions": { + "ResourceType": { + "properties": { + "name": { + "type": "string", + "description": "The resource type name." + }, + "displayName": { + "type": "string", + "description": "The resource type display name." + }, + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderOperation" + }, + "description": "The resource type operations." + } + }, + "description": "Resource Type" + }, + "ProviderOperation": { + "properties": { + "name": { + "type": "string", + "description": "The operation name." + }, + "displayName": { + "type": "string", + "description": "The operation display name." + }, + "description": { + "type": "string", + "description": "The operation description." + }, + "origin": { + "type": "string", + "description": "The operation origin." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The operation properties." + }, + "isDataAction": { + "type": "boolean", + "description": "The dataAction flag to specify the operation type." + } + }, + "description": "Operation" + }, + "ProviderOperationsMetadata": { + "properties": { + "id": { + "type": "string", + "description": "The provider id." + }, + "name": { + "type": "string", + "description": "The provider name." + }, + "type": { + "type": "string", + "description": "The provider type." + }, + "displayName": { + "type": "string", + "description": "The provider display name." + }, + "resourceTypes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceType" + }, + "description": "The provider resource types" + }, + "operations": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderOperation" + }, + "description": "The provider operations." + } + }, + "description": "Provider Operations metadata" + }, + "ProviderOperationsMetadataListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProviderOperationsMetadata" + }, + "description": "The list of providers." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Provider operations metadata list" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json new file mode 100644 index 000000000000..e3c98cc22448 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json @@ -0,0 +1,623 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2018-01-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResource", + "description": "Gets role assignments for a resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to get role assignments for." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResourceGroup", + "description": "Gets role assignments for a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResourceGroup.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Delete", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentByName.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Create", + "description": "Creates a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignment.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Get", + "description": "Get the specified role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByName.json" + } + } + } + }, + "/{roleId}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_DeleteById", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentById.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_CreateById", + "description": "Creates a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to create.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignmentById.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_GetById", + "description": "Gets a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to get.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentById.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_List", + "description": "Gets all role assignments for the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetAllRoleAssignments.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForScope", + "description": "Gets role assignments for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByScope.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment of the specific principal." + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the roleassignment" + } + }, + "description": "Role Assignments filter" + }, + "RoleAssignmentPropertiesWithScope": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the roleassignment" + } + }, + "description": "Role assignment properties with scope." + }, + "RoleAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", + "description": "Role assignment properties." + } + }, + "description": "Role Assignments" + }, + "RoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignment" + }, + "description": "Role assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role assignment list operation result." + }, + "RoleAssignmentProperties": { + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID used in the role assignment." + }, + "principalId": { + "type": "string", + "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." + }, + "canDelegate": { + "type": "boolean", + "description": "The delgation flag used for creating a role assignment" + } + }, + "required": [ + "roleDefinitionId", + "principalId" + ], + "description": "Role assignment properties." + }, + "RoleAssignmentCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentProperties", + "description": "Role assignment properties." + } + }, + "required": [ + "properties" + ], + "description": "Role assignment create parameters." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json deleted file mode 100644 index 378c5e0d69e0..000000000000 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json +++ /dev/null @@ -1,1230 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AuthorizationManagementClient", - "version": "2018-01-01-preview", - "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users." - }, - "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.Authorization/providerOperations/{resourceProviderNamespace}": { - "get": { - "tags": [ - "ProviderOperationsMetadata" - ], - "operationId": "ProviderOperationsMetadata_Get", - "description": "Gets provider operations metadata for the specified resource provider.", - "parameters": [ - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "default": "resourceTypes", - "description": "Specifies whether to expand the values." - } - ], - "responses": { - "200": { - "description": "OK - Returns the operations metadata.", - "schema": { - "$ref": "#/definitions/ProviderOperationsMetadata" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetProviderOperationsRP.json" - } - } - } - }, - "/providers/Microsoft.Authorization/providerOperations": { - "get": { - "tags": [ - "ProviderOperationsMetadata" - ], - "operationId": "ProviderOperationsMetadata_List", - "description": "Gets provider operations metadata for all resource providers.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "default": "resourceTypes", - "description": "Specifies whether to expand the values." - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of the operations metadata.", - "schema": { - "$ref": "#/definitions/ProviderOperationsMetadataListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetAllProviderOperations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/permissions": { - "get": { - "tags": [ - "Permissions" - ], - "operationId": "Permissions_ListForResourceGroup", - "description": "Gets all permissions the caller has for a resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of permissions.", - "schema": { - "$ref": "#/definitions/PermissionGetResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetPermissions.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/permissions": { - "get": { - "tags": [ - "Permissions" - ], - "operationId": "Permissions_ListForResource", - "description": "Gets all permissions the caller has for a resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type of the resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource to get the permissions for." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of permissions.", - "schema": { - "$ref": "#/definitions/PermissionGetResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetResourcePermissions.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForResource", - "description": "Gets role assignments for a resource.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type of the resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource to get role assignments for." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentsForResource.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForResourceGroup", - "description": "Gets role assignments for a resource group.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentsForResourceGroup.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { - "delete": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Delete", - "description": "Deletes a role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment to delete.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleAssignmentByName.json" - } - } - }, - "put": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Create", - "description": "Creates a role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to create. It can be any valid GUID." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleAssignmentCreateParameters" - }, - "description": "Parameters for the role assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Created - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleAssignment.json" - } - } - }, - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Get", - "description": "Get the specified role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to get." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentByName.json" - } - } - } - }, - "/{roleId}": { - "delete": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_DeleteById", - "description": "Deletes a role assignment.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to delete.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleAssignmentById.json" - } - } - }, - "put": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_CreateById", - "description": "Creates a role assignment by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to create.", - "x-ms-skip-url-encoding": true - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleAssignmentCreateParameters" - }, - "description": "Parameters for the role assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Created - Returns the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleAssignmentById.json" - } - } - }, - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_GetById", - "description": "Gets a role assignment by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to get.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentById.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_List", - "description": "Gets all role assignments for the subscription.", - "parameters": [{ - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetAllRoleAssignments.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForScope", - "description": "Gets role assignments for a scope.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignments.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentByScope.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}": { - "delete": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_Delete", - "description": "Deletes a role definition.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleDefinition.json" - } - } - }, - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_Get", - "description": "Get role definition by name (GUID).", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionByName.json" - } - } - }, - "put": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_CreateOrUpdate", - "description": "Creates or updates a role definition.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition." - }, - { - "name": "roleDefinition", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleDefinition" - }, - "description": "The values for the role definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleDefinition.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleDefinitions": { - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_List", - "description": "Get all role definitions that are applicable at scope and above.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role definitions.", - "schema": { - "$ref": "#/definitions/RoleDefinitionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleDefinitionFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionAtScope.json" - } - } - } - } - }, - "x-ms-paths":{ - "/{roleId}?disambiguation_dummy": { - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_GetById", - "description": "Gets a role definition by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionById.json" - } - } - } - } - }, - "definitions": { - "ProviderOperation": { - "properties": { - "name": { - "type": "string", - "description": "The operation name." - }, - "displayName": { - "type": "string", - "description": "The operation display name." - }, - "description": { - "type": "string", - "description": "The operation description." - }, - "origin": { - "type": "string", - "description": "The operation origin." - }, - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "description": "The operation properties." - }, - "isDataAction": { - "type": "boolean", - "description": "The dataAction flag to specify the operation type." - } - }, - "description": "Operation" - }, - "ResourceType": { - "properties": { - "name": { - "type": "string", - "description": "The resource type name." - }, - "displayName": { - "type": "string", - "description": "The resource type display name." - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperation" - }, - "description": "The resource type operations." - } - }, - "description": "Resource Type" - }, - "ProviderOperationsMetadata": { - "properties": { - "id": { - "type": "string", - "description": "The provider id." - }, - "name": { - "type": "string", - "description": "The provider name." - }, - "type": { - "type": "string", - "description": "The provider type." - }, - "displayName": { - "type": "string", - "description": "The provider display name." - }, - "resourceTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceType" - }, - "description": "The provider resource types" - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperation" - }, - "description": "The provider operations." - } - }, - "description": "Provider Operations metadata" - }, - "ProviderOperationsMetadataListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperationsMetadata" - }, - "description": "The list of providers." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Provider operations metadata list" - }, - "PermissionGetResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Permission" - }, - "description": "An array of permissions." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Permissions information." - }, - "RoleDefinitionFilter": { - "properties": { - "roleName": { - "type": "string", - "description": "Returns role definition with the specific name." - }, - "type": { - "type": "string", - "description": "Returns role definition with the specific type." - } - }, - "description": "Role Definitions filter" - }, - "RoleDefinitionProperties": { - "properties": { - "roleName": { - "type": "string", - "description": "The role name." - }, - "description": { - "type": "string", - "description": "The role definition description." - }, - "type": { - "type": "string", - "description": "The role type.", - "x-ms-client-name": "roleType" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/definitions/Permission" - }, - "description": "Role definition permissions." - }, - "assignableScopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Role definition assignable scopes." - } - }, - "description": "Role definition properties." - }, - "RoleDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The role definition ID." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The role definition name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The role definition type." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleDefinitionProperties", - "description": "Role definition properties." - } - }, - "description": "Role definition." - }, - "RoleDefinitionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleDefinition" - }, - "description": "Role definition list." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Role definition list operation result." - }, - "RoleAssignmentFilter": { - "properties": { - "principalId": { - "type": "string", - "description": "Returns role assignment of the specific principal." - }, - "canDelegate": { - "type": "boolean", - "description": "The Delegation flag for the roleassignment" - } - }, - "description": "Role Assignments filter" - }, - "RoleAssignmentPropertiesWithScope": { - "properties": { - "scope": { - "type": "string", - "description": "The role assignment scope." - }, - "roleDefinitionId": { - "type": "string", - "description": "The role definition ID." - }, - "principalId": { - "type": "string", - "description": "The principal ID." - }, - "canDelegate": { - "type": "boolean", - "description": "The Delegation flag for the roleassignment" - } - }, - "description": "Role assignment properties with scope." - }, - "RoleAssignment": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The role assignment ID." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The role assignment name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The role assignment type." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", - "description": "Role assignment properties." - } - }, - "description": "Role Assignments" - }, - "RoleAssignmentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleAssignment" - }, - "description": "Role assignment list." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Role assignment list operation result." - }, - "RoleAssignmentProperties": { - "properties": { - "roleDefinitionId": { - "type": "string", - "description": "The role definition ID used in the role assignment." - }, - "principalId": { - "type": "string", - "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." - }, - "canDelegate": { - "type": "boolean", - "description": "The delgation flag used for creating a role assignment" - } - }, - "required": [ - "roleDefinitionId", - "principalId" - ], - "description": "Role assignment properties." - }, - "RoleAssignmentCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleAssignmentProperties", - "description": "Role assignment properties." - } - }, - "required": [ - "properties" - ], - "description": "Role assignment create parameters." - }, - "Permission": { - "properties": { - "actions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed actions." - }, - "notActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Denied actions." - }, - "dataActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed Data actions." - }, - "notDataActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Denied Data actions." - } - }, - "description": "Role definition permissions." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the target subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ResourceProviderNamespaceParameter": { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace of the resource provider.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json new file mode 100644 index 000000000000..809db9dfe1ed --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json @@ -0,0 +1,527 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2018-01-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations allow you to manage role definitions. A role definition describes the set of actions that can be performed on resources." + }, + "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.Authorization/permissions": { + "get": { + "tags": [ + "Permissions" + ], + "operationId": "Permissions_ListForResourceGroup", + "description": "Gets all permissions the caller has for a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of permissions.", + "schema": { + "$ref": "#/definitions/PermissionGetResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetPermissions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/permissions": { + "get": { + "tags": [ + "Permissions" + ], + "operationId": "Permissions_ListForResource", + "description": "Gets all permissions the caller has for a resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to get the permissions for." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of permissions.", + "schema": { + "$ref": "#/definitions/PermissionGetResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetResourcePermissions.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}": { + "delete": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_Delete", + "description": "Deletes a role definition.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role definition to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleDefinition.json" + } + } + }, + "get": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_Get", + "description": "Get role definition by name (GUID).", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleDefinitionByName.json" + } + } + }, + "put": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_CreateOrUpdate", + "description": "Creates or updates a role definition.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleDefinitionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role definition." + }, + { + "name": "roleDefinition", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleDefinition" + }, + "description": "The values for the role definition." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "OK - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleDefinition.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleDefinitions": { + "get": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_List", + "description": "Get all role definitions that are applicable at scope and above.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role definition.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role definitions.", + "schema": { + "$ref": "#/definitions/RoleDefinitionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleDefinitionFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleDefinitionAtScope.json" + } + } + } + } + }, + "x-ms-paths": { + "/{roleId}?disambiguation_dummy": { + "get": { + "tags": [ + "RoleDefinitions" + ], + "operationId": "RoleDefinitions_GetById", + "description": "Gets a role definition by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role definition.", + "schema": { + "$ref": "#/definitions/RoleDefinition" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleDefinitionById.json" + } + } + } + } + }, + "definitions": { + "RoleDefinitionFilter": { + "properties": { + "roleName": { + "type": "string", + "description": "Returns role definition with the specific name." + }, + "type": { + "type": "string", + "description": "Returns role definition with the specific type." + } + }, + "description": "Role Definitions filter" + }, + "RoleDefinitionProperties": { + "properties": { + "roleName": { + "type": "string", + "description": "The role name." + }, + "description": { + "type": "string", + "description": "The role definition description." + }, + "type": { + "type": "string", + "description": "The role type.", + "x-ms-client-name": "roleType" + }, + "permissions": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "Role definition permissions." + }, + "assignableScopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Role definition assignable scopes." + } + }, + "description": "Role definition properties." + }, + "RoleDefinition": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role definition ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role definition name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role definition type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleDefinitionProperties", + "description": "Role definition properties." + } + }, + "description": "Role definition." + }, + "RoleDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleDefinition" + }, + "description": "Role definition list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role definition list operation result." + }, + "PermissionGetResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Permission" + }, + "description": "An array of permissions." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Permissions information." + }, + "Permission": { + "properties": { + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed actions." + }, + "notActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Denied actions." + }, + "dataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed Data actions." + }, + "notDataActions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Denied Data actions." + } + }, + "description": "Role definition permissions." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName eq '{name}' to search deny assignments by name at specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json new file mode 100644 index 000000000000..99a48ce7ba40 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json @@ -0,0 +1,643 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2018-09-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "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/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResource", + "description": "Gets role assignments for a resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to get role assignments for." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResourceGroup", + "description": "Gets role assignments for a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResourceGroup.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Delete", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentByName.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Create", + "description": "Creates a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignment.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Get", + "description": "Get the specified role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByName.json" + } + } + } + }, + "/{roleId}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_DeleteById", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentById.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_CreateById", + "description": "Creates a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to create.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignmentById.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_GetById", + "description": "Gets a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to get.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentById.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_List", + "description": "Gets all role assignments for the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetAllRoleAssignments.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForScope", + "description": "Gets role assignments for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByScope.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment of the specific principal." + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the roleassignment" + } + }, + "description": "Role Assignments filter" + }, + "RoleAssignmentPropertiesWithScope": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the roleassignment" + } + }, + "description": "Role assignment properties with scope." + }, + "RoleAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", + "description": "Role assignment properties." + } + }, + "description": "Role Assignments" + }, + "RoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignment" + }, + "description": "Role assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role assignment list operation result." + }, + "RoleAssignmentProperties": { + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID used in the role assignment." + }, + "principalId": { + "type": "string", + "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "Unknown", + "DirectoryRoleTemplate", + "ForeignGroup", + "Application", + "MSI", + "DirectoryObjectOrGroup", + "Everyone" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "canDelegate": { + "type": "boolean", + "description": "The delgation flag used for creating a role assignment" + } + }, + "required": [ + "roleDefinitionId", + "principalId" + ], + "description": "Role assignment properties." + }, + "RoleAssignmentCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentProperties", + "description": "Role assignment properties." + } + }, + "required": [ + "properties" + ], + "description": "Role assignment create parameters." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json deleted file mode 100644 index 056a1bcfea61..000000000000 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json +++ /dev/null @@ -1,1250 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "AuthorizationManagementClient", - "version": "2018-09-01-preview", - "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role definitions and role assignments. A role definition describes the set of actions that can be performed on resources. A role assignment grants access to Azure Active Directory users." - }, - "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.Authorization/providerOperations/{resourceProviderNamespace}": { - "get": { - "tags": [ - "ProviderOperationsMetadata" - ], - "operationId": "ProviderOperationsMetadata_Get", - "description": "Gets provider operations metadata for the specified resource provider.", - "parameters": [ - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "default": "resourceTypes", - "description": "Specifies whether to expand the values." - } - ], - "responses": { - "200": { - "description": "OK - Returns the operations metadata.", - "schema": { - "$ref": "#/definitions/ProviderOperationsMetadata" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetProviderOperationsRP.json" - } - } - } - }, - "/providers/Microsoft.Authorization/providerOperations": { - "get": { - "tags": [ - "ProviderOperationsMetadata" - ], - "operationId": "ProviderOperationsMetadata_List", - "description": "Gets provider operations metadata for all resource providers.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "in": "query", - "required": false, - "type": "string", - "default": "resourceTypes", - "description": "Specifies whether to expand the values." - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of the operations metadata.", - "schema": { - "$ref": "#/definitions/ProviderOperationsMetadataListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetAllProviderOperations.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/permissions": { - "get": { - "tags": [ - "Permissions" - ], - "operationId": "Permissions_ListForResourceGroup", - "description": "Gets all permissions the caller has for a resource group.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of permissions.", - "schema": { - "$ref": "#/definitions/PermissionGetResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetPermissions.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/permissions": { - "get": { - "tags": [ - "Permissions" - ], - "operationId": "Permissions_ListForResource", - "description": "Gets all permissions the caller has for a resource.", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type of the resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource to get the permissions for." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of permissions.", - "schema": { - "$ref": "#/definitions/PermissionGetResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetResourcePermissions.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForResource", - "description": "Gets role assignments for a resource.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ResourceProviderNamespaceParameter" - }, - { - "name": "parentResourcePath", - "in": "path", - "required": true, - "type": "string", - "description": "The parent resource identity.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceType", - "in": "path", - "required": true, - "type": "string", - "description": "The resource type of the resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "resourceName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource to get role assignments for." - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentsForResource.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForResourceGroup", - "description": "Gets role assignments for a resource group.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentsForResourceGroup.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { - "delete": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Delete", - "description": "Deletes a role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment to delete.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleAssignmentByName.json" - } - } - }, - "put": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Create", - "description": "Creates a role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to create. It can be any valid GUID." - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleAssignmentCreateParameters" - }, - "description": "Parameters for the role assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Created - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleAssignment.json" - } - } - }, - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_Get", - "description": "Get the specified role assignment.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignment.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the role assignment to get." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentByName.json" - } - } - } - }, - "/{roleId}": { - "delete": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_DeleteById", - "description": "Deletes a role assignment.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to delete.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleAssignmentById.json" - } - } - }, - "put": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_CreateById", - "description": "Creates a role assignment by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to create.", - "x-ms-skip-url-encoding": true - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleAssignmentCreateParameters" - }, - "description": "Parameters for the role assignment." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "Created - Returns the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleAssignmentById.json" - } - } - }, - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_GetById", - "description": "Gets a role assignment by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role assignment to get.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns the role assignment.", - "schema": { - "$ref": "#/definitions/RoleAssignment" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentById.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_List", - "description": "Gets all role assignments for the subscription.", - "parameters": [{ - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetAllRoleAssignments.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleAssignments": { - "get": { - "tags": [ - "RoleAssignments" - ], - "operationId": "RoleAssignments_ListForScope", - "description": "Gets role assignments for a scope.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role assignments.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role assignments.", - "schema": { - "$ref": "#/definitions/RoleAssignmentListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleAssignmentFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleAssignmentByScope.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}": { - "delete": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_Delete", - "description": "Deletes a role definition.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition to delete." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/DeleteRoleDefinition.json" - } - } - }, - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_Get", - "description": "Get role definition by name (GUID).", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionByName.json" - } - } - }, - "put": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_CreateOrUpdate", - "description": "Creates or updates a role definition.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "roleDefinitionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the role definition." - }, - { - "name": "roleDefinition", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/RoleDefinition" - }, - "description": "The values for the role definition." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "201": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/PutRoleDefinition.json" - } - } - } - }, - "/{scope}/providers/Microsoft.Authorization/roleDefinitions": { - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_List", - "description": "Get all role definitions that are applicable at scope and above.", - "parameters": [{ - "name": "scope", - "in": "path", - "required": true, - "type": "string", - "description": "The scope of the role definition.", - "x-ms-skip-url-encoding": true - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well." - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns an array of role definitions.", - "schema": { - "$ref": "#/definitions/RoleDefinitionListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-odata": "#/definitions/RoleDefinitionFilter", - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionAtScope.json" - } - } - } - } - }, - "x-ms-paths":{ - "/{roleId}?disambiguation_dummy": { - "get": { - "tags": [ - "RoleDefinitions" - ], - "operationId": "RoleDefinitions_GetById", - "description": "Gets a role definition by ID.", - "parameters": [{ - "name": "roleId", - "in": "path", - "required": true, - "type": "string", - "description": "The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK - Returns information about the role definition.", - "schema": { - "$ref": "#/definitions/RoleDefinition" - } - } - }, - "x-ms-examples": { - "GetConfigurations": { - "$ref": "./examples/GetRoleDefinitionById.json" - } - } - } - } - }, - "definitions": { - "ProviderOperation": { - "properties": { - "name": { - "type": "string", - "description": "The operation name." - }, - "displayName": { - "type": "string", - "description": "The operation display name." - }, - "description": { - "type": "string", - "description": "The operation description." - }, - "origin": { - "type": "string", - "description": "The operation origin." - }, - "properties": { - "type": "object", - "x-ms-client-flatten": true, - "description": "The operation properties." - }, - "isDataAction": { - "type": "boolean", - "description": "The dataAction flag to specify the operation type." - } - }, - "description": "Operation" - }, - "ResourceType": { - "properties": { - "name": { - "type": "string", - "description": "The resource type name." - }, - "displayName": { - "type": "string", - "description": "The resource type display name." - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperation" - }, - "description": "The resource type operations." - } - }, - "description": "Resource Type" - }, - "ProviderOperationsMetadata": { - "properties": { - "id": { - "type": "string", - "description": "The provider id." - }, - "name": { - "type": "string", - "description": "The provider name." - }, - "type": { - "type": "string", - "description": "The provider type." - }, - "displayName": { - "type": "string", - "description": "The provider display name." - }, - "resourceTypes": { - "type": "array", - "items": { - "$ref": "#/definitions/ResourceType" - }, - "description": "The provider resource types" - }, - "operations": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperation" - }, - "description": "The provider operations." - } - }, - "description": "Provider Operations metadata" - }, - "ProviderOperationsMetadataListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ProviderOperationsMetadata" - }, - "description": "The list of providers." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Provider operations metadata list" - }, - "PermissionGetResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Permission" - }, - "description": "An array of permissions." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Permissions information." - }, - "RoleDefinitionFilter": { - "properties": { - "roleName": { - "type": "string", - "description": "Returns role definition with the specific name." - }, - "type": { - "type": "string", - "description": "Returns role definition with the specific type." - } - }, - "description": "Role Definitions filter" - }, - "RoleDefinitionProperties": { - "properties": { - "roleName": { - "type": "string", - "description": "The role name." - }, - "description": { - "type": "string", - "description": "The role definition description." - }, - "type": { - "type": "string", - "description": "The role type.", - "x-ms-client-name": "roleType" - }, - "permissions": { - "type": "array", - "items": { - "$ref": "#/definitions/Permission" - }, - "description": "Role definition permissions." - }, - "assignableScopes": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Role definition assignable scopes." - } - }, - "description": "Role definition properties." - }, - "RoleDefinition": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The role definition ID." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The role definition name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The role definition type." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleDefinitionProperties", - "description": "Role definition properties." - } - }, - "description": "Role definition." - }, - "RoleDefinitionListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleDefinition" - }, - "description": "Role definition list." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Role definition list operation result." - }, - "RoleAssignmentFilter": { - "properties": { - "principalId": { - "type": "string", - "description": "Returns role assignment of the specific principal." - }, - "canDelegate": { - "type": "boolean", - "description": "The Delegation flag for the roleassignment" - } - }, - "description": "Role Assignments filter" - }, - "RoleAssignmentPropertiesWithScope": { - "properties": { - "scope": { - "type": "string", - "description": "The role assignment scope." - }, - "roleDefinitionId": { - "type": "string", - "description": "The role definition ID." - }, - "principalId": { - "type": "string", - "description": "The principal ID." - }, - "canDelegate": { - "type": "boolean", - "description": "The Delegation flag for the roleassignment" - } - }, - "description": "Role assignment properties with scope." - }, - "RoleAssignment": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "The role assignment ID." - }, - "name": { - "type": "string", - "readOnly": true, - "description": "The role assignment name." - }, - "type": { - "type": "string", - "readOnly": true, - "description": "The role assignment type." - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", - "description": "Role assignment properties." - } - }, - "description": "Role Assignments" - }, - "RoleAssignmentListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/RoleAssignment" - }, - "description": "Role assignment list." - }, - "nextLink": { - "type": "string", - "description": "The URL to use for getting the next set of results." - } - }, - "description": "Role assignment list operation result." - }, - "RoleAssignmentProperties": { - "properties": { - "roleDefinitionId": { - "type": "string", - "description": "The role definition ID used in the role assignment." - }, - "principalId": { - "type": "string", - "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." - }, - "principalType": { - "type": "string", - "description": "The principal type of the assigned principal ID.", - "enum": [ - "User", - "Group", - "ServicePrincipal", - "Unknown", - "DirectoryRoleTemplate", - "ForeignGroup", - "Application", - "MSI", - "DirectoryObjectOrGroup", - "Everyone" - ], - "x-ms-enum": { - "name": "PrincipalType", - "modelAsString": true - } - }, - "canDelegate": { - "type": "boolean", - "description": "The delgation flag used for creating a role assignment" - } - }, - "required": [ - "roleDefinitionId", - "principalId" - ], - "description": "Role assignment properties." - }, - "RoleAssignmentCreateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RoleAssignmentProperties", - "description": "Role assignment properties." - } - }, - "required": [ - "properties" - ], - "description": "Role assignment create parameters." - }, - "Permission": { - "properties": { - "actions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed actions." - }, - "notActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Denied actions." - }, - "dataActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Allowed Data actions." - }, - "notDataActions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Denied Data actions." - } - }, - "description": "Role definition permissions." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the target subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for this operation." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group.", - "x-ms-parameter-location": "method" - }, - "ResourceProviderNamespaceParameter": { - "name": "resourceProviderNamespace", - "in": "path", - "required": true, - "type": "string", - "description": "The namespace of the resource provider.", - "x-ms-parameter-location": "method" - } - } -} \ No newline at end of file diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json index 8659ad8e2bef..ddbaaea7afdb 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json @@ -6,7 +6,7 @@ "properties": { "roleDefinitionId": "/subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/roleDefinitions/de139f84-1756-47ae-9be6-808fbbe84772", "principalId": "d93a38bc-d029-4160-bfb0-fbda779ac214", - "principalType": "User", + "principalType": "User", "canDelegate":false } }, diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index 3c5f59689b9f..4e9fe2de1813 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the Authorization API. ``` yaml openapi-type: arm -tag: package-2018-07-01-preview +tag: package-2018-09-01-preview ``` ## Suppression @@ -91,7 +91,9 @@ These settings apply only when `--tag=package-2018-01-01-preview-only` is specif ``` yaml $(tag) == 'package-2018-01-01-preview-only' input-file: -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json ``` ### Tag: package-2018-07-01-preview-only @@ -109,7 +111,7 @@ These settings apply only when `--tag=package-2018-09-01-preview-only` is specif ``` yaml $(tag) == 'package-2018-09-01-preview-only' input-file: -- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json +- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json ``` ### Tag: package-2017-10-01-preview @@ -130,7 +132,9 @@ These settings apply only when `--tag=package-2018-01-01-preview` is specified o ``` yaml $(tag) == 'package-2018-01-01-preview' input-file: - Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json ``` ### Tag: package-2018-07-01-preview @@ -140,7 +144,9 @@ These settings apply only when `--tag=package-2018-07-01-preview` is specified o ``` yaml $(tag) == 'package-2018-07-01-preview' input-file: - Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleBasedCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json - Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json ``` @@ -151,7 +157,9 @@ These settings apply only when `--tag=package-2018-09-01-preview` is specified o ``` yaml $(tag) == 'package-2018-09-01-preview' input-file: - Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json -- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleBasedCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json - Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json ``` @@ -182,6 +190,15 @@ swagger-to-sdk: See configuration in [readme.go.md](./readme.go.md) +### Tag: package-2018-09-01-preview and go + +These settings apply only when `--tag=package-2018-09-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/authorization/mgmt/2018-09-01-preview/authorization +``` + ## Java These settings apply only when `--java` is specified on the command line. From c93f19b90f7e2b04e05226b140e26841ecf638b0 Mon Sep 17 00:00:00 2001 From: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com> Date: Tue, 6 Nov 2018 09:51:02 +0800 Subject: [PATCH 101/464] Enable delete activity (#4386) * Enable delete activity * Enable delete activity. * Update --- .../2018-06-01/entityTypes/Pipeline.json | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 24fdecaf29ea..b9d1154b8b16 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 @@ -2327,6 +2327,41 @@ "pipeline" ] }, + "DeleteActivity": { + "x-ms-discriminator-value": "Delete", + "description": "Delete activity.", + "allOf": [ + { + "$ref": "#/definitions/ExecutionActivity" + } + ], + "properties": { + "typeProperties": { + "description": "Delete activity properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DeleteActivityTypeProperties" + } + }, + "required": [ + "typeProperties" + ] + }, + "DeleteActivityTypeProperties": { + "description": "Delete activity properties.", + "properties": { + "recursive": { + "type": "object", + "description": "If true, files under the folder path will be deleted recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + }, + "dataset": { + "description": "Delete activity dataset reference.", + "$ref": "../datafactory.json#/definitions/DatasetReference" + } + }, + "required": [ + "dataset" + ] + }, "LookupActivity": { "x-ms-discriminator-value": "Lookup", "description": "Lookup activity.", From 3869689cbdb70abe1804d639b6a6acce47232612 Mon Sep 17 00:00:00 2001 From: Bo Xiao Date: Tue, 6 Nov 2018 10:41:31 +0800 Subject: [PATCH 102/464] [DataFactory]Add sensitive fields extracted from connection string in swagger for AKV reference (#4375) * Add sensitive fields extracted from connection string in swagger for akv reference * Change sasUri type to object as it supports string, SecureString and AzureKeyVaultSecretReference, same with connection string. --- .../2018-06-01/entityTypes/LinkedService.json | 80 ++++++++++++++++++- 1 file changed, 76 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index b893ab4f12a0..224334b3370e 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -109,9 +109,17 @@ "description": "The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "accountKey": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, "sasUri": { - "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." }, "encryptedCredential": { "type": "string", @@ -126,9 +134,17 @@ "type": "object", "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." }, + "accountKey": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, "sasUri": { - "description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "description": "SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference.", + "type": "object" + }, + "sasToken": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of sasToken in sas uri." }, "serviceEndpoint": { "type": "string", @@ -179,6 +195,10 @@ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "servicePrincipalId": { "type": "object", "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." @@ -271,6 +291,10 @@ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "servicePrincipalId": { "type": "object", "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." @@ -406,6 +430,10 @@ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "accountKey": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of accountKey in connection string." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." @@ -620,6 +648,10 @@ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." @@ -656,6 +688,10 @@ "description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." @@ -692,6 +728,10 @@ "description": "The connection string.", "$ref": "../datafactory.json#/definitions/SecretBase" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." @@ -728,6 +768,10 @@ "description": "The connection string.", "$ref": "../datafactory.json#/definitions/SecretBase" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." @@ -2132,6 +2176,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "password": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -2222,6 +2270,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "credString": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of credString in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -2255,6 +2307,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -2430,6 +2486,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -2924,6 +2984,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -3730,6 +3794,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" @@ -3763,6 +3831,10 @@ "description": "An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference.", "type": "object" }, + "pwd": { + "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "description": "The Azure key vault secret reference of password in connection string." + }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" From 1bd949d3894188e6b1a0a6b83da3abb080fbf1d8 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 6 Nov 2018 09:35:22 -0800 Subject: [PATCH 103/464] remove time from API version (#4382) --- .../stable/2018-05-05/AlertsManagement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json index a552dcdb9e63..b1669d0a2fe1 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json @@ -539,7 +539,7 @@ "in": "query", "required": true, "enum": [ - "2018-05-05T00:00:00.000Z" + "2018-05-05" ], "x-ms-enum": { "name": "api-version", From 487d177c5fc08020c8c72ed11a4ab6e274927413 Mon Sep 17 00:00:00 2001 From: Jianghao Lu Date: Tue, 6 Nov 2018 09:57:37 -0800 Subject: [PATCH 104/464] Add latest data migration service tag to java config (#4407) * Add latest data migration service tag to java config * Add azure-sdk-for-java entry --- .../datamigration/resource-manager/readme.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 8a725f2e71a0..8a0cf304bde5 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -163,6 +163,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-sdk-for-java ``` ## C# @@ -229,10 +230,24 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-datamigration ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-07-15-preview - tag: package-2017-11-15-preview - tag: package-2018-03-31-preview ``` +### Tag: package-2018-07-15-preview and java + +These settings apply only when `--tag=package-2018-07-15-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-07-15-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.azuredatabasemigrationservice.v2018_07_15_preview + output-folder: $(azure-libraries-for-java-folder)/azuredatabasemigrationservice/resource-manager/v2018_07_15_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2017-11-15-preview and java These settings apply only when `--tag=package-2017-11-15-preview --java` is specified on the command line. From 83fcb76797a4baee5b263d97dcfae9eb0245baa7 Mon Sep 17 00:00:00 2001 From: lubalibu <39737466+lubalibu@users.noreply.github.com> Date: Wed, 7 Nov 2018 00:36:16 +0200 Subject: [PATCH 105/464] Fix blob auditing documentation (#4403) * FIx blob auditing swaggers documentation * fix blob auditing alignment --- .../preview/2015-05-01-preview/blobAuditing.json | 4 ++-- .../preview/2017-03-01-preview/blobAuditing.json | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json index da0b92c5a6bb..21da90edee76 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json @@ -164,7 +164,7 @@ "type": "integer" }, "auditActionsAndGroups": { - "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", "type": "array", "items": { "type": "string" @@ -180,7 +180,7 @@ "type": "boolean" }, "isAzureMonitorTargetEnabled": { - "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", "type": "boolean" } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json index 11bea1ff64a2..8db4117553d7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/blobAuditing.json @@ -473,7 +473,7 @@ "type": "integer" }, "auditActionsAndGroups": { - "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", "type": "array", "items": { "type": "string" @@ -489,7 +489,7 @@ "type": "boolean" }, "isAzureMonitorTargetEnabled": { - "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", "type": "boolean" } } @@ -551,7 +551,7 @@ "type": "integer" }, "auditActionsAndGroups": { - "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", "type": "array", "items": { "type": "string" @@ -567,7 +567,7 @@ "type": "boolean" }, "isAzureMonitorTargetEnabled": { - "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", "type": "boolean" } } @@ -625,7 +625,7 @@ "type": "integer" }, "auditActionsAndGroups": { - "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", "type": "array", "items": { "type": "string" @@ -641,7 +641,7 @@ "type": "boolean" }, "isAzureMonitorTargetEnabled": { - "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", "type": "boolean" } } @@ -699,7 +699,7 @@ "type": "integer" }, "auditActionsAndGroups": { - "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n ON BY \r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE:: and SCHEMA:: are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", + "description": "Specifies the Actions-Groups and Actions to audit.\r\n\r\nThe recommended set of action groups to use is the following combination - this will audit all the queries and stored procedures executed against the database, as well as successful and failed logins:\r\n\r\nBATCH_COMPLETED_GROUP,\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP,\r\nFAILED_DATABASE_AUTHENTICATION_GROUP.\r\n\r\nThis above combination is also the set that is configured by default when enabling auditing from the Azure portal.\r\n\r\nThe supported action groups to audit are (note: choose only specific groups that cover your auditing needs. Using unnecessary groups could lead to very large quantities of audit records):\r\n\r\nAPPLICATION_ROLE_CHANGE_PASSWORD_GROUP\r\nBACKUP_RESTORE_GROUP\r\nDATABASE_LOGOUT_GROUP\r\nDATABASE_OBJECT_CHANGE_GROUP\r\nDATABASE_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nDATABASE_OBJECT_PERMISSION_CHANGE_GROUP\r\nDATABASE_OPERATION_GROUP\r\nDATABASE_PERMISSION_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_CHANGE_GROUP\r\nDATABASE_PRINCIPAL_IMPERSONATION_GROUP\r\nDATABASE_ROLE_MEMBER_CHANGE_GROUP\r\nFAILED_DATABASE_AUTHENTICATION_GROUP\r\nSCHEMA_OBJECT_ACCESS_GROUP\r\nSCHEMA_OBJECT_CHANGE_GROUP\r\nSCHEMA_OBJECT_OWNERSHIP_CHANGE_GROUP\r\nSCHEMA_OBJECT_PERMISSION_CHANGE_GROUP\r\nSUCCESSFUL_DATABASE_AUTHENTICATION_GROUP\r\nUSER_CHANGE_PASSWORD_GROUP\r\nBATCH_STARTED_GROUP\r\nBATCH_COMPLETED_GROUP\r\n\r\nThese are groups that cover all sql statements and stored procedures executed against the database, and should not be used in combination with other groups as this will result in duplicate audit logs.\r\n\r\nFor more information, see [Database-Level Audit Action Groups](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-action-groups).\r\n\r\nFor Database auditing policy, specific Actions can also be specified (note that Actions cannot be specified for Server auditing policy). The supported actions to audit are:\r\nSELECT\r\nUPDATE\r\nINSERT\r\nDELETE\r\nEXECUTE\r\nRECEIVE\r\nREFERENCES\r\n\r\nThe general form for defining an action to be audited is:\r\n{action} ON {object} BY {principal}\r\n\r\nNote that in the above format can refer to an object like a table, view, or stored procedure, or an entire database or schema. For the latter cases, the forms DATABASE::{db_name} and SCHEMA::{schema_name} are used, respectively.\r\n\r\nFor example:\r\nSELECT on dbo.myTable by public\r\nSELECT on DATABASE::myDatabase by public\r\nSELECT on SCHEMA::mySchema by public\r\n\r\nFor more information, see [Database-Level Audit Actions](https://docs.microsoft.com/en-us/sql/relational-databases/security/auditing/sql-server-audit-action-groups-and-actions#database-level-audit-actions)", "type": "array", "items": { "type": "string" @@ -715,7 +715,7 @@ "type": "boolean" }, "isAzureMonitorTargetEnabled": { - "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as .\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions//resourceGroups//providers/Microsoft.Sql/servers//databases//providers/microsoft.insights/diagnosticSettings/?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", + "description": "Specifies whether audit events are sent to Azure Monitor. \r\nIn order to send the events to Azure Monitor, specify 'State' as 'Enabled' and 'IsAzureMonitorTargetEnabled' as true.\r\n\r\nWhen using REST API to configure auditing, Diagnostic Settings with 'SQLSecurityAuditEvents' diagnostic logs category on the database should be also created.\r\nNote that for server level audit you should use the 'master' database as {databaseName}.\r\n\r\nDiagnostic Settings URI format:\r\nPUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/providers/microsoft.insights/diagnosticSettings/{settingsName}?api-version=2017-05-01-preview\r\n\r\nFor more information, see [Diagnostic Settings REST API](https://go.microsoft.com/fwlink/?linkid=2033207)\r\nor [Diagnostic Settings PowerShell](https://go.microsoft.com/fwlink/?linkid=2033043)\r\n", "type": "boolean" } } From 1a5061c46c9ad4277a052f1c43b08829851d4030 Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Wed, 7 Nov 2018 01:29:13 +0200 Subject: [PATCH 106/464] Update Vulnerability Assessment swaggers (#4394) Update Vulnerability Assessment swaggers --- ...abaseVulnerabilityAssessmentBaselines.json | 6 +- .../databaseVulnerabilityAssessmentScans.json | 132 ++++++++---------- ...seVulnerabilityAssessmentScansExecute.json | 2 +- ...seVulnerabilityAssesmentRuleBaselines.json | 6 +- ...dDatabaseVulnerabilityAssessmentScans.json | 8 +- 5 files changed, 66 insertions(+), 88 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json index 994880c297fc..2fb99ff46b5a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json @@ -88,7 +88,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -177,7 +177,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -254,7 +254,7 @@ "description": "Successfully removed the database vulnerability assessment rule baseline." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json index b71a26acb61c..f7a244ea8ef9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -16,13 +16,13 @@ "application/json" ], "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans": { "get": { "tags": [ "DatabaseVulnerabilityAssessmentScans" ], - "description": "Gets a vulnerability assessment scan record of a database.", - "operationId": "DatabaseVulnerabilityAssessmentScans_Get", + "description": "Lists the vulnerability assessment scans of a database.", + "operationId": "DatabaseVulnerabilityAssessmentScans_ListByDatabase", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" @@ -47,13 +47,6 @@ "modelAsString": true } }, - { - "name": "scanId", - "in": "path", - "description": "The vulnerability assessment scan Id of the scan to retrieve.", - "required": true, - "type": "string" - }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -63,29 +56,32 @@ ], "responses": { "200": { - "description": "Successfully retrieved the database vulnerability assessment scan record.", + "description": "Successfully retrieved the database vulnerability assessment scan records.", "schema": { - "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + "$ref": "#/definitions/VulnerabilityAssessmentScanRecordListResult" } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Gets a database vulnerability assessment scan record by scan ID": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json" + "Gets the list of a database vulnerability assessment scan records": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan": { - "post": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}": { + "get": { "tags": [ "DatabaseVulnerabilityAssessmentScans" ], - "description": "Executes a Vulnerability Assessment database scan.", - "operationId": "DatabaseVulnerabilityAssessmentScans_InitiateScan", + "description": "Gets a vulnerability assessment scan record of a database.", + "operationId": "DatabaseVulnerabilityAssessmentScans_Get", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" @@ -126,30 +122,29 @@ ], "responses": { "200": { - "description": "Successfully executed a Vulnerability Assessment database scan." + "description": "Successfully retrieved the database vulnerability assessment scan record.", + "schema": { + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." - }, - "202": { - "description": "Successfully started a Vulnerability Assessment database scan." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Executes a database's vulnerability assessment scan.": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentScansExecute.json" + "Gets a database vulnerability assessment scan record by scan ID": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsGet.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans": { - "get": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/vulnerabilityAssessments/{vulnerabilityAssessmentName}/scans/{scanId}/initiateScan": { + "post": { "tags": [ - "DatabaseVulnerabilityAssessmentScans" + "DatabaseVulnerabilityAssessmentScansExecute" ], - "description": "Lists the vulnerability assessment scans of a database.", - "operationId": "DatabaseVulnerabilityAssessmentScans_ListByDatabase", + "description": "Executes a Vulnerability Assessment database scan.", + "operationId": "DatabaseVulnerabilityAssessmentScans_InitiateScan", "parameters": [ { "$ref": "#/parameters/ResourceGroupParameter" @@ -174,6 +169,13 @@ "modelAsString": true } }, + { + "name": "scanId", + "in": "path", + "description": "The vulnerability assessment scan Id of the scan to retrieve.", + "required": true, + "type": "string" + }, { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -183,21 +185,19 @@ ], "responses": { "200": { - "description": "Successfully retrieved the database vulnerability assessment scan records.", - "schema": { - "$ref": "#/definitions/VulnerabilityAssessmentScanRecordListResult" - } + "description": "Successfully executed a Vulnerability Assessment database scan." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + "description": "*** Error Responses: ***\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + }, + "202": { + "description": "Successfully started a Vulnerability Assessment database scan." } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gets the list of a database vulnerability assessment scan records": { - "$ref": "./examples/DatabaseVulnerabilityAssessmentScanRecordsListByDatabase.json" + "Executes a database's vulnerability assessment scan.": { + "$ref": "./examples/DatabaseVulnerabilityAssessmentScansExecute.json" } } } @@ -259,7 +259,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 DatabaseVulnerabilityAssessmentOperationFailed - An error has occurred while trying to execute Vulnerability Assessment operation, please try again later" + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Scan result was converted successfully.", @@ -277,25 +277,22 @@ } }, "definitions": { - "VulnerabilityAssessmentRecurringScansProperties": { - "description": "Properties of a Vulnerability Assessment recurring scans.", + "VulnerabilityAssessmentScanRecordListResult": { + "description": "A list of vulnerability assessment scan records.", "type": "object", "properties": { - "isEnabled": { - "description": "Recurring scans state.", - "type": "boolean" - }, - "emailSubscriptionAdmins": { - "description": "Specifies that the schedule scan notification will be is sent to the subscription administrators.", - "default": true, - "type": "boolean" - }, - "emails": { - "description": "Specifies an array of e-mail addresses to which the scan notification is sent.", + "value": { + "description": "Array of results.", "type": "array", "items": { - "type": "string" - } + "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true } } }, @@ -401,25 +398,6 @@ } } }, - "VulnerabilityAssessmentScanRecordListResult": { - "description": "A list of vulnerability assessment scan records.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/VulnerabilityAssessmentScanRecord" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, "DatabaseVulnerabilityAssessmentScanExportProperties": { "description": "Properties of the export operation's result.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json index 79dfbb4f8780..adbd6eb90e53 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/examples/DatabaseVulnerabilityAssessmentScansExecute.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "00000000-1111-2222-3333-444444444444", "resourceGroupName": "vulnerabilityassessmenttest-4711", - "serverName": "vulnerabilityassessmenttest-6440", + "serverName": "vulnerabilityassessmenttest-6411", "databaseName": "testdb", "vulnerabilityAssessmentName": "default", "scanId": "scan01", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json index bb0e0f296906..2cdce03b6ccb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssesmentRuleBaselines.json @@ -92,7 +92,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -185,7 +185,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -266,7 +266,7 @@ "description": "Successfully removed the database vulnerability assessment rule baseline." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 VulnerabilityAssessmentStorageAuthenticationFailed - Could not authenticate to storage account '{0}' .\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 VulnerabilityAssessmentInvalidStorageAccount - The storage account '{0}' that was defined in the policy is invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 VulnerabilityAssessmentRuleDoesNotExists - Rule '{0}' does not exist.\n\n * 404 VulnerabilityAssessmentBaselineDoesNotExists - Baseline does not exist for rule '{0}'\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json index a400eb71cfeb..63dac3d431eb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/managedDatabaseVulnerabilityAssessmentScans.json @@ -66,7 +66,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-pageable": { @@ -136,7 +136,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." } }, "x-ms-examples": { @@ -200,7 +200,7 @@ "description": "Successfully executed a Vulnerability Assessment database scan." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 InvalidVulnerabilityAssessmentScanIdLength - The vulnerability assessment scan ID length must be below {0} characters.\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "202": { "description": "Successfully started a Vulnerability Assessment database scan." @@ -275,7 +275,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 InvalidDatabaseVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." + "description": "*** Error Responses: ***\n\n * 400 InvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 InvalidStorageAccountCredentials - The provided storage account shared access signature or account storage key is not valid.\n\n * 400 VulnerabilityAssessmentInvalidPolicy - Vulnerability Assessment settings don't exist or invalid storage specified in settings. \n\n * 400 DatabaseVulnerabilityAssessmentMissingStorageContainerPath - Storage container path must be provided if it isn't set in server level policy\n\n * 400 VulnerabilityAssessmentDatawarehouseDatabaseIsDeactivated - Could not execute Vulnerability Assessment operation because the database is paused. Please resume it.\n\n * 400 InvalidVulnerabilityAssessmentOperationRequest - The vulnerability assessment operation request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 409 DatabaseVulnerabilityAssessmentScanIsAlreadyInProgress - Vulnerability Assessment scan is already in progress.\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later." }, "201": { "description": "Scan result was converted successfully.", From b649f121d567886c988ae1f7caea6687500b15f3 Mon Sep 17 00:00:00 2001 From: v-djnisi <43036465+v-djnisi@users.noreply.github.com> Date: Wed, 7 Nov 2018 19:17:58 +0100 Subject: [PATCH 107/464] Managed Instance short term retention (#3979) * new changes * First commit * Readme.md change --- .../ManagedBackupShortTermRetention.json | 431 +++++++++++++++++ ...roppedDatabaseBackupShortTermRetenion.json | 443 ++++++++++++++++++ ...etListManagedShortTermRetentionPolicy.json | 33 ++ ...tTermRetentionPolicyRestorableDropped.json | 33 ++ .../GetManagedShortTermRetentionPolicy.json | 22 + ...tTermRetentionPolicyRestorableDropped.json | 22 + ...UpdateManagedShortTermRetentionPolicy.json | 27 ++ ...tTermRetentionPolicyRestorableDropped.json | 27 ++ specification/sql/resource-manager/readme.md | 5 + 9 files changed, 1043 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicy.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicyRestorableDropped.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicy.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicyRestorableDropped.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicy.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json new file mode 100644 index 000000000000..4c45ce963829 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json @@ -0,0 +1,431 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies/{policyName}": { + "get": { + "tags": [ + "ManagedBackupShortTermRetentionPolicies" + ], + "description": "Gets a managed database's short term retention policy.", + "operationId": "ManagedBackupShortTermRetentionPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/GetManagedShortTermRetentionPolicy.json" + } + } + }, + "put": { + "tags": [ + "ManagedBackupShortTermRetentionPolicies" + ], + "description": "Updates a managed database's short term retention policy.", + "operationId": "ManagedBackupShortTermRetentionPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateManagedShortTermRetentionPolicy.json" + } + } + }, + "patch": { + "tags": [ + "ManagedBackupShortTermRetentionPolicies" + ], + "description": "Updates a managed database's short term retention policy.", + "operationId": "ManagedBackupShortTermRetentionPolicies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The short term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the database.": { + "$ref": "./examples/UpdateManagedShortTermRetentionPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/backupShortTermRetentionPolicies": { + "get": { + "tags": [ + "ManagedBackupShortTermRetentionPolicies" + ], + "description": "Gets a managed database's short term retention policy list.", + "operationId": "ManagedBackupShortTermRetentionPolicies_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the short term retention policy list for the database.": { + "$ref": "./examples/GetListManagedShortTermRetentionPolicy.json" + } + } + } + } + }, + "definitions": { + "ManagedBackupShortTermRetentionPolicyProperties": { + "description": "Properties of a short term retention policy", + "type": "object", + "properties": { + "retentionDays": { + "format": "int32", + "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", + "type": "integer" + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ManagedBackupShortTermRetentionPolicy": { + "description": "A short term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedBackupShortTermRetentionPolicyListResult": { + "description": "A list of short term retention policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json new file mode 100644 index 000000000000..0c60a68988ee --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedRestorableDroppedDatabaseBackupShortTermRetenion.json @@ -0,0 +1,443 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies/{policyName}": { + "get": { + "tags": [ + "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies" + ], + "description": "Gets a dropped database's short term retention policy.", + "operationId": "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "restorableDroppedDatabaseId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policies.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Get the short term retention policy for the database.": { + "$ref": "./examples/GetManagedShortTermRetentionPolicyRestorableDropped.json" + } + } + }, + "put": { + "tags": [ + "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies" + ], + "description": "Sets a database's long term retention policy.", + "operationId": "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "restorableDroppedDatabaseId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The long term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the restorable dropped database.": { + "$ref": "./examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json" + } + } + }, + "patch": { + "tags": [ + "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies" + ], + "description": "Sets a database's long term retention policy.", + "operationId": "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "restorableDroppedDatabaseId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "policyName", + "in": "path", + "description": "The policy name. Should always be \"default\".", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "ManagedShortTermRetentionPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The long term retention policy info.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the policy.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 InvalidBackupRetentionDays - The retention days of {0} is not a valid configuration. Valid backup retention must be in 7-day increments (7, 14, 21, etc.)\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 InvalidParameterValue - An invalid value was given to a parameter.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the short term retention policy for the restorable dropped database.": { + "$ref": "./examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/restorableDroppedDatabases/{restorableDroppedDatabaseId}/backupShortTermRetentionPolicies": { + "get": { + "tags": [ + "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies" + ], + "description": "Gets a dropped database's short term retention policy list.", + "operationId": "ManagedRestorableDroppedDatabaseBackupShortTermRetentionPolicies_ListByRestorableDroppedDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "restorableDroppedDatabaseId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the policies.", + "schema": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the short term retention policy list for the database.": { + "$ref": "./examples/GetListManagedShortTermRetentionPolicyRestorableDropped.json" + } + } + } + } + }, + "definitions": { + "ManagedBackupShortTermRetentionPolicyProperties": { + "description": "Properties of a short term retention policy", + "type": "object", + "properties": { + "retentionDays": { + "format": "int32", + "description": "The backup retention period in days. This is how many days Point-in-Time Restore will be supported.", + "type": "integer" + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ManagedBackupShortTermRetentionPolicy": { + "description": "A short term retention policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedBackupShortTermRetentionPolicyListResult": { + "description": "A list of short term retention policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedBackupShortTermRetentionPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicy.json new file mode 100644 index 000000000000..0c6e8f5f9f8d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicy.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "testsvr", + "databaseName": "testdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicyRestorableDropped.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicyRestorableDropped.json new file mode 100644 index 000000000000..35f09cae6cfc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetListManagedShortTermRetentionPolicyRestorableDropped.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "testsvr", + "restorableDroppedDatabaseId": "testdb,131403269876900000", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicy.json new file mode 100644 index 000000000000..6f2e17aaa06a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicyRestorableDropped.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicyRestorableDropped.json new file mode 100644 index 000000000000..02d39ec2858f --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/GetManagedShortTermRetentionPolicyRestorableDropped.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "testsvr", + "restorableDroppedDatabaseId": "testdb,131403269876900000", + "policyName": "default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicy.json new file mode 100644 index 000000000000..d359fe738faa --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicy.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup", + "managedInstanceName": "testsvr", + "databaseName": "testdb", + "policyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "retentionDays": 14 + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/managedInstance/testsvr/databases/testdb/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/databases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json new file mode 100644 index 000000000000..a11cd4705fcc --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/UpdateManagedShortTermRetentionPolicyRestorableDropped.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup", + "managedInstanceName": "testsvr", + "restorableDroppedDatabaseId": "testdb,131403269876900000", + "policyName": "default", + "api-version": "2017-03-01-preview", + "parameters": { + "retentionDays": 14 + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup/providers/Microsoft.Sql/managedInstance/testsvr/restorableDroppedDatabases/testdb,131403269876900000/backupShortTermRetentionPolicies/default", + "name": "default", + "type": "Microsoft.Sql/managedInstances/restorableDroppedDatabases/backupShortTermRetentionPolicies", + "properties": { + "retentionDays": 14 + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 859bf982961a..1a1f097b615e 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -87,6 +87,7 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - Microsoft.Sql/preview/2017-03-01-preview/jobs.json - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json @@ -167,6 +168,7 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - Microsoft.Sql/preview/2017-03-01-preview/jobs.json - Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json @@ -238,6 +240,7 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessmentBaselines.json - Microsoft.Sql/preview/2017-03-01-preview/databaseVulnerabilityAssessments.json - Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json @@ -310,6 +313,7 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json - Microsoft.Sql/preview/2017-03-01-preview/jobs.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json @@ -451,6 +455,7 @@ input-file: - ./Microsoft.Sql/preview/2017-03-01-preview/dataWarehouseUserActivities.json - ./Microsoft.Sql/preview/2017-03-01-preview/jobs.json - ./Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedBackupShortTermRetention.json - ./Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json - ./Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - ./Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json From 5d8ae3def854d538138f50dca983de41f3efc522 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Fri, 9 Nov 2018 01:40:18 +0800 Subject: [PATCH 108/464] fixing sample names in cognitive services (#4422) --- .../stable/2017-04-18/cognitiveservices.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json index 20a160ae7423..f9d6903ce0b3 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json @@ -35,7 +35,7 @@ "description": "Create Cognitive Services Account. Accounts is a resource group wide resource type. It holds the keys for developer to access intelligent APIs. It's also the resource type for billing.", "operationId": "Accounts_Create", "x-ms-examples": { - "Get Account": { + "Create Account": { "$ref": "./examples/CreateAccount.json" } }, @@ -101,7 +101,7 @@ "description": "Updates a Cognitive Services account", "operationId": "Accounts_Update", "x-ms-examples": { - "Get Account": { + "Update Account": { "$ref": "./examples/UpdateAccount.json" } }, From 0307edd6d3f9b88e1274da106bb8ea94aaa87e0e Mon Sep 17 00:00:00 2001 From: NMijat1024 Date: Thu, 8 Nov 2018 18:52:56 +0100 Subject: [PATCH 109/464] Update swagger documetation to mark Collation property as writable. (#4314) * Update swagger documetation to mark Collation property as writable. Change Managed Instance collation property from read only to read and create. Add collation to properties section in ManagedInstanceCreateMax example. VSTS task: 12336257 * Remove 'cosmetics' from swagger. * Remove comma as redundant * Return to the initial, generated state. --- .../examples/ManagedInstanceCreateMax.json | 1 + .../preview/2015-05-01-preview/managedInstances.json | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json index cc20751023a9..8d561e0a5abe 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/examples/ManagedInstanceCreateMax.json @@ -22,6 +22,7 @@ "vCores": 8, "storageSizeInGB": 1024, "licenseType": "Full", + "collation": "SQL_Latin1_General_CP1_CI_AS", "dnsZonePartner": "/subscriptions/20D7082A-0FC7-4468-82BD-542694D5042B/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testinstance" } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json index 8e3171ce8e68..6af4102fcf51 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json @@ -355,7 +355,10 @@ "collation": { "description": "Collation of the managed instance.", "type": "string", - "readOnly": true + "x-ms-mutability": [ + "read", + "create" + ] }, "dnsZone": { "description": "The Dns Zone that the managed instance is in.", From c6bc2db381d5ca60618be1f68f60c2e891cd9c66 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Fri, 9 Nov 2018 03:17:37 +0800 Subject: [PATCH 110/464] fixed some invalid values in dl account examples (#4414) --- .../stable/2016-11-01/examples/Accounts_Create.json | 12 ++++++------ .../stable/2016-11-01/examples/Accounts_Get.json | 4 ++-- .../stable/2016-11-01/examples/Accounts_List.json | 2 +- .../examples/Accounts_ListByResourceGroup.json | 2 +- .../stable/2016-11-01/examples/Accounts_Update.json | 12 ++++++------ .../stable/2016-11-01/examples/Accounts_Create.json | 6 +++--- .../stable/2016-11-01/examples/Accounts_Get.json | 2 +- .../stable/2016-11-01/examples/Accounts_List.json | 2 +- .../examples/Accounts_ListByResourceGroup.json | 2 +- .../stable/2016-11-01/examples/Accounts_Update.json | 6 +++--- 10 files changed, 25 insertions(+), 25 deletions(-) diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Create.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Create.json index e6ea0edac6d3..c37a85108dbc 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Create.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Create.json @@ -5,12 +5,12 @@ "resourceGroupName": "contosorg", "accountName": "contosoadla", "parameters": { - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, "properties": { - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "name": "test_adls", "properties": { @@ -57,7 +57,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -68,7 +68,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", @@ -124,7 +124,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -135,7 +135,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Get.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Get.json index bc959281964c..a23b56e134bb 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Get.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Get.json @@ -11,7 +11,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -22,7 +22,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_List.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_List.json index b0129e40bea8..35783421c127 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_List.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_List.json @@ -16,7 +16,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "test_account", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json index 0f1e4a6926ad..ed943f7e8615 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json @@ -17,7 +17,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "test_account", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Update.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Update.json index 5a617f9ec664..8c4cb32d43a6 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Update.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/stable/2016-11-01/examples/Accounts_Update.json @@ -42,7 +42,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -53,7 +53,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", @@ -109,7 +109,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -120,7 +120,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", @@ -176,7 +176,7 @@ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rgaba12041/providers/Microsoft.DataLakeAnalytics/accounts/testaba15818", "name": "test_account", "type": "Microsoft.DataLakeAnalytics/accounts", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -187,7 +187,7 @@ "creationTime": "2017-04-14T13:21:56.6819037-07:00", "lastModifiedTime": "2017-04-14T13:21:56.6819037-07:00", "endpoint": "test_endpoint", - "defaultDataLakeStoreAccount": "test_account", + "defaultDataLakeStoreAccount": "test_adls", "dataLakeStoreAccounts": [{ "id": "test_adls_id", "name": "test_adls", diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Create.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Create.json index 3e47bad9601f..aa07bd7b7140 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Create.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Create.json @@ -5,7 +5,7 @@ "resourceGroupName": "contosorg", "accountName": "contosoadla", "parameters": { - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -49,7 +49,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -106,7 +106,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Get.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Get.json index 1164abb7ffcb..175c009bfeb2 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Get.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Get.json @@ -11,7 +11,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json index 40d0c767db01..ddb2b708e786 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_List.json @@ -16,7 +16,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json index 36c407671507..58cb0aae853a 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_ListByResourceGroup.json @@ -17,7 +17,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Update.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Update.json index fa44341218d0..6500a29b52da 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Update.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/stable/2016-11-01/examples/Accounts_Update.json @@ -28,7 +28,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -85,7 +85,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, @@ -142,7 +142,7 @@ "id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "name": "contosoadla", "type": "test_type", - "location": "test_location", + "location": "eastus2", "tags": { "test_key": "test_value" }, From 5a019db49a84eb7ac3b62c0756fa8acf70e0ea21 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 8 Nov 2018 13:03:36 -0800 Subject: [PATCH 111/464] Add generating package.json to KeyVault data plane package (#4429) --- specification/keyvault/data-plane/readme.typescript.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/keyvault/data-plane/readme.typescript.md b/specification/keyvault/data-plane/readme.typescript.md index 7e44f87cb64f..1afafe393acd 100644 --- a/specification/keyvault/data-plane/readme.typescript.md +++ b/specification/keyvault/data-plane/readme.typescript.md @@ -9,6 +9,4 @@ typescript: package-name: "@azure/keyvault" output-folder: "$(typescript-sdks-folder)/packages/@azure/keyvault" generate-metadata: true - generate-readme-md: false - generate-package-json: false ``` From bae412fb097faf6ba6b6c442fc1625cfe12f3832 Mon Sep 17 00:00:00 2001 From: Kamil Pajdzik <41709775+kpajdzik@users.noreply.github.com> Date: Thu, 8 Nov 2018 13:06:48 -0800 Subject: [PATCH 112/464] Fix RM machinelearning TypeScript readme (#4427) * Fix TypeScript machinelearning readme * Refactor the readme file --- .../resource-manager/readme.typescript.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/specification/machinelearning/resource-manager/readme.typescript.md b/specification/machinelearning/resource-manager/readme.typescript.md index c801055fc7b5..3314518c370d 100644 --- a/specification/machinelearning/resource-manager/readme.typescript.md +++ b/specification/machinelearning/resource-manager/readme.typescript.md @@ -6,7 +6,15 @@ Please also specify `--typescript-sdks-folder= Date: Thu, 8 Nov 2018 13:08:01 -0800 Subject: [PATCH 113/464] update folder to generate arm subscription to subscriptionManagement2 for node.js (#4431) --- specification/subscription/resource-manager/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/subscription/resource-manager/readme.nodejs.md b/specification/subscription/resource-manager/readme.nodejs.md index 226e3a768289..a27909f509ab 100644 --- a/specification/subscription/resource-manager/readme.nodejs.md +++ b/specification/subscription/resource-manager/readme.nodejs.md @@ -7,7 +7,7 @@ Please also specify `--node-sdks-folder= Date: Thu, 8 Nov 2018 13:10:02 -0800 Subject: [PATCH 114/464] remove duplicate entry for Go SDK build (#4411) --- .../authorization/resource-manager/readme.go.md | 2 +- specification/authorization/resource-manager/readme.md | 9 --------- 2 files changed, 1 insertion(+), 10 deletions(-) diff --git a/specification/authorization/resource-manager/readme.go.md b/specification/authorization/resource-manager/readme.go.md index d0461c583f4e..a55a9ddeb1a8 100644 --- a/specification/authorization/resource-manager/readme.go.md +++ b/specification/authorization/resource-manager/readme.go.md @@ -53,4 +53,4 @@ Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2018-09-01-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/authorization/mgmt/2018-09-01-preview/authorization -``` - ## Java These settings apply only when `--java` is specified on the command line. From badd1de79620e5660c7e9a7b0495076152f66356 Mon Sep 17 00:00:00 2001 From: peetlotla <31408193+peetlotla@users.noreply.github.com> Date: Fri, 9 Nov 2018 04:24:03 +0530 Subject: [PATCH 115/464] Swagger closure for Azure Migration Hub Operations (#4330) * Swagger coverage for Azure Migrate Hub operations * Adding Operation_List.json to examples * adding operation result definitions to migrate.json * Update specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json Fixing the JSON schema validation for migrate.json * Update specification/migrateprojects/resource-manager/readme.md Fixing the code generation path for preview swagger. * Update specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json Fixing potential SDK and security errors. * Update specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json Fixing potential new SDK errors. * Proving x-ms-exmaples for response/request payloads for operations. * Fixing schema validation for azure-sdk-for-go. * Fixing schema validation for azure-sdk-for-go. * Added missing patch and delete operations per the feedback. * Swagger fixes for azure-sdk-for-go * Swagger fixes for azure-sdk-for-go * Swagger fixes for azure-sdk-for-go * Fixing schema validation for azure-sdk-for-go. * Adding delete method for migrate errors. --- .../examples/Machines_Get.json | 70 + .../examples/Machines_List.json | 130 + .../examples/MigrateErrors_Delete.json | 14 + .../examples/MigrateErrors_Get.json | 26 + .../examples/MigrateErrors_List.json | 42 + .../examples/MigrateProjects_Delete.json | 13 + .../examples/MigrateProjects_Get.json | 34 + .../examples/MigrateProjects_Patch.json | 48 + .../examples/MigrateProjects_Put.json | 63 + .../MigrateProjects_RefreshSummary.json | 15 + .../MigrateProjects_RegisterTool.json | 15 + .../examples/Operations_List.json | 115 + .../examples/Solutions_Delete.json | 14 + .../examples/Solutions_Get.json | 37 + .../examples/Solutions_GetConfig.json | 16 + .../examples/Solutions_List.json | 64 + .../examples/Solutions_Patch.json | 42 + .../examples/Solutions_Put.json | 70 + .../preview/2018-09-01-preview/migrate.json | 2554 +++++++++++++++++ .../resource-manager/readme.md | 99 + .../resource-manager/readme.nodejs.md | 15 + 21 files changed, 3496 insertions(+) create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json create mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json create mode 100644 specification/migrateprojects/resource-manager/readme.md create mode 100644 specification/migrateprojects/resource-manager/readme.nodejs.md diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json new file mode 100644 index 000000000000..bd40d519c9f2 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json @@ -0,0 +1,70 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "machineName":"vm1" + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm1", + "name":"vm1", + "type":"Microsoft.Migrate/MigrateProjects/machines", + "eTag":"\"a701c63a-0000-0000-0000-59c12fe60000\"", + "properties":{ + "discoveryData":[ + { + "osType":"windows", + "osName":"windows server 2012 R2", + "osVersion":"10.0.01", + "enqueueTime":"2017-09-12T13:11:10.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom1":"mycustomvalue" + } + } + ], + "assessmentData":[ + { + "assessmentId":"myid1", + "targetVMSize":"Standard_D4_v2", + "targetVMLocation":"eastus", + "targetStorageType":{ + "disk1":"Standard" + }, + "enqueueTime":"2017-09-12T13:11:20.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom2":"mycustomvalue" + } + } + ], + "migrationData":[ + { + "migrationPhase":"Migrated", + "migrationTested":true, + "replicationProgressPercentage":100, + "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm1", + "enqueueTime":"2017-09-12T13:11:30.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom3":"mycustomvalue" + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json new file mode 100644 index 000000000000..3593e7b66475 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json @@ -0,0 +1,130 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm1", + "name":"vm1", + "type":"Microsoft.Migrate/MigrateProjects/machines", + "eTag":"\"b701c63a-0000-0000-0000-59c12fe60000\"", + "properties":{ + "discoveryData":[ + { + "osType":"windows", + "osName":"windows server 2012 R2", + "osVersion":"10.0.01", + "enqueueTime":"2017-09-12T13:11:10.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom1":"mycustomvalue" + } + } + ], + "assessmentData":[ + { + "assessmentId":"myid1", + "targetVMSize":"Standard_D4_v2", + "targetVMLocation":"eastus", + "targetStorageType":{ + "disk1":"Standard" + }, + "enqueueTime":"2017-09-12T13:11:20.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom2":"mycustomvalue" + } + } + ], + "migrationData":[ + { + "migrationPhase":"Migrated", + "migrationTested":true, + "replicationProgressPercentage":100, + "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm1", + "enqueueTime":"2017-09-12T13:11:30.8808917Z", + "solutionName":"mysolution", + "machineId":"abcd", + "machineManagerId":"efgh", + "machineName":"vm1", + "extendedInfo":{ + "custom3":"mycustomvalue" + } + } + ] + } + }, + { + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm2", + "name":"vm2", + "type":"Microsoft.Migrate/MigrateProjects/machines", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "properties":{ + "discoveryData":[ + { + "osType":"windows", + "osName":"windows server 2012 R2", + "osVersion":"10.0.01", + "enqueueTime":"2017-09-12T13:11:10.8808917Z", + "solutionName":"mysolution", + "machineId":"xyz", + "machineManagerId":"efgh", + "machineName":"vm2", + "extendedInfo":{ + "custom1":"mycustomvalue" + } + } + ], + "assessmentData":[ + { + "assessmentId":"myid1", + "targetVMSize":"Standard_D4_v2", + "targetVMLocation":"eastus", + "targetStorageType":{ + "disk1":"Standard" + }, + "enqueueTime":"2017-09-12T13:11:20.8808917Z", + "solutionName":"mysolution", + "machineId":"xyz", + "machineManagerId":"efgh", + "machineName":"vm2", + "extendedInfo":{ + "custom2":"mycustomvalue" + } + } + ], + "migrationData":[ + { + "migrationPhase":"Migrated", + "migrationTested":true, + "replicationProgressPercentage":100, + "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm2", + "enqueueTime":"2017-09-12T13:11:30.8808917Z", + "solutionName":"mysolution", + "machineId":"xyz", + "machineManagerId":"efgh", + "machineName":"vm2", + "extendedInfo":{ + "custom3":"mycustomvalue" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json new file mode 100644 index 000000000000..317fcf593ec1 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName": "project01", + "migrateErrorName":"MigrateError01" + }, + "responses":{ + "200":{ + + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json new file mode 100644 index 000000000000..6d1bf17c473b --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json @@ -0,0 +1,26 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName": "project01", + "migrateErrorName":"MigrateError01" + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError01", + "name":"MigrateError01", + "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors", + "properties":{ + "errorCode":1234, + "errorMessage":"Invalid machine name.", + "recommendation":"Please correct the error and retry the operation.", + "possibleCauses":"Invalid input in the data.", + "solution":"mysolution", + "machine":"mymachine1" + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json new file mode 100644 index 000000000000..1b483431ba7d --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json @@ -0,0 +1,42 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName": "project01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "properties":{ + "errorCode":1234, + "errorMessage":"Invalid machine name.", + "recommendation":"Please correct the error and retry the operation.", + "possibleCauses":"Invalid input in the data.", + "solution":"mysolution", + "machine":"mymachine1" + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError01", + "name":"MigrateError01", + "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors" + }, + { + "properties":{ + "errorCode":1288, + "errorMessage":"Invalid foramt.", + "recommendation":"Please correct the error and retry the operation.", + "possibleCauses":"Invalid input in the data.", + "solution":"mysolution", + "machine":"mymachine2" + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError02", + "name":"MigrateError02", + "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json new file mode 100644 index 000000000000..16683169cd8b --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json new file mode 100644 index 000000000000..369327631b40 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json @@ -0,0 +1,34 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + "body":{ + "properties":{ + "registeredTools":[ + "SAS", + "SMS" + ], + "summary":{ + "discoveredCount":23223, + "assessedCount":43, + "replicatingCount":123, + "migratedCount":10023 + } + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"West Us", + "tags":{ + + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json new file mode 100644 index 000000000000..62e5559050cb --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json @@ -0,0 +1,48 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "project":{ + "properties":{ + "registeredTools":[ + "SMS" + ], + "summary":{ + + } + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"Southeast Asia", + "tags":{ + + } + } + }, + "responses":{ + "200":{ + "body":{ + "properties":{ + "registeredTools":[ + "SMS" + ], + "summary":{ + + } + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"Southeast Asia", + "tags":{ + + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json new file mode 100644 index 000000000000..63b7ad8c4208 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json @@ -0,0 +1,63 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "project":{ + "properties":{ + + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"Southeast Asia", + "tags":{ + + } + } + }, + "responses":{ + "201":{ + "body":{ + "properties":{ + "registeredTools":[ + + ], + "summary":{ + + } + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"Southeast Asia", + "tags":{ + + } + } + }, + "200":{ + "body":{ + "properties":{ + "registeredTools":[ + + ], + "summary":{ + + } + }, + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", + "name":"project01", + "type":"Microsoft.Migrate/MigrateProjects", + "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", + "location":"Southeast Asia", + "tags":{ + + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json new file mode 100644 index 000000000000..8c2f70e4f05d --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json @@ -0,0 +1,15 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + "body":{ + "isRefreshed":true + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json new file mode 100644 index 000000000000..8691f5998a84 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json @@ -0,0 +1,15 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + "body":{ + "isRegistered":true + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..cdd19ef51dc8 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json @@ -0,0 +1,115 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"Microsoft.Migrate/MigrateProjects/read", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects", + "operation":"Read", + "description":"Reads a migrate project" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Write", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects", + "operation":"Write", + "description":"Creates or updates a migrate project" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Delete", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects", + "operation":"Delete", + "description":"Deletes a migrate project" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/registerTool/action", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects", + "operation":"Register tool with migrate project", + "description":"Registers a tool with the migrate project" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Solutions/read", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/Solutions", + "operation":"Read", + "description":"Reads a solution" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Solutions/write", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/Solutions", + "operation":"Write", + "description":"Creates or updates a solution" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Solutions/delete", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/Solutions", + "operation":"Delete", + "description":"Deletes a solution" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Solutions/getConfig/action", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/Solutions", + "operation":"Gets solution config", + "description":"Gets configuration of a solution" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/Machines/read", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/Machines", + "operation":"Read", + "description":"Reads a machine" + }, + "origin":"user,system" + }, + { + "name":"Microsoft.Migrate/MigrateProjects/MigrateErrors/read", + "display":{ + "provider":"Microsoft.Migrate", + "resource":"Microsoft.Migrate/MigrateProjects/MigrateErrors", + "operation":"Read", + "description":"Reads a migrate error" + }, + "origin":"user,system" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json new file mode 100644 index 000000000000..5781a29e1a8b --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "solutionName":"smssolution" + }, + "responses":{ + "200":{ + + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json new file mode 100644 index 000000000000..7e7fad9b5af2 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "solutionName":"smssolution" + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", + "name":"smssolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json new file mode 100644 index 000000000000..6354f1ed4428 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json @@ -0,0 +1,16 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "solutionName":"smssolution" + }, + "responses":{ + "200":{ + "body":{ + "publisherSasUri": "Endpoint=sb://xxx.servicebus.windows.net/;SharedAccessSignature=SharedAccessSignature sr=sb%3a%2f%2fxxx.servicebus.windows.net%2fIsvMigrationPayloadEventHub%2fPublishers%2ffad35230-08cd-4d96-bb75-6e41508adb3b-pub-smssolution&sig=Wpf0ORIJI9AFESLDLlJH1ejrUj2W7hy%2fMac%2f7ewZ6j8%3d&se=1541501430&skn=SendPolicy;EntityPath=xyz;Publisher=fad35230-08cd-4d96-bb75-6e41508adb3b-pub-smssolution" + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json new file mode 100644 index 000000000000..f88c5b5d457c --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json @@ -0,0 +1,64 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", + "name":"smssolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + }, + { + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/sassolution", + "name":"sassolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SAS", + "purpose":"assessment", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json new file mode 100644 index 000000000000..48541b6cc141 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json @@ -0,0 +1,42 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "solutionName":"smssolution", + "solutionInput":{ + "properties":{ + "isInactive":false + } + } + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", + "name":"smssolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json new file mode 100644 index 000000000000..4ff10343517f --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json @@ -0,0 +1,70 @@ +{ + "parameters":{ + "resourceGroupName":"myResourceGroup", + "api-version":"2018-09-01-preview", + "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", + "migrateProjectName":"project01", + "solutionName":"smssolution", + "solutionInput":{ + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers" + } + } + }, + "responses":{ + "200":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", + "name":"smssolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + } + }, + "201":{ + "body":{ + "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", + "name":"smssolution", + "type":"Microsoft.Migrate/MigrateProjects/Solutions", + "properties":{ + "tool":"SMS", + "purpose":"migration", + "goal":"servers", + "isInactive":false, + "summary":{ + "discoveredCount":0, + "assessedCount":0, + "replicatingCount":0, + "migratedCount":0 + }, + "details":{ + "groupCount":0, + "assessmentCount":0, + "extendedDetails":{ + + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json new file mode 100644 index 000000000000..b905da16eef3 --- /dev/null +++ b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json @@ -0,0 +1,2554 @@ +{ + "swagger":"2.0", + "info":{ + "version":"2018-09-01-preview", + "title":"Azure Migrate Hub", + "description":"Migrate your workloads to Azure.", + "contact":{ + "name":"Microsoft", + "email":"azuremigrate@microsoft.com" + } + }, + "host":"management.azure.com", + "schemes":[ + "https" + ], + "produces":[ + "application/json" + ], + "consumes":[ + "application/json" + ], + "parameters":{ + "subscriptionId":{ + "name":"subscriptionId", + "description":"Azure Subscription Id in which migrate project was created.", + "type":"string", + "in":"path", + "required":true + }, + "resourceGroupName":{ + "name":"resourceGroupName", + "description":"Name of the Azure Resource Group that migrate project is part of.", + "type":"string", + "in":"path", + "x-ms-parameter-location":"method", + "required":true + }, + "migrateProjectName":{ + "name":"migrateProjectName", + "description":"Name of the Azure Migrate project.", + "type":"string", + "in":"path", + "x-ms-parameter-location":"method", + "required":true + }, + "machineName":{ + "name":"machineName", + "description":"Unique name of a machine in Azure migration hub.", + "type":"string", + "in":"path", + "x-ms-parameter-location":"method", + "required":true + }, + "solutionName":{ + "name":"solutionName", + "description":"Unique name of a migration solution within a migrate project.", + "type":"string", + "in":"path", + "x-ms-parameter-location":"method", + "required":true + }, + "errorName":{ + "name":"errorName", + "description":"Unique name of an error within a migrate project.", + "type":"string", + "in":"path", + "x-ms-parameter-location":"method", + "required":true + }, + "continuationToken":{ + "name":"continuationToken", + "description":"The continuation token.", + "type":"string", + "in":"query", + "required":false, + "x-ms-parameter-location":"method" + }, + "api-version":{ + "name":"api-version", + "description":"Standard request header. Used by service to identify API version used by client.", + "type":"string", + "in":"query", + "required":true, + "enum":[ + "2018-09-01-preview" + ] + }, + "acceptLanguage":{ + "description":"Standard request header. Used by service to respond to client in appropriate language.", + "name":"Accept-Language", + "type":"string", + "in":"header", + "x-ms-parameter-location":"client" + } + }, + "securityDefinitions":{ + "azure_auth":{ + "type":"oauth2", + "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", + "flow":"implicit", + "description":"Azure Active Directory OAuth2 Flow", + "scopes":{ + "user_impersonation":"impersonate your user account" + } + } + }, + "security":[ + { + "azure_auth":[ + "user_impersonation" + ] + } + ], + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/MigrateErrors":{ + "get":{ + "tags":[ + "Errors" + ], + "summary":"Gets a list of errors in the migrate project.", + "operationId":"Errors_EnumerateErrors", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/continuationToken" + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/ErrorCollection" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateErrors_List":{ + "$ref":"./examples/MigrateErrors_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/MigrateErrors/{errorName}":{ + "get":{ + "tags":[ + "Errors" + ], + "summary":"Gets an error in the migrate project.", + "operationId":"Errors_GetError", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/errorName" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/Error" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateErrors_Get":{ + "$ref":"./examples/MigrateErrors_Get.json" + } + } + }, + "delete":{ + "tags":[ + "Errors" + ], + "summary":"Delete the migrate error", + "description":"Delete the migrate error. Deleting non-existent migrate error is a no-operation.", + "operationId":"Errors_DeleteError", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/errorName" + } + ], + "responses":{ + "200":{ + "description":"OK" + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateErrors_Delete":{ + "$ref":"./examples/MigrateErrors_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Machines":{ + "get":{ + "tags":[ + "Machines" + ], + "summary":"Gets a list of machines in the migrate project.", + "operationId":"Machines_EnumerateMachines", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/continuationToken" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/MachineCollection" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Machines_List":{ + "$ref":"./examples/Machines_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Machines/{machineName}":{ + "get":{ + "tags":[ + "Machines" + ], + "summary":"Gets a machine in the migrate project.", + "operationId":"Machines_GetMachine", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/machineName" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/Machine" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Machines_Get":{ + "$ref":"./examples/Machines_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}":{ + "get":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Method to get a migrate project.", + "operationId":"MigrateProjects_GetMigrateProject", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_Get":{ + "$ref":"./examples/MigrateProjects_Get.json" + } + } + }, + "put":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Method to create or update a migrate project.", + "operationId":"MigrateProjects_PutMigrateProject", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "name":"body", + "in":"body", + "description":"Body with migrate project details.", + "required":true, + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + }, + "201":{ + "description":"Created", + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_Put":{ + "$ref":"./examples/MigrateProjects_Put.json" + } + } + }, + "patch":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Update migrate project.", + "description":"Update a migrate project with specified name. Supports partial updates, for example only tags can be provided.", + "operationId":"MigrateProjects_PatchMigrateProject", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "name":"body", + "in":"body", + "description":"Body with migrate project details.", + "required":true, + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/MigrateProject" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_Patch":{ + "$ref":"./examples/MigrateProjects_Patch.json" + } + } + }, + "delete":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Delete the migrate project", + "description":"Delete the migrate project. Deleting non-existent project is a no-operation.", + "operationId":"MigrateProjects_DeleteMigrateProject", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK" + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_Delete":{ + "$ref":"./examples/MigrateProjects_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/registerTool":{ + "post":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Registers a tool with the migrate project.", + "operationId":"MigrateProjects_RegisterTool", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "name":"input", + "in":"body", + "description":"Input containing the name of the tool to be registered.", + "required":true, + "schema":{ + "$ref":"#/definitions/RegisterToolInput" + } + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/RegistrationResult" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_RegisterTool":{ + "$ref":"./examples/MigrateProjects_RegisterTool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/refreshSummary":{ + "post":{ + "tags":[ + "MigrateProjects" + ], + "summary":"Refresh the summary of the migrate project.", + "operationId":"MigrateProjects_RefreshMigrateProjectSummary", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/RefreshSummaryResult" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "MigrateProjects_RefreshSummary":{ + "$ref":"./examples/MigrateProjects_RefreshSummary.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions/{solutionName}":{ + "get":{ + "tags":[ + "Solutions" + ], + "summary":"Gets a solution in the migrate project.", + "operationId":"Solutions_GetSolution", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/solutionName" + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/Solution" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_Get":{ + "$ref":"./examples/Solutions_Get.json" + } + } + }, + "put":{ + "tags":[ + "Solutions" + ], + "summary":"Creates a solution in the migrate project.", + "operationId":"Solutions_PutSolution", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/solutionName" + }, + { + "name":"solutionInput", + "in":"body", + "description":"The input for the solution.", + "required":true, + "schema":{ + "$ref":"#/definitions/Solution" + } + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/Solution" + } + }, + "201":{ + "description":"Created", + "schema":{ + "$ref":"#/definitions/Solution" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_Put":{ + "$ref":"./examples/Solutions_Put.json" + } + } + }, + "patch":{ + "tags":[ + "Solutions" + ], + "summary":"Update solution.", + "description":"Update a solution with specified name. Supports partial updates, for example only tags can be provided.", + "operationId":"Solutions_PatchSolution", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/solutionName" + }, + { + "name":"solutionInput", + "in":"body", + "description":"The input for the solution.", + "required":true, + "schema":{ + "$ref":"#/definitions/Solution" + } + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/Solution" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_Patch":{ + "$ref":"./examples/Solutions_Patch.json" + } + } + }, + "delete":{ + "tags":[ + "Solutions" + ], + "summary":"Delete the solution", + "description":"Delete the solution. Deleting non-existent project is a no-operation.", + "operationId":"Solutions_DeleteSolution", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/solutionName" + }, + { + "$ref":"#/parameters/api-version" + }, + { + "$ref":"#/parameters/acceptLanguage" + } + ], + "responses":{ + "200":{ + "description":"OK" + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_Delete":{ + "$ref":"./examples/Solutions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions":{ + "get":{ + "tags":[ + "Solutions" + ], + "summary":"Gets the list of solutions in the migrate project.", + "operationId":"Solutions_EnumerateSolutions", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/SolutionsCollection" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_List":{ + "$ref":"./examples/Solutions_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions/{solutionName}/getConfig":{ + "post":{ + "tags":[ + "Solutions" + ], + "summary":"Gets the config for the solution in the migrate project.", + "operationId":"Solutions_GetConfig", + "parameters":[ + { + "$ref":"#/parameters/subscriptionId" + }, + { + "$ref":"#/parameters/resourceGroupName" + }, + { + "$ref":"#/parameters/migrateProjectName" + }, + { + "$ref":"#/parameters/solutionName" + }, + { + "$ref":"#/parameters/api-version" + } + ], + "responses":{ + "200":{ + "description":"OK", + "schema":{ + "$ref":"#/definitions/SolutionConfig" + } + } + }, + "deprecated":false, + "x-ms-examples":{ + "Solutions_GetConfig":{ + "$ref":"./examples/Solutions_GetConfig.json" + } + } + } + }, + "/providers/Microsoft.Migrate/operations":{ + "get":{ + "summary":"Get list of operations supported in the API.", + "description":"Get a list of REST API supported by Microsoft.Migrate provider.", + "operationId":"Operations_List", + "responses":{ + "200":{ + "description":"OK. Returns list of operations.", + "schema":{ + "$ref":"#/definitions/OperationResultList" + } + } + }, + "x-ms-pageable":{ + "nextLinkName":null + }, + "x-ms-examples":{ + "Operations_List":{ + "$ref":"./examples/Operations_List.json" + } + } + } + } + }, + "definitions":{ + "Object":{ + "type":"object", + "properties":{ + + } + }, + "ErrorCollection":{ + "description":"Collection of errors.", + "type":"object", + "properties":{ + "value":{ + "description":"Gets or sets the machines.", + "type":"array", + "items":{ + "$ref":"#/definitions/Error" + } + }, + "nextLink":{ + "description":"Gets or sets the value of nextLink.", + "type":"string" + } + } + }, + "Error":{ + "description":"Error REST resource.", + "type":"object", + "properties":{ + "id":{ + "description":"Gets or sets the relative URL to get to this REST resource.", + "type":"string" + }, + "name":{ + "description":"Gets or sets the name of this REST resource.", + "type":"string" + }, + "type":{ + "description":"Gets the type of this REST resource.", + "type":"string", + "readOnly":true + }, + "properties":{ + "$ref":"#/definitions/ErrorProperties", + "description":"Gets or sets the properties of the error." + } + } + }, + "ErrorProperties":{ + "description":"Properties of the error resource.", + "type":"object", + "properties":{ + "errorCode":{ + "description":"Gets or sets the error code.", + "type":"string" + }, + "errorMessage":{ + "description":"Gets or sets the error message.", + "type":"string" + }, + "recommendation":{ + "description":"Gets or sets the recommendation for the error.", + "type":"string" + }, + "possibleCauses":{ + "description":"Gets or sets the possible causes for the error.", + "type":"string" + }, + "solution":{ + "description":"Gets or sets the solution for which the error is being reported.", + "type":"string" + }, + "machine":{ + "description":"Gets or sets the machine for which the error is being reported.", + "type":"string" + } + } + }, + "ODataQueryOptions`1":{ + "type":"object", + "properties":{ + "ifMatch":{ + "$ref":"#/definitions/Object", + "readOnly":true + }, + "ifNoneMatch":{ + "$ref":"#/definitions/Object", + "readOnly":true + }, + "request":{ + "$ref":"#/definitions/Object", + "readOnly":true + }, + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "rawValues":{ + "$ref":"#/definitions/ODataRawQueryOptions", + "readOnly":true + }, + "selectExpand":{ + "$ref":"#/definitions/SelectExpandQueryOption", + "readOnly":true + }, + "apply":{ + "$ref":"#/definitions/ApplyQueryOption", + "readOnly":true + }, + "filter":{ + "$ref":"#/definitions/FilterQueryOption", + "readOnly":true + }, + "orderBy":{ + "$ref":"#/definitions/OrderByQueryOption", + "readOnly":true + }, + "skip":{ + "$ref":"#/definitions/SkipQueryOption", + "readOnly":true + }, + "top":{ + "$ref":"#/definitions/TopQueryOption", + "readOnly":true + }, + "count":{ + "$ref":"#/definitions/CountQueryOption", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/ODataQueryValidator" + } + } + }, + "ODataQueryContext":{ + "type":"object", + "properties":{ + "defaultQuerySettings":{ + "$ref":"#/definitions/DefaultQuerySettings", + "readOnly":true + }, + "model":{ + "$ref":"#/definitions/IEdmModel", + "readOnly":true + }, + "elementType":{ + "$ref":"#/definitions/IEdmType", + "readOnly":true + }, + "navigationSource":{ + "$ref":"#/definitions/IEdmNavigationSource", + "readOnly":true + }, + "elementClrType":{ + "type":"string", + "readOnly":true + }, + "path":{ + "$ref":"#/definitions/ODataPath", + "readOnly":true + }, + "requestContainer":{ + "$ref":"#/definitions/IServiceProvider", + "readOnly":true + } + } + }, + "ODataRawQueryOptions":{ + "type":"object", + "properties":{ + "filter":{ + "type":"string", + "readOnly":true + }, + "apply":{ + "type":"string", + "readOnly":true + }, + "orderBy":{ + "type":"string", + "readOnly":true + }, + "top":{ + "type":"string", + "readOnly":true + }, + "skip":{ + "type":"string", + "readOnly":true + }, + "select":{ + "type":"string", + "readOnly":true + }, + "expand":{ + "type":"string", + "readOnly":true + }, + "count":{ + "type":"string", + "readOnly":true + }, + "format":{ + "type":"string", + "readOnly":true + }, + "skipToken":{ + "type":"string", + "readOnly":true + }, + "deltaToken":{ + "type":"string", + "readOnly":true + } + } + }, + "SelectExpandQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "rawSelect":{ + "type":"string", + "readOnly":true + }, + "rawExpand":{ + "type":"string", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/SelectExpandQueryValidator" + }, + "selectExpandClause":{ + "$ref":"#/definitions/SelectExpandClause", + "readOnly":true + }, + "levelsMaxLiteralExpansionDepth":{ + "format":"int32", + "type":"integer" + } + } + }, + "ApplyQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "resultClrType":{ + "type":"string", + "readOnly":true + }, + "applyClause":{ + "$ref":"#/definitions/ApplyClause", + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + } + } + }, + "FilterQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/FilterQueryValidator" + }, + "filterClause":{ + "$ref":"#/definitions/FilterClause", + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + } + } + }, + "OrderByQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "orderByNodes":{ + "type":"array", + "items":{ + "$ref":"#/definitions/OrderByNode" + }, + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/OrderByQueryValidator" + }, + "orderByClause":{ + "$ref":"#/definitions/OrderByClause", + "readOnly":true + } + } + }, + "SkipQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + }, + "value":{ + "format":"int32", + "type":"integer", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/SkipQueryValidator" + } + } + }, + "TopQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + }, + "value":{ + "format":"int32", + "type":"integer", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/TopQueryValidator" + } + } + }, + "CountQueryOption":{ + "type":"object", + "properties":{ + "context":{ + "$ref":"#/definitions/ODataQueryContext", + "readOnly":true + }, + "rawValue":{ + "type":"string", + "readOnly":true + }, + "value":{ + "type":"boolean", + "readOnly":true + }, + "validator":{ + "$ref":"#/definitions/CountQueryValidator" + } + } + }, + "ODataQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "DefaultQuerySettings":{ + "type":"object", + "properties":{ + "enableExpand":{ + "type":"boolean" + }, + "enableSelect":{ + "type":"boolean" + }, + "enableCount":{ + "type":"boolean" + }, + "enableOrderBy":{ + "type":"boolean" + }, + "enableFilter":{ + "type":"boolean" + }, + "maxTop":{ + "format":"int32", + "type":"integer" + } + } + }, + "IEdmModel":{ + "type":"object", + "properties":{ + "schemaElements":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmSchemaElement" + }, + "readOnly":true + }, + "vocabularyAnnotations":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmVocabularyAnnotation" + }, + "readOnly":true + }, + "referencedModels":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmModel" + }, + "readOnly":true + }, + "declaredNamespaces":{ + "type":"array", + "items":{ + "type":"string" + }, + "readOnly":true + }, + "directValueAnnotationsManager":{ + "$ref":"#/definitions/IEdmDirectValueAnnotationsManager", + "readOnly":true + }, + "entityContainer":{ + "$ref":"#/definitions/IEdmEntityContainer", + "readOnly":true + } + } + }, + "IEdmType":{ + "type":"object", + "properties":{ + "typeKind":{ + "enum":[ + "None", + "Primitive", + "Entity", + "Complex", + "Collection", + "EntityReference", + "Enum", + "TypeDefinition", + "Untyped", + "Path" + ], + "type":"string", + "readOnly":true + } + } + }, + "IEdmNavigationSource":{ + "type":"object", + "properties":{ + "navigationPropertyBindings":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmNavigationPropertyBinding" + }, + "readOnly":true + }, + "path":{ + "$ref":"#/definitions/IEdmPathExpression", + "readOnly":true + }, + "type":{ + "$ref":"#/definitions/IEdmType", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "ODataPath":{ + "type":"object", + "properties":{ + "edmType":{ + "$ref":"#/definitions/IEdmType", + "readOnly":true + }, + "navigationSource":{ + "$ref":"#/definitions/IEdmNavigationSource", + "readOnly":true + }, + "segments":{ + "type":"array", + "items":{ + "$ref":"#/definitions/ODataPathSegment" + }, + "readOnly":true + }, + "pathTemplate":{ + "type":"string", + "readOnly":true + }, + "path":{ + "type":"array", + "items":{ + "$ref":"#/definitions/ODataPathSegment" + }, + "readOnly":true + } + } + }, + "IServiceProvider":{ + "type":"object", + "properties":{ + + } + }, + "SelectExpandQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "SelectExpandClause":{ + "type":"object", + "properties":{ + "selectedItems":{ + "type":"array", + "items":{ + "$ref":"#/definitions/SelectItem" + }, + "readOnly":true + }, + "allSelected":{ + "type":"boolean", + "readOnly":true + } + } + }, + "ApplyClause":{ + "type":"object", + "properties":{ + "transformations":{ + "type":"array", + "items":{ + "$ref":"#/definitions/TransformationNode" + }, + "readOnly":true + } + } + }, + "FilterQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "FilterClause":{ + "type":"object", + "properties":{ + "expression":{ + "$ref":"#/definitions/SingleValueNode", + "readOnly":true + }, + "rangeVariable":{ + "$ref":"#/definitions/RangeVariable", + "readOnly":true + }, + "itemType":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + } + } + }, + "OrderByNode":{ + "type":"object", + "properties":{ + "direction":{ + "enum":[ + "Ascending", + "Descending" + ], + "type":"string", + "readOnly":true + } + } + }, + "OrderByQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "OrderByClause":{ + "type":"object", + "properties":{ + "thenBy":{ + "$ref":"#/definitions/OrderByClause", + "readOnly":true + }, + "expression":{ + "$ref":"#/definitions/SingleValueNode", + "readOnly":true + }, + "direction":{ + "enum":[ + "Ascending", + "Descending" + ], + "type":"string", + "readOnly":true + }, + "rangeVariable":{ + "$ref":"#/definitions/RangeVariable", + "readOnly":true + }, + "itemType":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + } + } + }, + "SkipQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "TopQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "CountQueryValidator":{ + "type":"object", + "properties":{ + + } + }, + "IEdmSchemaElement":{ + "type":"object", + "properties":{ + "schemaElementKind":{ + "enum":[ + "None", + "TypeDefinition", + "Term", + "Action", + "EntityContainer", + "Function" + ], + "type":"string", + "readOnly":true + }, + "namespace":{ + "type":"string", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmVocabularyAnnotation":{ + "type":"object", + "properties":{ + "qualifier":{ + "type":"string", + "readOnly":true + }, + "term":{ + "$ref":"#/definitions/IEdmTerm", + "readOnly":true + }, + "target":{ + "$ref":"#/definitions/IEdmVocabularyAnnotatable", + "readOnly":true + }, + "value":{ + "$ref":"#/definitions/IEdmExpression", + "readOnly":true + } + } + }, + "IEdmDirectValueAnnotationsManager":{ + "type":"object", + "properties":{ + + } + }, + "IEdmEntityContainer":{ + "type":"object", + "properties":{ + "elements":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmEntityContainerElement" + }, + "readOnly":true + }, + "schemaElementKind":{ + "enum":[ + "None", + "TypeDefinition", + "Term", + "Action", + "EntityContainer", + "Function" + ], + "type":"string", + "readOnly":true + }, + "namespace":{ + "type":"string", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmNavigationPropertyBinding":{ + "type":"object", + "properties":{ + "navigationProperty":{ + "$ref":"#/definitions/IEdmNavigationProperty", + "readOnly":true + }, + "target":{ + "$ref":"#/definitions/IEdmNavigationSource", + "readOnly":true + }, + "path":{ + "$ref":"#/definitions/IEdmPathExpression", + "readOnly":true + } + } + }, + "IEdmPathExpression":{ + "type":"object", + "properties":{ + "pathSegments":{ + "type":"array", + "items":{ + "type":"string" + }, + "readOnly":true + }, + "path":{ + "type":"string", + "readOnly":true + }, + "expressionKind":{ + "enum":[ + "None", + "BinaryConstant", + "BooleanConstant", + "DateTimeOffsetConstant", + "DecimalConstant", + "FloatingConstant", + "GuidConstant", + "IntegerConstant", + "StringConstant", + "DurationConstant", + "Null", + "Record", + "Collection", + "Path", + "If", + "Cast", + "IsType", + "FunctionApplication", + "LabeledExpressionReference", + "Labeled", + "PropertyPath", + "NavigationPropertyPath", + "DateConstant", + "TimeOfDayConstant", + "EnumMember", + "AnnotationPath" + ], + "type":"string", + "readOnly":true + } + } + }, + "ODataPathSegment":{ + "type":"object", + "properties":{ + "edmType":{ + "$ref":"#/definitions/IEdmType", + "readOnly":true + }, + "identifier":{ + "type":"string" + } + } + }, + "SelectItem":{ + "type":"object", + "properties":{ + + } + }, + "TransformationNode":{ + "type":"object", + "properties":{ + "kind":{ + "enum":[ + "Aggregate", + "GroupBy", + "Filter", + "Compute" + ], + "type":"string", + "readOnly":true + } + } + }, + "SingleValueNode":{ + "type":"object", + "properties":{ + "typeReference":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "kind":{ + "enum":[ + "None", + "Constant", + "Convert", + "NonResourceRangeVariableReference", + "BinaryOperator", + "UnaryOperator", + "SingleValuePropertyAccess", + "CollectionPropertyAccess", + "SingleValueFunctionCall", + "Any", + "CollectionNavigationNode", + "SingleNavigationNode", + "SingleValueOpenPropertyAccess", + "SingleResourceCast", + "All", + "CollectionResourceCast", + "ResourceRangeVariableReference", + "SingleResourceFunctionCall", + "CollectionFunctionCall", + "CollectionResourceFunctionCall", + "NamedFunctionParameter", + "ParameterAlias", + "EntitySet", + "KeyLookup", + "SearchTerm", + "CollectionOpenPropertyAccess", + "CollectionComplexNode", + "SingleComplexNode", + "Count", + "SingleValueCast", + "CollectionPropertyNode", + "AggregatedCollectionPropertyNode", + "In", + "CollectionConstant" + ], + "type":"string", + "readOnly":true + } + } + }, + "RangeVariable":{ + "type":"object", + "properties":{ + "name":{ + "type":"string", + "readOnly":true + }, + "typeReference":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "kind":{ + "format":"int32", + "type":"integer", + "readOnly":true + } + } + }, + "IEdmTypeReference":{ + "type":"object", + "properties":{ + "isNullable":{ + "type":"boolean", + "readOnly":true + }, + "definition":{ + "$ref":"#/definitions/IEdmType", + "readOnly":true + } + } + }, + "IEdmTerm":{ + "type":"object", + "properties":{ + "type":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "appliesTo":{ + "type":"string", + "readOnly":true + }, + "defaultValue":{ + "type":"string", + "readOnly":true + }, + "schemaElementKind":{ + "enum":[ + "None", + "TypeDefinition", + "Term", + "Action", + "EntityContainer", + "Function" + ], + "type":"string", + "readOnly":true + }, + "namespace":{ + "type":"string", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmVocabularyAnnotatable":{ + "type":"object", + "properties":{ + + } + }, + "IEdmExpression":{ + "type":"object", + "properties":{ + "expressionKind":{ + "enum":[ + "None", + "BinaryConstant", + "BooleanConstant", + "DateTimeOffsetConstant", + "DecimalConstant", + "FloatingConstant", + "GuidConstant", + "IntegerConstant", + "StringConstant", + "DurationConstant", + "Null", + "Record", + "Collection", + "Path", + "If", + "Cast", + "IsType", + "FunctionApplication", + "LabeledExpressionReference", + "Labeled", + "PropertyPath", + "NavigationPropertyPath", + "DateConstant", + "TimeOfDayConstant", + "EnumMember", + "AnnotationPath" + ], + "type":"string", + "readOnly":true + } + } + }, + "IEdmEntityContainerElement":{ + "type":"object", + "properties":{ + "containerElementKind":{ + "enum":[ + "None", + "EntitySet", + "ActionImport", + "FunctionImport", + "Singleton" + ], + "type":"string", + "readOnly":true + }, + "container":{ + "$ref":"#/definitions/IEdmEntityContainer", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmNavigationProperty":{ + "type":"object", + "properties":{ + "partner":{ + "$ref":"#/definitions/IEdmNavigationProperty", + "readOnly":true + }, + "onDelete":{ + "enum":[ + "None", + "Cascade" + ], + "type":"string", + "readOnly":true + }, + "containsTarget":{ + "type":"boolean", + "readOnly":true + }, + "referentialConstraint":{ + "$ref":"#/definitions/IEdmReferentialConstraint", + "readOnly":true + }, + "propertyKind":{ + "enum":[ + "None", + "Structural", + "Navigation" + ], + "type":"string", + "readOnly":true + }, + "type":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "declaringType":{ + "$ref":"#/definitions/IEdmStructuredType", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmReferentialConstraint":{ + "type":"object", + "properties":{ + "propertyPairs":{ + "type":"array", + "items":{ + "$ref":"#/definitions/EdmReferentialConstraintPropertyPair" + }, + "readOnly":true + } + } + }, + "IEdmStructuredType":{ + "type":"object", + "properties":{ + "isAbstract":{ + "type":"boolean", + "readOnly":true + }, + "isOpen":{ + "type":"boolean", + "readOnly":true + }, + "baseType":{ + "$ref":"#/definitions/IEdmStructuredType", + "readOnly":true + }, + "declaredProperties":{ + "type":"array", + "items":{ + "$ref":"#/definitions/IEdmProperty" + }, + "readOnly":true + }, + "typeKind":{ + "enum":[ + "None", + "Primitive", + "Entity", + "Complex", + "Collection", + "EntityReference", + "Enum", + "TypeDefinition", + "Untyped", + "Path" + ], + "type":"string", + "readOnly":true + } + } + }, + "EdmReferentialConstraintPropertyPair":{ + "type":"object", + "properties":{ + "dependentProperty":{ + "$ref":"#/definitions/IEdmStructuralProperty", + "readOnly":true + }, + "principalProperty":{ + "$ref":"#/definitions/IEdmStructuralProperty", + "readOnly":true + } + } + }, + "IEdmProperty":{ + "type":"object", + "properties":{ + "propertyKind":{ + "enum":[ + "None", + "Structural", + "Navigation" + ], + "type":"string", + "readOnly":true + }, + "type":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "declaringType":{ + "$ref":"#/definitions/IEdmStructuredType", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "IEdmStructuralProperty":{ + "type":"object", + "properties":{ + "defaultValueString":{ + "type":"string", + "readOnly":true + }, + "propertyKind":{ + "enum":[ + "None", + "Structural", + "Navigation" + ], + "type":"string", + "readOnly":true + }, + "type":{ + "$ref":"#/definitions/IEdmTypeReference", + "readOnly":true + }, + "declaringType":{ + "$ref":"#/definitions/IEdmStructuredType", + "readOnly":true + }, + "name":{ + "type":"string", + "readOnly":true + } + } + }, + "MachineCollection":{ + "description":"Collection of machines.", + "type":"object", + "properties":{ + "value":{ + "description":"Gets or sets the machines.", + "type":"array", + "items":{ + "$ref":"#/definitions/Machine" + } + }, + "nextLink":{ + "description":"Gets or sets the value of nextLink.", + "type":"string" + } + } + }, + "Machine":{ + "description":"Machine REST resource.", + "type":"object", + "properties":{ + "id":{ + "description":"Gets or sets the relative URL to get to this REST resource.", + "type":"string" + }, + "name":{ + "description":"Gets or sets the name of this REST resource.", + "type":"string" + }, + "type":{ + "description":"Gets the type of this REST resource.", + "type":"string", + "readOnly":true + }, + "properties":{ + "$ref":"#/definitions/MachineProperties", + "description":"Gets or sets the properties of the machine." + } + } + }, + "MachineProperties":{ + "description":"Properties of the machine resource.", + "type":"object", + "properties":{ + "discoveryData":{ + "description":"Gets or sets the discovery details of the machine published by various sources.", + "type":"array", + "items":{ + "$ref":"#/definitions/DiscoveryDetails" + } + }, + "assessmentData":{ + "description":"Gets or sets the assessment details of the machine published by various sources.", + "type":"array", + "items":{ + "$ref":"#/definitions/AssessmentDetails" + } + }, + "migrationData":{ + "description":"Gets or sets the migration details of the machine published by various sources.", + "type":"array", + "items":{ + "$ref":"#/definitions/MigrationDetails" + } + } + } + }, + "DiscoveryDetails":{ + "description":"Discovery properties that can be published by various ISVs.", + "type":"object", + "properties":{ + "osType":{ + "description":"Gets or sets the OS type.", + "type":"string" + }, + "osName":{ + "description":"Gets or sets the OS name.", + "type":"string" + }, + "osVersion":{ + "description":"Gets or sets the OS version.", + "type":"string" + }, + "enqueueTime":{ + "description":"Gets or sets the time the message was enqueued.", + "type":"string" + }, + "solutionName":{ + "description":"Gets or sets the name of the solution that sent the data.", + "type":"string" + }, + "machineId":{ + "description":"Gets or sets the unique identifier of the machine.", + "type":"string" + }, + "machineManagerId":{ + "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", + "type":"string" + }, + "machineName":{ + "description":"Gets or sets the name of the machine.", + "type":"string" + }, + "extendedInfo":{ + "description":"Gets or sets the ISV specific extended information.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + } + } + }, + "AssessmentDetails":{ + "description":"Assessment properties that can be shared by various publishers.", + "type":"object", + "properties":{ + "assessmentId":{ + "description":"Gets or sets the id of the assessment done on the machine.", + "type":"string" + }, + "targetVMSize":{ + "description":"Gets or sets the target VM size.", + "type":"string" + }, + "targetVMLocation":{ + "description":"Gets or sets the target VM location.", + "type":"string" + }, + "targetStorageType":{ + "description":"Gets or sets the target storage type.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + }, + "enqueueTime":{ + "description":"Gets or sets the time the message was enqueued.", + "type":"string" + }, + "solutionName":{ + "description":"Gets or sets the name of the solution that sent the data.", + "type":"string" + }, + "machineId":{ + "description":"Gets or sets the unique identifier of the machine.", + "type":"string" + }, + "machineManagerId":{ + "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", + "type":"string" + }, + "machineName":{ + "description":"Gets or sets the name of the machine.", + "type":"string" + }, + "extendedInfo":{ + "description":"Gets or sets the ISV specific extended information.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + } + } + }, + "MigrationDetails":{ + "description":"Migration properties that can be shared by various publishers.", + "type":"object", + "properties":{ + "migrationPhase":{ + "description":"Gets or sets the phase of migration of the machine.", + "type":"string" + }, + "migrationTested":{ + "description":"Gets or sets a value indicating whether migration was tested on the machine.", + "type":"boolean" + }, + "replicationProgressPercentage":{ + "format":"int32", + "description":"Gets or sets the progress percentage of migration on the machine.", + "type":"integer" + }, + "targetVMArmId":{ + "description":"Gets or sets the ARM id the migrated VM.", + "type":"string" + }, + "enqueueTime":{ + "description":"Gets or sets the time the message was enqueued.", + "type":"string" + }, + "solutionName":{ + "description":"Gets or sets the name of the solution that sent the data.", + "type":"string" + }, + "machineId":{ + "description":"Gets or sets the unique identifier of the machine.", + "type":"string" + }, + "machineManagerId":{ + "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", + "type":"string" + }, + "machineName":{ + "description":"Gets or sets the name of the machine.", + "type":"string" + }, + "extendedInfo":{ + "description":"Gets or sets the ISV specific extended information.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + } + } + }, + "MigrateProject":{ + "description":"Migrate Project REST Resource.", + "type":"object", + "x-ms-azure-resource":true, + "properties":{ + "eTag":{ + "description":"Gets or sets the eTag for concurrency control.", + "type":"string" + }, + "location":{ + "description":"Gets or sets the Azure location in which migrate project is created.", + "type":"string" + }, + "properties":{ + "$ref":"#/definitions/MigrateProjectProperties", + "description":"Gets or sets the nested properties." + }, + "id":{ + "description":"Gets the relative URL to get this migrate project.", + "type":"string", + "readOnly":true + }, + "name":{ + "description":"Gets or sets the name of the migrate project.", + "type":"string", + "readOnly":true + }, + "type":{ + "description":"Handled by resource provider. Type = Microsoft.Migrate/MigrateProject.", + "type":"string", + "readOnly":true + } + } + }, + "MigrateProjectProperties":{ + "description":"Class for migrate project properties.", + "type":"object", + "properties":{ + "registeredTools":{ + "description":"Gets or sets the list of tools registered with the migrate project.", + "type":"array", + "items":{ + "type":"string" + } + }, + "summary":{ + "description":"Gets or sets the goals summary of the migrate Project. \r\n It maps the goal to its summary object.", + "type":"object", + "additionalProperties":{ + "$ref":"#/definitions/GoalSummary" + } + } + } + }, + "GoalSummary":{ + "description":"Class representing the summary object for goal.", + "type":"object", + "properties":{ + "discoveredCount":{ + "format":"int32", + "description":"Gets or sets the count of entities discovered.", + "type":"integer" + }, + "assessedCount":{ + "format":"int32", + "description":"Gets or sets the count of entities assessed.", + "type":"integer" + }, + "replicatingCount":{ + "format":"int32", + "description":"Gets or sets the count of entities being replicated.", + "type":"integer" + }, + "migratedCount":{ + "format":"int32", + "description":"Gets or sets the count of entities migrated.", + "type":"integer" + } + } + }, + "RegisterToolInput":{ + "description":"Class representing the register tool input.", + "type":"object", + "properties":{ + "tool":{ + "description":"Gets or sets the tool to be registered.", + "type":"string" + } + } + }, + "RegistrationResult":{ + "description":"Class representing the registration status of a tool with the migrate project.", + "type":"object", + "properties":{ + "isRegistered":{ + "description":"Gets or sets a value indicating whether the tool is registered or not.", + "type":"boolean" + } + } + }, + "RefreshSummaryResult":{ + "description":"Class representing the refresh summary status of the migrate project.", + "type":"object", + "properties":{ + "isRefreshed":{ + "description":"Gets or sets a value indicating whether the migrate project summary is refreshed.", + "type":"boolean" + } + } + }, + "Solution":{ + "description":"Solution REST Resource.", + "type":"object", + "x-ms-azure-resource":true, + "properties":{ + "id":{ + "description":"Gets or sets the relative URL to get to this REST resource.", + "type":"string", + "readOnly":true + }, + "name":{ + "description":"Gets or sets the name of this REST resource.", + "type":"string", + "readOnly":true + }, + "type":{ + "description":"Gets the type of this REST resource.", + "type":"string", + "readOnly":true + }, + "properties":{ + "$ref":"#/definitions/SolutionProperties", + "description":"Gets or sets the properties of the solution." + } + } + }, + "SolutionProperties":{ + "description":"Class for solution properties.", + "type":"object", + "properties":{ + "tool":{ + "description":"Gets or sets the tool being used in the solution.", + "type":"string" + }, + "purpose":{ + "description":"Gets or sets the purpose of the solution.", + "type":"string" + }, + "goal":{ + "description":"Gets or sets the goal of the solution.", + "type":"string" + }, + "isInactive":{ + "description":"Gets or sets a value indicating whether the solution is active or not.", + "type":"boolean" + }, + "summary":{ + "$ref":"#/definitions/SolutionSummary", + "description":"Gets or sets the summary of the solution." + }, + "details":{ + "$ref":"#/definitions/SolutionDetails", + "description":"Gets or sets the details of the solution." + } + } + }, + "SolutionSummary":{ + "description":"Class representing the summary object for solution.", + "type":"object", + "properties":{ + "discoveredCount":{ + "format":"int32", + "description":"Gets or sets the count of entities discovered.", + "type":"integer" + }, + "assessedCount":{ + "format":"int32", + "description":"Gets or sets the count of entities assessed.", + "type":"integer" + }, + "replicatingCount":{ + "format":"int32", + "description":"Gets or sets the count of entities being replicated.", + "type":"integer" + }, + "migratedCount":{ + "format":"int32", + "description":"Gets or sets the count of entities migrated.", + "type":"integer" + } + } + }, + "SolutionDetails":{ + "description":"Class representing the details of the solution.", + "type":"object", + "properties":{ + "groupCount":{ + "format":"int32", + "description":"Gets or sets the count of groups reported by the solution.", + "type":"integer" + }, + "assessmentCount":{ + "format":"int32", + "description":"Gets or sets the count of assessments reported by the solution.", + "type":"integer" + }, + "extendedDetails":{ + "description":"Gets or sets the extended details reported by the solution.", + "type":"object", + "additionalProperties":{ + "type":"string" + } + } + } + }, + "SolutionsCollection":{ + "description":"Collection of solutions.", + "type":"object", + "properties":{ + "value":{ + "description":"Gets or sets the list of solutions.", + "type":"array", + "items":{ + "$ref":"#/definitions/Solution" + } + }, + "nextLink":{ + "description":"Gets or sets the value of next link.", + "type":"string" + } + } + }, + "SolutionConfig":{ + "description":"Class representing the config for the solution in the migrate project.", + "type":"object", + "properties":{ + "publisherSasUri":{ + "description":"Gets or sets the publisher sas uri for the solution.", + "type":"string" + } + } + }, + "OperationResultList":{ + "type":"object", + "description":"List of API operations.", + "properties":{ + "value":{ + "type":"array", + "description":"List of operations.", + "items":{ + "$ref":"#/definitions/Operation" + } + } + } + }, + "Operation":{ + "type":"object", + "description":"A REST API operation supported by the provider.", + "properties":{ + "name":{ + "type":"string", + "description":"Name of the operation.", + "readOnly":true + }, + "display":{ + "description":"Displayable properties of the operation.", + "$ref":"#/definitions/OperationDisplay" + }, + "origin":{ + "type":"string", + "description":"Origin of the operation.", + "readOnly":true + } + } + }, + "OperationDisplay":{ + "type":"object", + "description":"Displayable properties of the operation.", + "readOnly":true, + "properties":{ + "provider":{ + "type":"string", + "description":"Provider of the operation.", + "readOnly":true + }, + "resource":{ + "type":"string", + "description":"Resource operated on by the operation.", + "readOnly":true + }, + "operation":{ + "type":"string", + "description":"Operation Type.", + "readOnly":true + }, + "description":{ + "type":"string", + "description":"Description of the operation.", + "readOnly":true + } + } + } + } +} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/readme.md b/specification/migrateprojects/resource-manager/readme.md new file mode 100644 index 000000000000..238f17ac9b91 --- /dev/null +++ b/specification/migrateprojects/resource-manager/readme.md @@ -0,0 +1,99 @@ +# Azure Migrate + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Migrate. + +--- + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-09 +``` + +### Tag: package-2018-09 and java + +These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.azuremigrate.v2018_09_01 + output-folder: $(azure-libraries-for-java-folder)/azuremigrate/resource-manager/v2018_09_01 +regenerate-manager: true +generate-interface: true +``` + + +## Getting Started +To build the SDK for Migrate, 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 API. + +``` yaml +openapi-type: arm +tag: package-2018-09 +``` + + +### Tag: package-2018-09 + +These settings apply only when `--tag=package-2018-09` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09' +input-file: +- Microsoft.Migrate/preview/2018-09-01-preview/migrate.json +``` + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: migrate +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09 +``` + +### Tag: package-2018-09 and go + +These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-09' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-preview/$(namespace) +``` diff --git a/specification/migrateprojects/resource-manager/readme.nodejs.md b/specification/migrateprojects/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..659dab26dfe8 --- /dev/null +++ b/specification/migrateprojects/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-migrateprojects + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/migrateprojectsManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` From 916ff2e6e2e722c8b6ca8c77149f6b2ab358332a Mon Sep 17 00:00:00 2001 From: Ke Li <34074108+lkems@users.noreply.github.com> Date: Thu, 8 Nov 2018 17:06:46 -0800 Subject: [PATCH 116/464] WebApps: Snapshots API for DR stamps (#4291) * Include DRSecondary endpoint for GetPublishingProfileXml * Snapshots API for DR stamps --- .../stable/2018-02-01/WebApps.json | 105 ++++++++++++++++++ 1 file changed, 105 insertions(+) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index 4830bbdf2bfa..5b3569472564 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -14923,6 +14923,58 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", + "description": "Returns all Snapshots to the user from DRSecondary endpoint.", + "operationId": "WebApps_ListSnapshotsFromDRSecondarySlot", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "name": "slot", + "in": "path", + "description": "Website Slot.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": { "get": { "tags": [ @@ -16573,6 +16625,51 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns all Snapshots to the user from DRSecondary endpoint.", + "description": "Returns all Snapshots to the user from DRSecondary endpoint.", + "operationId": "WebApps_ListSnapshotsFromDRSecondary", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Website Name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": { "get": { "tags": [ @@ -18578,6 +18675,10 @@ "snapshotTime": { "description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.", "type": "string" + }, + "useDRSecondary": { + "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", + "type": "boolean" } }, "x-ms-client-flatten": true @@ -21068,6 +21169,10 @@ "ignoreConflictingHostNames": { "description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled.", "type": "boolean" + }, + "useDRSecondary": { + "description": "If true, the snapshot is retrieved from DRSecondary endpoint.", + "type": "boolean" } }, "x-ms-client-flatten": true From dec75495352902ebb6393d42c50465b6195f239d Mon Sep 17 00:00:00 2001 From: yaakoviyun Date: Fri, 9 Nov 2018 16:33:10 +0200 Subject: [PATCH 117/464] Adding ManagedInstanceVulnerabilityAssessments and ServerVulnerabilityAssessments (#4416) --- specification/sql/resource-manager/readme.md | 26 ++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 1a1f097b615e..c45c66bac682 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -108,6 +108,8 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json # Needed when there is more than one input file @@ -187,6 +189,8 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json # Needed when there is more than one input file override-info: @@ -259,6 +263,8 @@ input-file: - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceTdeCertificates.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json - Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +- Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json +- Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json # Needed when there is more than one input file override-info: @@ -402,6 +408,26 @@ override-info: The following packages are each composed of all apis from only one api-version. +### Tag: package-pure-2018-06-preview + +These settings apply only when `--tag=package-pure-2018-06-preview` is specified on the command line. + +This section contains all input swagger files for version 2018-06-01-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2018-06-01-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2018-06-preview' +input-file: + - ./Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceVulnerabilityAssessments.json + - ./Microsoft.Sql/preview/2018-06-01-preview/ServerVulnerabilityAssessments.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient + ``` + ### Tag: package-pure-2017-10-preview These settings apply only when `--tag=package-pure-2017-10-preview` is specified on the command line. From 77cf607c0e92af7a2f6937aa5f30bc08673cb902 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Fri, 9 Nov 2018 10:57:44 -0800 Subject: [PATCH 118/464] Split Python conf in it's own file (#4438) --- .../data-plane/Face/readme.md | 27 ------------------- .../data-plane/Face/readme.python.md | 26 ++++++++++++++++++ 2 files changed, 26 insertions(+), 27 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Face/readme.python.md diff --git a/specification/cognitiveservices/data-plane/Face/readme.md b/specification/cognitiveservices/data-plane/Face/readme.md index e03a66ac3723..0cd69747f502 100644 --- a/specification/cognitiveservices/data-plane/Face/readme.md +++ b/specification/cognitiveservices/data-plane/Face/readme.md @@ -51,33 +51,6 @@ csharp: clear-output-folder: true ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - license-header: MICROSOFT_MIT_NO_VERSION - add-credentials: true - payload-flattening-threshold: 2 - namespace: azure.cognitiveservices.vision.face - package-name: azure-cognitiveservices-vision-face - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-vision-face/azure/cognitiveservices/vision/face -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-vision-face -``` - ## Go See configuration in [readme.go.md](./readme.go.md) diff --git a/specification/cognitiveservices/data-plane/Face/readme.python.md b/specification/cognitiveservices/data-plane/Face/readme.python.md new file mode 100644 index 000000000000..9d1cae3caff9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Face/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.vision.face + package-name: azure-cognitiveservices-vision-face + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-vision-face/azure/cognitiveservices/vision/face +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-vision-face +``` From 337376061dedcb5d6dfe7d2ddad59061c45f5710 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Fri, 9 Nov 2018 10:58:14 -0800 Subject: [PATCH 119/464] Py conf in its own file (#4439) --- .../data-plane/CustomWebSearch/readme.md | 27 ------------------- .../CustomWebSearch/readme.python.md | 26 ++++++++++++++++++ 2 files changed, 26 insertions(+), 27 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/CustomWebSearch/readme.python.md diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md index fc25d5fb6885..3fd2ec58b5ed 100644 --- a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.md @@ -49,33 +49,6 @@ csharp: sync-methods: none ``` -## 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: - license-header: MICROSOFT_MIT_NO_VERSION - add-credentials: true - payload-flattening-threshold: 2 - namespace: azure.cognitiveservices.search.customsearch - package-name: azure-cognitiveservices-search-customsearch - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch/azure/cognitiveservices/search/customsearch -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch -``` - ## Suppressions Suppressing errors due to API design: ``` yaml diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/readme.python.md b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.python.md new file mode 100644 index 000000000000..10ebb90edd19 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.search.customsearch + package-name: azure-cognitiveservices-search-customsearch + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch/azure/cognitiveservices/search/customsearch +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-search-customsearch +``` From 3f568b4898533a2699c90a7f451448dfebae140a Mon Sep 17 00:00:00 2001 From: sumitabarahmand <43867857+sumitabarahmand@users.noreply.github.com> Date: Fri, 9 Nov 2018 15:35:20 -0800 Subject: [PATCH 120/464] Add spec for alert repair/remediate (#4084) * Add spec for alert repair/remediate * Update remediate route to repair * Add alert remediation properties to the alert model * fix oav validation errors * update remediationActionType items * remove remediationActionType as that is not exposed on an alert * change hasRemediationAction type to boolean --- .../preview/2016-05-01/Alert.json | 70 ++++++++++++++----- .../2016-05-01/examples/Alert/Repair.json | 13 ++++ 2 files changed, 64 insertions(+), 19 deletions(-) create mode 100644 specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Repair.json diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json index 4833a35d70a7..87a98d6aabcf 100644 --- a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/Alert.json @@ -9,6 +9,12 @@ "schemes": [ "https" ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts": { "get": { @@ -50,13 +56,7 @@ "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/Alert", - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] + "x-ms-odata": "#/definitions/Alert" } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts/{alertName}": { @@ -95,13 +95,7 @@ "$ref": "#/definitions/Alert" } } - }, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] + } }, "put": { "x-ms-examples": { @@ -144,13 +138,47 @@ "$ref": "#/definitions/Alert" } } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.InfrastructureInsights.Admin/regionHealths/{location}/alerts/{alertName}/repair": { + "post": { + "x-ms-examples": { + "Repairs an alert.": { + "$ref": "./examples/Alert/Repair.json" + } }, - "produces": [ - "application/json" + "tags": [ + "Alerts" + ], + "x-ms-long-running-operation": true, + "description": "Repairs an alert.", + "operationId": "Alerts_Repair", + "parameters": [ + { + "$ref": "InfrastructureInsights.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ResourceGroupParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/AlertNameParameter" + }, + { + "$ref": "InfrastructureInsights.json#/parameters/ApiVersionParameter" + } ], - "consumes": [ - "application/json" - ] + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "ACCEPTED" + } + } } } }, @@ -250,6 +278,10 @@ "closedByUserAlias": { "description": "User alias who closed the alert.", "type": "string" + }, + "hasValidRemediationAction": { + "description": "Indicates if the alert can be remediated.", + "type": "boolean" } } }, diff --git a/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Repair.json b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Repair.json new file mode 100644 index 000000000000..2054303645dd --- /dev/null +++ b/specification/azsadmin/resource-manager/infrastructureinsights/Microsoft.InfrastructureInsights.Admin/preview/2016-05-01/examples/Alert/Repair.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "System.local", + "location": "local", + "alertName": "ca55be03-9be9-4deb-8467-e890ab1d116b", + "api-version": "2016-05-01" + }, + "responses": { + "200": {}, + "202": {} + } +} From 7577df97b09389657606a5d1bc814ca7d44b1af9 Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Mon, 12 Nov 2018 08:00:57 -0800 Subject: [PATCH 121/464] Remove readonly attribute from identities collection in users (#4442) --- .../preview/2018-06-01-preview/apimusers.json | 1 - .../Microsoft.ApiManagement/stable/2018-01-01/apimusers.json | 1 - 2 files changed, 2 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json index 2fbd739e4896..1207811dfd69 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json @@ -822,7 +822,6 @@ "description": "Optional note about a user set by the administrator." }, "identities": { - "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/UserIdentityContract" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json index e52d1a35cfde..5da0e9deb3c8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json @@ -822,7 +822,6 @@ "description": "Optional note about a user set by the administrator." }, "identities": { - "readOnly": true, "type": "array", "items": { "$ref": "#/definitions/UserIdentityContract" From 2d83450cbe91cc06d775ce384d8ab9c91589c894 Mon Sep 17 00:00:00 2001 From: EvgenyAgafonchikov Date: Mon, 12 Nov 2018 19:31:41 +0300 Subject: [PATCH 122/464] Make NIC VM readOnly (#4444) --- .../Microsoft.Network/stable/2018-08-01/networkInterface.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json index e8d0a9b59c14..3864a66649fe 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkInterface.json @@ -930,7 +930,8 @@ "properties": { "virtualMachine": { "$ref": "./network.json#/definitions/SubResource", - "description": "The reference of a virtual machine." + "description": "The reference of a virtual machine.", + "readOnly": true }, "networkSecurityGroup": { "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", From 2389da39084fb8880cde21111ff79bc72e74f830 Mon Sep 17 00:00:00 2001 From: snhaphil <41613474+snhaphil@users.noreply.github.com> Date: Mon, 12 Nov 2018 19:55:02 +0200 Subject: [PATCH 123/464] Add Allowed Connections REST API (#4106) * Added allowed connections to security.json * Added allowed connections to security.json * added examples * modified the examples resources name * Modified the asclocation in the examples file * reformatted and added newline at the EOF * modified examples description in security.json * Fixing additionalProperties configuration to match type verification * pr fixes * modified the description to be aligned with ASC doc. * inserted topologies addition to security.json --- ...nnectionsSubscriptionLocation_example.json | 65 +++++ ...llowedConnectionsSubscription_example.json | 64 +++++ .../GetAllowedConnections_example.json | 63 +++++ .../preview/2015-06-01-preview/security.json | 255 ++++++++++++++++++ 4 files changed, 447 insertions(+) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json new file mode 100644 index 000000000000..6fdbab08e2c8 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "ascLocation": "centralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json new file mode 100644 index 000000000000..6ed76ac9eac4 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json new file mode 100644 index 000000000000..b99b6d83d559 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/examples/AllowedConnections/GetAllowedConnections_example.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2015-06-01-preview", + "subscriptionId": "3eeab341-f466-499c-a8be-85427e154bad", + "resourceGroupName": "myResourceGroup", + "ascLocation": "centralus", + "connectionType": "Internal" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.Security/locations/allowedConnections", + "properties": { + "calculatedDateTime": "2018-08-06T14:55:32.3518545Z", + "connectableResources": [ + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2", + "inboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ], + "outboundConnectedResources": [ + { + "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1", + "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]", + "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]" + } + ] + }, + { + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3", + "inboundConnectedResources": [], + "outboundConnectedResources": [] + } + ] + }, + "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal", + "name": "Internal", + "location": "centralus" + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json index a419b10aa99d..bd0b9f27ef39 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json @@ -1554,6 +1554,132 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/allowedConnections": { + "get": { + "x-ms-examples": { + "Get allowed connections on a subscription": { + "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscription_example.json" + } + }, + "tags": [ + "AllowedConnections" + ], + "description": "Gets the list of all possible traffic between resources for the subscription", + "operationId": "AllowedConnections_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections": { + "get": { + "x-ms-examples": { + "Get allowed connections on a subscription from security data location": { + "$ref": "./examples/AllowedConnections/GetAllowedConnectionsSubscriptionLocation_example.json" + } + }, + "tags": [ + "AllowedConnections" + ], + "description": "Gets the list of all possible traffic between resources for the subscription and location.", + "operationId": "AllowedConnections_ListByHomeRegion", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections/{connectionType}": { + "get": { + "x-ms-examples": { + "Get allowed connections": { + "$ref": "./examples/AllowedConnections/GetAllowedConnections_example.json" + } + }, + "tags": [ + "AllowedConnections" + ], + "description": "Gets the list of all possible traffic between resources for the subscription and location, based on connection type.", + "operationId": "AllowedConnections_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/ConnectionType" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AllowedConnectionsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { @@ -2726,6 +2852,111 @@ "$ref": "#/definitions/ExternalSecuritySolutionProperties" } ] + }, + "AllowedConnectionsList": { + "type": "object", + "description": "List of all possible traffic between Azure resources", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AllowedConnectionsResource" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "AllowedConnectionsResource": { + "type": "object", + "description": "The resource whose properties describes the allowed traffic between Azure resources", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "readOnly": true, + "$ref": "#/definitions/AllowedConnectionsResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "$ref": "#/definitions/Location" + } + ] + }, + "AllowedConnectionsResourceProperties": { + "type": "object", + "description": "Describes the allowed traffic between Azure resources", + "properties": { + "calculatedDateTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time on which the allowed connections resource was calculated" + }, + "connectableResources": { + "type": "array", + "readOnly": true, + "description": "List of connectable resources", + "items": { + "$ref": "#/definitions/ConnectableResource" + } + } + } + }, + "ConnectableResource": { + "type": "object", + "description": "Describes the allowed inbound and outbound traffic of an Azure resource", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The Azure resource id" + }, + "inboundConnectedResources": { + "type": "array", + "readOnly": true, + "description": "The list of Azure resources that the resource has inbound allowed connection from", + "items": { + "$ref": "#/definitions/ConnectedResource" + } + }, + "outboundConnectedResources": { + "type": "array", + "readOnly": true, + "description": "The list of Azure resources that the resource has outbound allowed connection to", + "items": { + "$ref": "#/definitions/ConnectedResource" + } + } + } + }, + "ConnectedResource": { + "type": "object", + "description": "Describes properties of a connected resource", + "properties": { + "connectedResourceId": { + "type": "string", + "readOnly": true, + "description": "The Azure resource id of the connected resource" + }, + "tcpPorts": { + "type": "string", + "readOnly": true, + "description": "The allowed tcp ports" + }, + "udpPorts": { + "type": "string", + "readOnly": true, + "description": "The allowed udp ports" + } + } } }, "parameters": { @@ -2917,6 +3148,30 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "ConnectionType": { + "name": "connectionType", + "type": "string", + "in": "path", + "description": "The type of allowed connections (Internal, External)", + "required": true, + "enum": [ + "Internal", + "External" + ], + "x-ms-enum": { + "name": "connectionType", + "modelAsString": true, + "values": [ + { + "value": "Internal" + }, + { + "value": "External" + } + ] + }, + "x-ms-parameter-location": "method" } } } From eaf464ee6a5803e1d1b0e16ede4e5af15efc0b25 Mon Sep 17 00:00:00 2001 From: Elia Grady Date: Mon, 12 Nov 2018 20:34:55 +0200 Subject: [PATCH 124/464] Remove security contact phone field mandatory fields (#4417) * Remove security contact phone field mandatory fields * Update security contact examples * Update security contact examples - refactored * Update security contact examples - refactored - second iteration --- ...> CreateSecurityContact_full_example.json} | 10 +++--- .../CreateSecurityContact_min_example.json | 31 +++++++++++++++++++ .../DeleteSecurityContact_example.json | 2 +- ...n => GetSecurityContact_full_example.json} | 6 ++-- .../GetSecurityContact_min_example.json | 21 +++++++++++++ ...ityContactsSubscription_full_example.json} | 4 +-- ...urityContactsSubscription_min_example.json | 22 +++++++++++++ ...> UpdateSecurityContact_full_example.json} | 8 ++--- .../UpdateSecurityContact_min_example.json | 29 +++++++++++++++++ .../preview/2017-08-01-preview/security.json | 29 +++++++++++------ 10 files changed, 138 insertions(+), 24 deletions(-) rename specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/{CreateSecurityContact_example.json => CreateSecurityContact_full_example.json} (77%) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json rename specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/{GetSecurityContact_example.json => GetSecurityContact_full_example.json} (77%) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json rename specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/{GetSecurityContactsSubscription_example.json => GetSecurityContactsSubscription_full_example.json} (83%) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json rename specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/{UpdateSecurityContact_example.json => UpdateSecurityContact_full_example.json} (80%) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json similarity index 77% rename from specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json rename to specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json index 9deda54049f1..d4364254de7e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_full_example.json @@ -2,10 +2,10 @@ "parameters": { "api-version": "2017-08-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john", + "securityContactName": "default1", "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "email": "john@contoso.com", @@ -18,8 +18,8 @@ "responses": { "200": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "email": "john@contoso.com", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json new file mode 100644 index 000000000000..b5930c33de0f --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/CreateSecurityContact_min_example.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json index 948df8317165..3533a29ff0fd 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/DeleteSecurityContact_example.json @@ -2,7 +2,7 @@ "parameters": { "api-version": "2017-08-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john" + "securityContactName": "default1" }, "responses": { "204": { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json similarity index 77% rename from specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json rename to specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json index fcc0762de7c6..1b9c0f270c57 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_full_example.json @@ -2,13 +2,13 @@ "parameters": { "api-version": "2017-08-01-preview", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "securityContactName": "john" + "securityContactName": "default1" }, "responses": { "200": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "email": "john@contoso.com", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json new file mode 100644 index 000000000000..28acce3b9eda --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContact_min_example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json similarity index 83% rename from specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json rename to specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json index 514a72a545d1..ee3783208a2f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json @@ -7,8 +7,8 @@ "200": { "body": { "value": [{ - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "email": "john@contoso.com", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json new file mode 100644 index 000000000000..60e5de6ae2f6 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "On" + } + }] + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_example.json similarity index 80% rename from specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json rename to specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_example.json index 1de75b59b395..41505d376402 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_full_example.json @@ -4,8 +4,8 @@ "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "securityContactName": "john", "securityContact": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "phone": "(214)275-4038", @@ -16,8 +16,8 @@ "responses": { "200": { "body": { - "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/john", - "name": "john", + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default1", + "name": "default1", "type": "Microsoft.Security/securityContacts", "properties": { "email": "john@contoso.com", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json new file mode 100644 index 000000000000..ab4168075c92 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/SecurityContacts/UpdateSecurityContact_min_example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2017-08-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "securityContactName": "default2", + "securityContact": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "alertNotifications": "On" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/securityContacts/default2", + "name": "default2", + "type": "Microsoft.Security/securityContacts", + "properties": { + "email": "chen@contoso.com", + "alertNotifications": "On", + "alertsToAdmins": "Off" + } + } + } + } +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json index eb58fbb0d8a1..b01420e8dc9c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json @@ -235,8 +235,11 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts": { "get": { "x-ms-examples": { - "Update security contact data": { - "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_example.json" + "Update security contact data minimal": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_min_example.json" + }, + "Update security contact data full": { + "$ref": "./examples/SecurityContacts/GetSecurityContactsSubscription_full_example.json" } }, "tags": ["Security Contacts"], @@ -269,8 +272,11 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securityContacts/{securityContactName}": { "get": { "x-ms-examples": { - "Get security contact data": { - "$ref": "./examples/SecurityContacts/GetSecurityContact_example.json" + "Get security contact data minimal": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_min_example.json" + }, + "Get security contact data full": { + "$ref": "./examples/SecurityContacts/GetSecurityContact_full_example.json" } }, "tags": ["Security Contacts"], @@ -300,8 +306,11 @@ }, "put": { "x-ms-examples": { - "Create security contact data": { - "$ref": "./examples/SecurityContacts/CreateSecurityContact_example.json" + "Create security contact data minimal": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_min_example.json" + }, + "Create security contact data full": { + "$ref": "./examples/SecurityContacts/CreateSecurityContact_full_example.json" } }, "tags": ["Security Contacts"], @@ -361,8 +370,11 @@ }, "patch": { "x-ms-examples": { - "Update security contact data": { - "$ref": "./examples/SecurityContacts/UpdateSecurityContact_example.json" + "Update security contact data minimal": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_min_example.json" + }, + "Update security contact data full": { + "$ref": "./examples/SecurityContacts/UpdateSecurityContact_full_example.json" } }, "tags": ["Security Contacts"], @@ -1179,7 +1191,6 @@ }, "required": [ "email", - "phone", "alertNotifications", "alertsToAdmins" ] From 6780e8ad5b09fcc3dcbe9eec58671dc89295d3be Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Mon, 12 Nov 2018 10:46:55 -0800 Subject: [PATCH 125/464] add guidance for example names (#4432) --- documentation/x-ms-examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/x-ms-examples.md b/documentation/x-ms-examples.md index 1ac2b4a2fef1..9f6b88ff4cf1 100644 --- a/documentation/x-ms-examples.md +++ b/documentation/x-ms-examples.md @@ -82,7 +82,7 @@ _This will keep the spec cleaner and easy to manage._ - The JSON schema for the content to be provided in the example file can be found [here](https://raw.githubusercontent.com/Azure/autorest/master/schema/example-schema.json). ```json5 "x-ms-examples": { - "example-name": { //Name of the example/scenario. + "example-name": { //Name of the example/scenario. It is free-form text and should succinctly describe the scenario. "parameters": { //Provide examples for all the path, query, header, body, formData parameters as applicable. ... }, From 2ea3e9ebf74c5bade9146643bfbef092dfe80118 Mon Sep 17 00:00:00 2001 From: Tony Xu Date: Mon, 12 Nov 2018 12:29:46 -0800 Subject: [PATCH 126/464] Azure Container Instance: Add start container group API (#4423) * Update swagger with DNSConfig and GPU * Azure Container Instance: Add start container group API --- .../stable/2018-10-01/containerInstance.json | 32 +++++++++++++++++++ .../examples/ContainerGroupsStart.json | 11 +++++++ 2 files changed, 43 insertions(+) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsStart.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json index 4c680ff8b8a7..c1fcd7ede62c 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json @@ -322,6 +322,38 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true + } + }, "/providers/Microsoft.ContainerInstance/operations": { "get": { "tags": [ diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..ceaa1376b456 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/ContainerGroupsStart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } + } \ No newline at end of file From a079367c50c15f74a2b801441e20b14bbc912bd8 Mon Sep 17 00:00:00 2001 From: Naveed Aziz Date: Tue, 13 Nov 2018 17:50:17 +0100 Subject: [PATCH 127/464] Add GeoRegion property to DeletedSite model (#4448) --- .../Microsoft.Web/stable/2018-02-01/CommonDefinitions.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json index 1502bbb8f0c9..f69696c75dae 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json @@ -909,6 +909,11 @@ "description": "Kind of site that was deleted", "type": "string", "readOnly": true + }, + "geoRegionName": { + "description": "Geo Region of the deleted site", + "type": "string", + "readOnly": true } }, "x-ms-client-flatten": true From dc782b320161cb372dc3322aca860e452b76e9c5 Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Tue, 13 Nov 2018 10:53:26 -0800 Subject: [PATCH 128/464] [CognitiveServices] enable Bing Search/CustomSearch products to specify Endpoint (#4401) --- .../AutoSuggest/stable/v1.0/AutoSuggest.json | 11 ++++++- .../data-plane/Common/Parameters.json | 10 +++++++ .../stable/v1.0/CustomImageSearch.json | 9 ++++++ .../stable/v1.0/CustomSearch.json | 9 ++++++ .../stable/v1.0/EntitySearch.json | 17 ++++++++--- .../ImageSearch/stable/v1.0/ImageSearch.json | 11 ++++++- .../NewsSearch/stable/v1.0/NewsSearch.json | 29 ++++++++++++------- .../SpellCheck/stable/v1.0/SpellCheck.json | 9 ++++++ .../VideoSearch/stable/v1.0/VideoSearch.json | 11 ++++++- .../preview/v1.0/VisualSearch.json | 11 ++++++- .../WebSearch/stable/v1.0/WebSearch.json | 17 ++++++++--- 11 files changed, 122 insertions(+), 22 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json index 4bb38df98c1d..a07198e64b18 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "AutoSuggest Search API", + "title": "AutoSuggest Client", "description": "The AutoSuggest Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/Common/Parameters.json b/specification/cognitiveservices/data-plane/Common/Parameters.json index 8831df933942..7fc6dc8d2ec4 100644 --- a/specification/cognitiveservices/data-plane/Common/Parameters.json +++ b/specification/cognitiveservices/data-plane/Common/Parameters.json @@ -7,6 +7,16 @@ }, "paths": {}, "parameters": { + "GlobalEndpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: \"https://westus.api.cognitive.microsoft.com\", \"https://api.cognitive.microsoft.com\").", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "default": "https://api.cognitive.microsoft.com" + }, "ImageStream": { "name": "Image", "in": "body", diff --git a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json index 3c36dc32d746..4dcf77236a81 100644 --- a/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json +++ b/specification/cognitiveservices/data-plane/CustomImageSearch/stable/v1.0/CustomImageSearch.json @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bingcustomsearch/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json index b6b00e58cb35..0188ef254c99 100644 --- a/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json +++ b/specification/cognitiveservices/data-plane/CustomWebSearch/stable/v1.0/CustomSearch.json @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "schemes": [ "https" diff --git a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json index 25a08fad632b..4aed0801caa5 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json +++ b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Entity Search API", + "title": "Entity Search Client", "description": "The Entity Search API lets you send a search query to Bing and get back search results that include entities and places. Place results include restaurants, hotel, or other local businesses. For places, the query can specify the name of the local business or it can ask for a list (for example, restaurants near me). Entity results include persons, places, or things. Place in this context is tourist attractions, states, countries, etc.", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "schemes": [ "https" @@ -210,9 +219,9 @@ } }, "x-ms-examples": { - "Successful query": { - "$ref": "./examples//SuccessfulQueryRequest.json" - } + "Successful query": { + "$ref": "./examples//SuccessfulQueryRequest.json" + } } } } diff --git a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json index 2a6773c47853..274f0940dc51 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json +++ b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Image Search API", + "title": "Image Search Client", "description": "The Image Search API lets you send a search query to Bing and get back a list of relevant images. This section provides technical details about the query parameters and headers that you use to request images and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Images](https://docs.microsoft.com/azure/cognitive-services/bing-image-search/search-the-web).", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json index f05cfc1aba66..298d58342305 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json +++ b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "News Search API", + "title": "News Search Client", "description": "The News Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ @@ -241,9 +250,9 @@ } }, "x-ms-examples": { - "Successful query": { - "$ref": "./examples//SuccessfulNewsSearchRequest.json" - } + "Successful query": { + "$ref": "./examples//SuccessfulNewsSearchRequest.json" + } } } }, @@ -429,9 +438,9 @@ } }, "x-ms-examples": { - "Successful query": { - "$ref": "./examples//SuccessfulNewsCategoryRequest.json" - } + "Successful query": { + "$ref": "./examples//SuccessfulNewsCategoryRequest.json" + } } } }, @@ -609,9 +618,9 @@ } }, "x-ms-examples": { - "Successful query": { - "$ref": "./examples//SuccessfulNewsTrendingRequest.json" - } + "Successful query": { + "$ref": "./examples//SuccessfulNewsTrendingRequest.json" + } } } } diff --git a/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json index d1e2d1822c30..2c5b85f9bd9d 100644 --- a/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json +++ b/specification/cognitiveservices/data-plane/SpellCheck/stable/v1.0/SpellCheck.json @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json index 3d87a12b7a91..98ae1125b4e6 100644 --- a/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json +++ b/specification/cognitiveservices/data-plane/VideoSearch/stable/v1.0/VideoSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Video Search API", + "title": "Video Search Client", "description": "The Video Search API lets you search on Bing for video that are relevant to the user's search query, for insights about a video or for videos that are trending based on search requests made by others. This section provides technical details about the query parameters and headers that you use to request videos and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the Web for Videos](https://docs.microsoft.com/azure/cognitive-services/bing-video-search/search-the-web).", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json index e25d36c02a3d..8c89311b367b 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Visual Search API", + "title": "Visual Search Client", "description": "Visual Search API lets you discover insights about an image such as visually similar images, shopping sources, and related searches. The API can also perform text recognition, identify entities (people, places, things), return other topical content for the user to explore, and more. For more information, see [Visual Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ diff --git a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json index 98ee8cecc62c..2ee854933472 100644 --- a/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json +++ b/specification/cognitiveservices/data-plane/WebSearch/stable/v1.0/WebSearch.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Web Search API", + "title": "Web Search Client", "description": "The Web Search API lets you send a search query to Bing and get back search results that include links to webpages, images, and more.", "version": "1.0" }, @@ -22,6 +22,15 @@ ] } }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "../../../Common/Parameters.json#/parameters/GlobalEndpoint" + } + ] + }, "host": "api.cognitive.microsoft.com", "basePath": "/bing/v7.0", "schemes": [ @@ -294,9 +303,9 @@ } }, "x-ms-examples": { - "Successful query": { - "$ref": "./examples//SuccessfulQueryRequest.json" - } + "Successful query": { + "$ref": "./examples//SuccessfulQueryRequest.json" + } } } } From 2ca50c83ad4d17f3248ddad9ca632d11b26ded53 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 13 Nov 2018 13:07:07 -0800 Subject: [PATCH 129/464] Move Ruby SDK config to its own config file (#4451) The package-name variable for Ruby was colliding with the Go build. Moved the Ruby config to its own file to avoid the collision. --- .../databox/resource-manager/readme.md | 25 +----------------- .../databox/resource-manager/readme.ruby.md | 26 +++++++++++++++++++ 2 files changed, 27 insertions(+), 24 deletions(-) create mode 100644 specification/databox/resource-manager/readme.ruby.md diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index c19f5106c848..d9c4c20dc66e 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -105,30 +105,7 @@ python: ## Ruby -These settings apply only when `--ruby` is specified on the command line. - -``` yaml -package-name: azure_mgmt_databox -package-version: "0.0.1" -azure-arm: true -``` - -### Ruby multi-api - -``` yaml $(ruby) && $(multiapi) -batch: - - tag: package-2018-01 -``` - -### Tag: package-2018-01 and ruby - -These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. -Please also specify `--ruby-sdks-folder=`. - -``` yaml $(tag) == 'package-2018-01' && $(ruby) -namespace: "Azure::Compute::Mgmt::V2018_01_01" -output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databox/lib -``` +See configuration in [readme.ruby.md](./readme.ruby.md) ## Go diff --git a/specification/databox/resource-manager/readme.ruby.md b/specification/databox/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..3f6aec90e7e4 --- /dev/null +++ b/specification/databox/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml $(ruby) +package-name: azure_mgmt_databox +package-version: "0.0.1" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-01 +``` + +### Tag: package-2018-01 and ruby + +These settings apply only when `--tag=package-2018-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-01' && $(ruby) +namespace: "Azure::Compute::Mgmt::V2018_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databox/lib +``` From fa6a58438b2322f3e3fdacdea1cd54c612c39d09 Mon Sep 17 00:00:00 2001 From: mozehgir <32183061+mozehgir@users.noreply.github.com> Date: Tue, 13 Nov 2018 13:27:18 -0800 Subject: [PATCH 130/464] Update README.md (#4421) --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index bee32b5b9506..95373075cd54 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ This repository is the canonical source for REST API specifications for Microsof ## Basics If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. +Latest improvement: MSFT employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapihub) - online experience for using our validation tools and finding your workflow. + Please check the [announcements page](https://github.com/Azure/azure-rest-api-specs/wiki/Announcements) for any new updates since your last visit. ## Getting started From f8465dec826d1436bffe4bd061f4f15e58e91e0b Mon Sep 17 00:00:00 2001 From: Xiaoying Zhang Date: Wed, 14 Nov 2018 14:05:11 +0800 Subject: [PATCH 131/464] DataFactory: add table name in dataset (#4424) --- .../2018-06-01/entityTypes/Dataset.json | 217 +++++++++++++++--- .../2018-06-01/entityTypes/Pipeline.json | 5 +- 2 files changed, 189 insertions(+), 33 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index e2ab56cec7a8..963d44ebc860 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -941,7 +941,7 @@ "path" ] }, - "SqlServerTableDataset": { + "SqlServerTableDataset": { "x-ms-discriminator-value": "SqlServerTable", "description": "The on-premises SQL Server dataset.", "type": "object", @@ -1090,6 +1090,15 @@ } } }, + "GenericDatasetTypeProperties": { + "description": "Properties specific to this dataset type.", + "properties": { + "tableName": { + "type": "object", + "description": "The table name. Type: string (or Expression with resultType string)." + } + } + }, "AmazonMWSObjectDataset" : { "x-ms-discriminator-value": "AmazonMWSObject", "description": "Amazon Marketplace Web Service dataset.", @@ -1099,7 +1108,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "AzurePostgreSqlTableDataset" : { @@ -1111,7 +1125,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ConcurObjectDataset" : { @@ -1123,7 +1142,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "CouchbaseTableDataset" : { @@ -1135,7 +1159,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "DrillTableDataset" : { @@ -1147,7 +1176,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "EloquaObjectDataset" : { @@ -1159,7 +1193,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "GoogleBigQueryObjectDataset" : { @@ -1171,7 +1210,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "GreenplumTableDataset" : { @@ -1183,7 +1227,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "HBaseObjectDataset" : { @@ -1195,7 +1244,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "HiveObjectDataset" : { @@ -1207,7 +1261,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "HubspotObjectDataset" : { @@ -1219,7 +1278,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ImpalaObjectDataset" : { @@ -1231,7 +1295,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "JiraObjectDataset" : { @@ -1243,7 +1312,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "MagentoObjectDataset" : { @@ -1255,7 +1329,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "MariaDBTableDataset" : { @@ -1267,7 +1346,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "MarketoObjectDataset" : { @@ -1279,7 +1363,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "PaypalObjectDataset" : { @@ -1291,7 +1380,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "PhoenixObjectDataset" : { @@ -1303,7 +1397,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "PrestoObjectDataset" : { @@ -1315,7 +1414,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "QuickBooksObjectDataset" : { @@ -1327,7 +1431,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ServiceNowObjectDataset" : { @@ -1339,7 +1448,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ShopifyObjectDataset" : { @@ -1351,7 +1465,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "SparkObjectDataset" : { @@ -1363,7 +1482,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "SquareObjectDataset" : { @@ -1375,7 +1499,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "XeroObjectDataset" : { @@ -1387,7 +1516,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ZohoObjectDataset" : { @@ -1399,7 +1533,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "NetezzaTableDataset" : { @@ -1411,7 +1550,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "VerticaTableDataset" : { @@ -1423,7 +1567,12 @@ "$ref": "#/definitions/Dataset" } ], - "properties": { + "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "SalesforceMarketingCloudObjectDataset": { @@ -1436,6 +1585,11 @@ } ], "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } }, "ResponsysObjectDataset": { @@ -1448,6 +1602,11 @@ } ], "properties": { + "typeProperties": { + "description": "Properties specific to this dataset type.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/GenericDatasetTypeProperties" + } } } } 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 b9d1154b8b16..d808f70f6520 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 @@ -1184,10 +1184,7 @@ "description": "Stored procedure parameter type.", "$ref": "#/definitions/StoredProcedureParameterType" } - }, - "required": [ - "value" - ] + } }, "StoredProcedureParameterType": { "description": "Stored procedure parameter type.", From 10ec74f40e6ae0fc0f735a21aa6697453674aea3 Mon Sep 17 00:00:00 2001 From: Daniel Qiu Date: Wed, 14 Nov 2018 07:34:29 -0800 Subject: [PATCH 132/464] Adds storage account quick failover API (#4457) --- .../examples/StorageAccountFailover.json | 17 +++++++ .../stable/2018-07-01/storage.json | 46 +++++++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json new file mode 100644 index 000000000000..9f19caf35b0f --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountFailover.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "res4228", + "accountName": "sto2434", + "api-version": "2018-07-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": "" + }, + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json index 2d03c84eccd4..a93156382337 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json @@ -555,6 +555,46 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/failover": { + "post": { + "tags": [ + "StorageAccounts" + ], + "operationId": "StorageAccounts_Failover", + "description": "Failover request can be triggered for a storage account in case of availability issues. The failover occurs from the storage account's primary cluster to secondary cluster for RA-GRS accounts. The secondary cluster will become primary after failover.", + "x-ms-examples": { + "StorageAccountCreate": { + "$ref": "./examples/StorageAccountFailover.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/StorageAccountName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returned when the storage account failover is completed, and the secondary cluster has become primary." + }, + "202": { + "description": "Accepted -- Failover request accepted; operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } } }, "definitions": { @@ -1377,6 +1417,12 @@ "type": "boolean", "x-ms-client-name": "IsHnsEnabled", "description": "Account HierarchicalNamespace enabled if sets to true." + }, + "failoverInProgress": { + "type": "boolean", + "x-ms-client-name": "FailoverInProgress ", + "description": "If the failover is in progress, the value will be true, otherwise, it will be null.", + "readOnly": true } }, "description": "Properties of the storage account." From 7df0ce599e8d6579acd109ed9f4805954304969f Mon Sep 17 00:00:00 2001 From: promoisha Date: Wed, 14 Nov 2018 07:46:31 -0800 Subject: [PATCH 133/464] Added missing PATCH operation to Api Issue resource (#4440) --- .../preview/2018-06-01-preview/apimapis.json | 121 ++++++++++++++++-- .../examples/ApiManagementUpdateApiIssue.json | 18 +++ .../stable/2018-01-01/apimapis.json | 121 ++++++++++++++++-- .../examples/ApiManagementUpdateApiIssue.json | 18 +++ 4 files changed, 258 insertions(+), 20 deletions(-) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiIssue.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiIssue.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json index 89326eeb3b1f..73019ac93c17 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -2645,6 +2645,65 @@ } } }, + "patch": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_Update", + "description": "Updates an existing issue for an API.", + "x-ms-examples": { + "ApiManagementUpdateApiIssue": { + "$ref": "./examples/ApiManagementUpdateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IssueUpdateContract" + }, + "description": "Update parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Issue was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, "delete": { "tags": [ "ApiIssues" @@ -4341,6 +4400,16 @@ ], "description": "Issue Contract details." }, + "IssueUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueUpdateContractProperties", + "description": "Issue entity Update contract properties." + } + }, + "description": "Issue update Parameters." + }, "IssueContractProperties": { "properties": { "title": { @@ -4351,6 +4420,47 @@ "type": "string", "description": "Text describing the issue." }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "required": [ + "title", + "description", + "userId" + ], + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Properties." + }, + "IssueUpdateContractProperties": { + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Update Properties." + }, + "IssueContractBaseProperties": { + "properties": { "createdDate": { "type": "string", "format": "date-time", @@ -4393,21 +4503,12 @@ ] } }, - "userId": { - "type": "string", - "description": "A resource identifier for the user created the issue." - }, "apiId": { "type": "string", "description": "A resource identifier for the API the issue was created for." } }, - "required": [ - "title", - "description", - "userId" - ], - "description": "Issue contract Properties." + "description": "Issue contract Base Properties." }, "IssueCommentCollection": { "properties": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiIssue.json new file mode 100644 index 000000000000..36f3f70fe42c --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementUpdateApiIssue.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "state": "closed" + } + } + }, + "responses": { + "204": { } + } + } \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json index bdedca08bd5a..16286cb719e9 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json @@ -2857,6 +2857,65 @@ } } }, + "patch": { + "tags": [ + "ApiIssues" + ], + "operationId": "ApiIssue_Update", + "description": "Updates an existing issue for an API.", + "x-ms-examples": { + "ApiManagementUpdateApiIssue": { + "$ref": "./examples/ApiManagementUpdateApiIssue.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "#/parameters/ApiIdParameter" + }, + { + "$ref": "#/parameters/IssueIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IssueUpdateContract" + }, + "description": "Update parameters." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.", + "type": "string" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The Issue was successfully updated." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + }, "delete": { "tags": [ "ApiIssues" @@ -4549,6 +4608,16 @@ ], "description": "Issue Contract details." }, + "IssueUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IssueUpdateContractProperties", + "description": "Issue entity Update contract properties." + } + }, + "description": "Issue update Parameters." + }, "IssueContractProperties": { "properties": { "title": { @@ -4559,6 +4628,47 @@ "type": "string", "description": "Text describing the issue." }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "required": [ + "title", + "description", + "userId" + ], + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Properties." + }, + "IssueUpdateContractProperties": { + "properties": { + "title": { + "type": "string", + "description": "The issue title." + }, + "description": { + "type": "string", + "description": "Text describing the issue." + }, + "userId": { + "type": "string", + "description": "A resource identifier for the user created the issue." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IssueContractBaseProperties" + } + ], + "description": "Issue contract Update Properties." + }, + "IssueContractBaseProperties": { + "properties": { "createdDate": { "type": "string", "format": "date-time", @@ -4601,21 +4711,12 @@ ] } }, - "userId": { - "type": "string", - "description": "A resource identifier for the user created the issue." - }, "apiId": { "type": "string", "description": "A resource identifier for the API the issue was created for." } }, - "required": [ - "title", - "description", - "userId" - ], - "description": "Issue contract Properties." + "description": "Issue contract Base Properties." }, "IssueCommentCollection": { "properties": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiIssue.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiIssue.json new file mode 100644 index 000000000000..03cfa07b7ce3 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementUpdateApiIssue.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-01-01", + "subscriptionId": "subid", + "issueId": "57d2ef278aa04f0ad01d6cdc", + "apiId": "57d1f7558aa04f15146d9d8a", + "parameters": { + "properties": { + "state": "closed" + } + } + }, + "responses": { + "204": { } + } + } \ No newline at end of file From 4f93deeb63f7b766f639ac2c697aba0260b62bbc Mon Sep 17 00:00:00 2001 From: VitaliyKurokhtin Date: Wed, 14 Nov 2018 08:39:54 -0800 Subject: [PATCH 134/464] /identity endpoint added (#4460) --- .../preview/2018-06-01-preview/apimusers.json | 50 +++++++++++++++++++ .../ApiManagementGetUserIdentity.json | 15 ++++++ .../stable/2018-01-01/apimusers.json | 50 +++++++++++++++++++ .../ApiManagementGetUserIdentity.json | 15 ++++++ 4 files changed, 130 insertions(+) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUserIdentity.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUserIdentity.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json index 1207811dfd69..8e7367a34444 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimusers.json @@ -34,6 +34,48 @@ } }, "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identity": { + "get": { + "tags": [ + "Users" + ], + "operationId": "User_GetIdentity", + "description": "Returns calling user identity information.", + "x-ms-examples": { + "ApiManagementListUsers": { + "$ref": "./examples/ApiManagementGetUserIdentity.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Current user APIM id.", + "schema": { + "$ref": "#/definitions/CurrentUserIdentity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { "get": { "tags": [ @@ -942,6 +984,14 @@ } ], "description": "Parameters supplied to the Update User operation." + }, + "CurrentUserIdentity": { + "properties": { + "id": { + "type": "string", + "description": "API Management service user id." + } + } } }, "parameters": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUserIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUserIdentity.json new file mode 100644 index 000000000000..4d5903dd3554 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetUserIdentity.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "1" + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json index 5da0e9deb3c8..2413c3b71f61 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimusers.json @@ -34,6 +34,48 @@ } }, "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identity": { + "get": { + "tags": [ + "Users" + ], + "operationId": "User_GetIdentity", + "description": "Returns calling user identity information.", + "x-ms-examples": { + "ApiManagementListUsers": { + "$ref": "./examples/ApiManagementGetUserIdentity.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Current user APIM id.", + "schema": { + "$ref": "#/definitions/CurrentUserIdentity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./apimanagement.json#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users": { "get": { "tags": [ @@ -942,6 +984,14 @@ } ], "description": "Parameters supplied to the Update User operation." + }, + "CurrentUserIdentity": { + "properties": { + "id": { + "type": "string", + "description": "API Management service user id." + } + } } }, "parameters": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUserIdentity.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUserIdentity.json new file mode 100644 index 000000000000..e740bc2d0bf9 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetUserIdentity.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "serviceName": "apimService1", + "api-version": "2018-01-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "1" + } + } + } +} \ No newline at end of file From ffaf5955754300110f8419030baa6c77f93620c0 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Thu, 15 Nov 2018 02:33:05 +0800 Subject: [PATCH 135/464] fixing invalid location in examples (#4415) --- .../preview/2017-04-30-preview/examples/ServerCreate.json | 6 +++--- .../preview/2017-04-30-preview/examples/ServerGet.json | 2 +- .../preview/2017-04-30-preview/examples/ServerList.json | 6 +++--- .../examples/ServerListByResourceGroup.json | 4 ++-- .../preview/2017-04-30-preview/examples/ServerUpdate.json | 2 +- .../preview/2017-12-01-preview/examples/ServerCreate.json | 6 +++--- .../preview/2017-12-01-preview/examples/ServerGet.json | 2 +- .../preview/2017-12-01-preview/examples/ServerList.json | 6 +++--- .../examples/ServerListByResourceGroup.json | 6 +++--- .../preview/2017-12-01-preview/examples/ServerUpdate.json | 2 +- .../preview/2017-04-30-preview/examples/ServerCreate.json | 6 +++--- .../preview/2017-04-30-preview/examples/ServerGet.json | 2 +- .../preview/2017-04-30-preview/examples/ServerList.json | 6 +++--- .../examples/ServerListByResourceGroup.json | 4 ++-- .../preview/2017-04-30-preview/examples/ServerUpdate.json | 2 +- .../preview/2017-12-01-preview/examples/ServerCreate.json | 6 +++--- .../preview/2017-12-01-preview/examples/ServerGet.json | 2 +- .../preview/2017-12-01-preview/examples/ServerList.json | 6 +++--- .../examples/ServerListByResourceGroup.json | 6 +++--- .../preview/2017-12-01-preview/examples/ServerUpdate.json | 2 +- 20 files changed, 42 insertions(+), 42 deletions(-) diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json index 26e96603f4f5..76ec59d78b80 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json @@ -5,7 +5,7 @@ "api-version": "2017-04-30-preview", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { - "location": "OneBox", + "location": "eastus", "properties": { "administratorLogin": "cloudsa", "administratorLoginPassword": "password", @@ -29,7 +29,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", @@ -52,7 +52,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json index 209d045467be..79f41a88dfca 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json index 1f52a4ae74c7..03c1712c3de6 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", @@ -32,7 +32,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/serv1", "name": "serv1", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", @@ -53,7 +53,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforMySQL/servers/serv2", "name": "serv2", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json index ca3ef13688e9..d826e30ce245 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json @@ -12,7 +12,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/serv1", "name": "serv1", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", @@ -33,7 +33,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json index baeb419e3728..b212155df693 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json @@ -17,7 +17,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "MYSQLS3M100", "tier": "Basic", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json index e334fed3f491..9c1963d966a0 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerCreate.json @@ -5,7 +5,7 @@ "api-version": "2017-12-01-preview", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { - "location": "OneBox", + "location": "eastus", "properties": { "administratorLogin": "cloudsa", "administratorLoginPassword": "password", @@ -34,7 +34,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", @@ -64,7 +64,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerGet.json index 9156d5b0de39..1a4ef056abbe 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerGet.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerList.json index a9be15f3cb57..8b1ff25d8103 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerList.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerList.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -39,7 +39,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver1", "name": "testserver1", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -67,7 +67,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver2", "name": "testserver2", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json index 3ac7ed8da39e..be14e41536e6 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json @@ -12,7 +12,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -40,7 +40,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver1", "name": "testserver1", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -68,7 +68,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver2", "name": "testserver2", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerUpdate.json index 8c11d5cfb79c..4be7be89e3f8 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerUpdate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/ServerUpdate.json @@ -17,7 +17,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforMySQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json index 4e88adf0ffdf..0a38ebac97f5 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json @@ -5,7 +5,7 @@ "api-version": "2017-04-30-preview", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { - "location": "OneBox", + "location": "eastus", "properties": { "administratorLogin": "cloudsa", "administratorLoginPassword": "password", @@ -29,7 +29,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", @@ -52,7 +52,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json index c77294d8a56f..ea8361077947 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json index 6a5c925b7bbd..dda22aa039ad 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", @@ -32,7 +32,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/serv1", "name": "serv1", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", @@ -53,7 +53,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforPostgreSQL/servers/serv2", "name": "serv2", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json index 39df40d8ac77..3da768516584 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json @@ -12,7 +12,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/serv1", "name": "serv1", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", @@ -33,7 +33,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json index cab45b4c31d9..161426a7aa80 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json @@ -17,7 +17,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "name": "PGSQLB100", "tier": "Basic", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json index d9f98c99fb76..406a3136f1c1 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerCreate.json @@ -5,7 +5,7 @@ "api-version": "2017-12-01-preview", "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { - "location": "OneBox", + "location": "eastus", "properties": { "administratorLogin": "cloudsa", "administratorLoginPassword": "password", @@ -34,7 +34,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", @@ -64,7 +64,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerGet.json index 6d9273d3c99a..95d55cade7a0 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerGet.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerGet.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerList.json index edc1887a7073..4e093b7a3cbd 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerList.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerList.json @@ -11,7 +11,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -39,7 +39,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver1", "name": "testserver1", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -67,7 +67,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver2", "name": "testserver2", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json index f10a235c4143..4366edbe65c4 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerListByResourceGroup.json @@ -12,7 +12,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -40,7 +40,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver1", "name": "testserver1", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, @@ -68,7 +68,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver2", "name": "testserver2", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "tags": { "elasticServer": "1" }, diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerUpdate.json index 0dbaa03fb484..aa4cce64aa4d 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerUpdate.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/examples/ServerUpdate.json @@ -17,7 +17,7 @@ "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", "name": "testserver", "type": "Microsoft.DBforPostgreSQL/servers", - "location": "onebox", + "location": "eastus", "sku": { "capacity": 2, "family": "Gen4", From 90db24cbae7e52097ed21f595a169dd61800d070 Mon Sep 17 00:00:00 2001 From: Matt Briggs Date: Wed, 14 Nov 2018 10:33:36 -0800 Subject: [PATCH 136/464] Mdb 20181029 statepropdescriptions (#4452) * Subscription Get state property desc * Incorrect description for Deleted SubscriptionState * resolving merge issue --- .../preview/2015-11-01/Subscriptions.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json index 7051a6d54164..d6bd6db99e6d 100644 --- a/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json +++ b/specification/azsadmin/resource-manager/subscriptions/Microsoft.Subscriptions.Admin/preview/2015-11-01/Subscriptions.json @@ -627,11 +627,6 @@ "name": "Deleted", "value": "Deleted" }, - { - "description": "The String.", - "name": "Deleted", - "value": "Deleted" - }, { "description": "This state is not used in Azure Stack.", "name": "NotDefined", From 7f0fd162676915ae5023e16854d9c118855b24ea Mon Sep 17 00:00:00 2001 From: Jianghao Lu Date: Wed, 14 Nov 2018 13:31:03 -0800 Subject: [PATCH 137/464] Add latest authorization tag to java config (#4406) --- .../authorization/resource-manager/readme.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index 33791a541f41..a5b8c749d671 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -209,6 +209,20 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-authorization ``` yaml $(java) && $(multiapi) batch: - tag: package-2015-07 + - tag: package-2018-09-01-preview +``` + +### Tag: package-2018-09-01-preview and java + +These settings apply only when `--tag=package-2018-09-01-preview --java` is specified on he command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-09-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.authorization.v2018_09_01_preview + output-folder: $(azure-libraries-for-java-folder)/authorization/resource-manager/v2018_09_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2015-07 and java From ab9c6ff77b4f15ee7880c8f860c7e96f8356e80d Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Wed, 14 Nov 2018 14:24:19 -0800 Subject: [PATCH 138/464] Add maximum chunk size to data lake store docs. (#4464) * Add maximum chunk size to data lake store docs. * fix semantic validation errors * deprecate operation FileSystem_Concat --- .../2015-10-01-preview/filesystem.json | 47 ++++++++++--------- .../stable/2016-11-01/filesystem.json | 6 +-- 2 files changed, 28 insertions(+), 25 deletions(-) diff --git a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json index 80b5afd54ea0..e0588df749be 100644 --- a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json +++ b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json @@ -64,7 +64,7 @@ "format": "file" }, "required": true, - "description": "The file contents to include when appending to the file." + "description": "The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "appendMode", @@ -277,14 +277,16 @@ } } } - }, - "/webhdfs/v1/{destinationPath}": { + } + }, + "x-ms-paths": { + "/webhdfs/v1/{destinationPath}?op=CONCAT": { "post": { "tags": [ "FileSystem" ], "operationId": "FileSystem_Concat", - "description": "Concatenates the list of source files into the destination file, removing all source files upon success.", + "description": "Concatenates the list of source files into the destination file, removing all source files upon success. This operation has been deprecated, please use operation FileSystem_MsConcat instead.", "parameters": [ { "name": "destinationPath", @@ -329,10 +331,11 @@ "$ref": "#/definitions/AdlsError" } } - } + }, + "deprecated": true } }, - "/webhdfs/v1/{msConcatDestinationPath}": { + "/webhdfs/v1/{msConcatDestinationPath}?op=MSCONCAT": { "post": { "tags": [ "FileSystem" @@ -395,7 +398,7 @@ } } }, - "/webhdfs/v1/{listFilePath}": { + "/webhdfs/v1/{listFilePath}?op=MSLISTSTATUS": { "get": { "tags": [ "FileSystem" @@ -463,7 +466,7 @@ } } }, - "/webhdfs/va/{getContentSummaryFilePath}": { + "/webhdfs/va/{getContentSummaryFilePath}?op=GETCONTENTSUMMARY": { "get": { "tags": [ "FileSystem" @@ -509,7 +512,7 @@ } } }, - "/webhdfs/v1/{getFilePath}": { + "/webhdfs/v1/{getFilePath}?op=MSGETFILESTATUS": { "get": { "tags": [ "FileSystem" @@ -555,7 +558,7 @@ } } }, - "/webhdfs/v1/{flushFilePath}": { + "/webhdfs/v1/{flushFilePath}?op=APPEND;append=true;flush=true": { "post": { "tags": [ "FileSystem" @@ -621,7 +624,7 @@ } } }, - "/webhdfs/v1/{directFilePath}": { + "/webhdfs/v1/{directFilePath}?op=APPEND": { "post": { "tags": [ "FileSystem" @@ -647,7 +650,7 @@ "format": "file" }, "required": true, - "description": "The file contents to include when appending to the file." + "description": "The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "offset", @@ -719,7 +722,7 @@ "format": "file" }, "required": false, - "description": "The file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified." + "description": "The file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "overwrite", @@ -834,7 +837,7 @@ } } }, - "/webhdfs/v1/{setAclFilePath}": { + "/webhdfs/v1/{setAclFilePath}?op=SETACL": { "put": { "tags": [ "FileSystem" @@ -884,7 +887,7 @@ } } }, - "/webhdfs/v1/{modifyAclFilePath}": { + "/webhdfs/v1/{modifyAclFilePath}?op=MODIFYACLENTRIES": { "put": { "tags": [ "FileSystem" @@ -934,7 +937,7 @@ } } }, - "/webhdfs/v1/{removeAclFilePath}": { + "/webhdfs/v1/{removeAclFilePath}?op=REMOVEACLENTRIES": { "put": { "tags": [ "FileSystem" @@ -984,7 +987,7 @@ } } }, - "/webhdfs/v1/{defaultAclFilePath}": { + "/webhdfs/v1/{defaultAclFilePath}?op=REMOVEDEFAULTACL": { "put": { "tags": [ "FileSystem" @@ -1027,7 +1030,7 @@ } } }, - "/webhdfs/v1/{aclFilePath}": { + "/webhdfs/v1/{aclFilePath}?op=REMOVEACL": { "put": { "tags": [ "FileSystem" @@ -1114,7 +1117,7 @@ } } }, - "/webhdfs/v1/{filePath}": { + "/webhdfs/v1/{filePath}?op=DELETE": { "delete": { "tags": [ "FileSystem" @@ -1167,7 +1170,7 @@ } } }, - "/webhdfs/v1/{renameFilePath}": { + "/webhdfs/v1/{renameFilePath}?op=RENAME": { "put": { "tags": [ "FileSystem" @@ -1220,7 +1223,7 @@ } } }, - "/webhdfs/v1/{setOwnerFilePath}": { + "/webhdfs/v1/{setOwnerFilePath}?op=SETOWNER": { "put": { "tags": [ "FileSystem" @@ -1277,7 +1280,7 @@ } } }, - "/webhdfs/v1/{setPermissionFilePath}": { + "/webhdfs/v1/{setPermissionFilePath}?op=SETPERMISSION": { "put": { "tags": [ "FileSystem" diff --git a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json index b636e04e8ac5..c7e80ed48e82 100644 --- a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json +++ b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json @@ -130,7 +130,7 @@ "format": "file" }, "required": true, - "description": "The file contents to include when appending to the file." + "description": "The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "appendMode", @@ -743,7 +743,7 @@ "format": "file" }, "required": true, - "description": "The file contents to include when appending to the file." + "description": "The file contents to include when appending to the file. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "offset", @@ -854,7 +854,7 @@ "format": "file" }, "required": false, - "description": "The file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified." + "description": "The file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified. The maximum content size is 4MB. For content larger than 4MB you must append the content in 4MB chunks." }, { "name": "overwrite", From 20d4ed0c8753c26ec9d1ff8b19d7f80446fb5d0f Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Fri, 16 Nov 2018 01:05:00 +0800 Subject: [PATCH 139/464] Supression rules for TagValue and TagDetails (#4469) --- specification/resources/resource-manager/readme.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index c3d94950a567..8f12f1646b4d 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -307,6 +307,14 @@ directive: from: resources.json where: $.definitions.TagValue.properties reason: TagValue is a top level property + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.TagValue + reason: TagValue will be deprecated soon + - suppress: BodyTopLevelProperties + from: resources.json + where: $.definitions.TagDetails + reason: TagDetails will be deprecated soon - suppress: BodyTopLevelProperties from: managedapplications.json where: $.definitions.Appliance.properties From d152b6037379e02362303cab2bd82f64d5988a29 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Thu, 15 Nov 2018 12:51:43 -0800 Subject: [PATCH 140/464] Revert "Swagger closure for Azure Migration Hub Operations" (#4482) * Revert "Add maximum chunk size to data lake store docs. (#4464)" This reverts commit ab9c6ff77b4f15ee7880c8f860c7e96f8356e80d. * Revert "Add latest authorization tag to java config (#4406)" This reverts commit 7f0fd162676915ae5023e16854d9c118855b24ea. * Revert "Mdb 20181029 statepropdescriptions (#4452)" This reverts commit 90db24cbae7e52097ed21f595a169dd61800d070. * Revert "fixing invalid location in examples (#4415)" This reverts commit ffaf5955754300110f8419030baa6c77f93620c0. * Revert "/identity endpoint added (#4460)" This reverts commit 4f93deeb63f7b766f639ac2c697aba0260b62bbc. * Revert "Added missing PATCH operation to Api Issue resource (#4440)" This reverts commit 7df0ce599e8d6579acd109ed9f4805954304969f. * Revert "Adds storage account quick failover API (#4457)" This reverts commit 10ec74f40e6ae0fc0f735a21aa6697453674aea3. * Revert "DataFactory: add table name in dataset (#4424)" This reverts commit f8465dec826d1436bffe4bd061f4f15e58e91e0b. * Revert "Update README.md (#4421)" This reverts commit fa6a58438b2322f3e3fdacdea1cd54c612c39d09. * Revert "Move Ruby SDK config to its own config file (#4451)" This reverts commit 2ca50c83ad4d17f3248ddad9ca632d11b26ded53. * Revert "[CognitiveServices] enable Bing Search/CustomSearch products to specify Endpoint (#4401)" This reverts commit dc782b320161cb372dc3322aca860e452b76e9c5. * Revert "Add GeoRegion property to DeletedSite model (#4448)" This reverts commit a079367c50c15f74a2b801441e20b14bbc912bd8. * Revert " Azure Container Instance: Add start container group API (#4423)" This reverts commit 2ea3e9ebf74c5bade9146643bfbef092dfe80118. * Revert "add guidance for example names (#4432)" This reverts commit 6780e8ad5b09fcc3dcbe9eec58671dc89295d3be. * Revert "Remove security contact phone field mandatory fields (#4417)" This reverts commit eaf464ee6a5803e1d1b0e16ede4e5af15efc0b25. * Revert "Add Allowed Connections REST API (#4106)" This reverts commit 2389da39084fb8880cde21111ff79bc72e74f830. * Revert "Make NIC VM readOnly (#4444)" This reverts commit 2d83450cbe91cc06d775ce384d8ab9c91589c894. * Revert "Remove readonly attribute from identities collection in users (#4442)" This reverts commit 7577df97b09389657606a5d1bc814ca7d44b1af9. * Revert "Add spec for alert repair/remediate (#4084)" This reverts commit 3f568b4898533a2699c90a7f451448dfebae140a. * Revert "Py conf in its own file (#4439)" This reverts commit 337376061dedcb5d6dfe7d2ddad59061c45f5710. * Revert "Split Python conf in it's own file (#4438)" This reverts commit 77cf607c0e92af7a2f6937aa5f30bc08673cb902. * Revert "Adding ManagedInstanceVulnerabilityAssessments and ServerVulnerabilityAssessments (#4416)" This reverts commit dec75495352902ebb6393d42c50465b6195f239d. * Revert "WebApps: Snapshots API for DR stamps (#4291)" This reverts commit 916ff2e6e2e722c8b6ca8c77149f6b2ab358332a. * Revert "Swagger closure for Azure Migration Hub Operations (#4330)" This reverts commit badd1de79620e5660c7e9a7b0495076152f66356. --- .../examples/Machines_Get.json | 70 - .../examples/Machines_List.json | 130 - .../examples/MigrateErrors_Delete.json | 14 - .../examples/MigrateErrors_Get.json | 26 - .../examples/MigrateErrors_List.json | 42 - .../examples/MigrateProjects_Delete.json | 13 - .../examples/MigrateProjects_Get.json | 34 - .../examples/MigrateProjects_Patch.json | 48 - .../examples/MigrateProjects_Put.json | 63 - .../MigrateProjects_RefreshSummary.json | 15 - .../MigrateProjects_RegisterTool.json | 15 - .../examples/Operations_List.json | 115 - .../examples/Solutions_Delete.json | 14 - .../examples/Solutions_Get.json | 37 - .../examples/Solutions_GetConfig.json | 16 - .../examples/Solutions_List.json | 64 - .../examples/Solutions_Patch.json | 42 - .../examples/Solutions_Put.json | 70 - .../preview/2018-09-01-preview/migrate.json | 2554 ----------------- .../resource-manager/readme.md | 99 - .../resource-manager/readme.nodejs.md | 15 - 21 files changed, 3496 deletions(-) delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json delete mode 100644 specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json delete mode 100644 specification/migrateprojects/resource-manager/readme.md delete mode 100644 specification/migrateprojects/resource-manager/readme.nodejs.md diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json deleted file mode 100644 index bd40d519c9f2..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_Get.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "machineName":"vm1" - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm1", - "name":"vm1", - "type":"Microsoft.Migrate/MigrateProjects/machines", - "eTag":"\"a701c63a-0000-0000-0000-59c12fe60000\"", - "properties":{ - "discoveryData":[ - { - "osType":"windows", - "osName":"windows server 2012 R2", - "osVersion":"10.0.01", - "enqueueTime":"2017-09-12T13:11:10.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom1":"mycustomvalue" - } - } - ], - "assessmentData":[ - { - "assessmentId":"myid1", - "targetVMSize":"Standard_D4_v2", - "targetVMLocation":"eastus", - "targetStorageType":{ - "disk1":"Standard" - }, - "enqueueTime":"2017-09-12T13:11:20.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom2":"mycustomvalue" - } - } - ], - "migrationData":[ - { - "migrationPhase":"Migrated", - "migrationTested":true, - "replicationProgressPercentage":100, - "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm1", - "enqueueTime":"2017-09-12T13:11:30.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom3":"mycustomvalue" - } - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json deleted file mode 100644 index 3593e7b66475..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Machines_List.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm1", - "name":"vm1", - "type":"Microsoft.Migrate/MigrateProjects/machines", - "eTag":"\"b701c63a-0000-0000-0000-59c12fe60000\"", - "properties":{ - "discoveryData":[ - { - "osType":"windows", - "osName":"windows server 2012 R2", - "osVersion":"10.0.01", - "enqueueTime":"2017-09-12T13:11:10.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom1":"mycustomvalue" - } - } - ], - "assessmentData":[ - { - "assessmentId":"myid1", - "targetVMSize":"Standard_D4_v2", - "targetVMLocation":"eastus", - "targetStorageType":{ - "disk1":"Standard" - }, - "enqueueTime":"2017-09-12T13:11:20.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom2":"mycustomvalue" - } - } - ], - "migrationData":[ - { - "migrationPhase":"Migrated", - "migrationTested":true, - "replicationProgressPercentage":100, - "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm1", - "enqueueTime":"2017-09-12T13:11:30.8808917Z", - "solutionName":"mysolution", - "machineId":"abcd", - "machineManagerId":"efgh", - "machineName":"vm1", - "extendedInfo":{ - "custom3":"mycustomvalue" - } - } - ] - } - }, - { - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/machines/vm2", - "name":"vm2", - "type":"Microsoft.Migrate/MigrateProjects/machines", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "properties":{ - "discoveryData":[ - { - "osType":"windows", - "osName":"windows server 2012 R2", - "osVersion":"10.0.01", - "enqueueTime":"2017-09-12T13:11:10.8808917Z", - "solutionName":"mysolution", - "machineId":"xyz", - "machineManagerId":"efgh", - "machineName":"vm2", - "extendedInfo":{ - "custom1":"mycustomvalue" - } - } - ], - "assessmentData":[ - { - "assessmentId":"myid1", - "targetVMSize":"Standard_D4_v2", - "targetVMLocation":"eastus", - "targetStorageType":{ - "disk1":"Standard" - }, - "enqueueTime":"2017-09-12T13:11:20.8808917Z", - "solutionName":"mysolution", - "machineId":"xyz", - "machineManagerId":"efgh", - "machineName":"vm2", - "extendedInfo":{ - "custom2":"mycustomvalue" - } - } - ], - "migrationData":[ - { - "migrationPhase":"Migrated", - "migrationTested":true, - "replicationProgressPercentage":100, - "targetVMArmId":"/subscriptions/abc/resourcegroups/rg/providers/microsoft.compute/virtualmachines/vm2", - "enqueueTime":"2017-09-12T13:11:30.8808917Z", - "solutionName":"mysolution", - "machineId":"xyz", - "machineManagerId":"efgh", - "machineName":"vm2", - "extendedInfo":{ - "custom3":"mycustomvalue" - } - } - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json deleted file mode 100644 index 317fcf593ec1..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Delete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName": "project01", - "migrateErrorName":"MigrateError01" - }, - "responses":{ - "200":{ - - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json deleted file mode 100644 index 6d1bf17c473b..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_Get.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName": "project01", - "migrateErrorName":"MigrateError01" - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError01", - "name":"MigrateError01", - "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors", - "properties":{ - "errorCode":1234, - "errorMessage":"Invalid machine name.", - "recommendation":"Please correct the error and retry the operation.", - "possibleCauses":"Invalid input in the data.", - "solution":"mysolution", - "machine":"mymachine1" - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json deleted file mode 100644 index 1b483431ba7d..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateErrors_List.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName": "project01" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "properties":{ - "errorCode":1234, - "errorMessage":"Invalid machine name.", - "recommendation":"Please correct the error and retry the operation.", - "possibleCauses":"Invalid input in the data.", - "solution":"mysolution", - "machine":"mymachine1" - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError01", - "name":"MigrateError01", - "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors" - }, - { - "properties":{ - "errorCode":1288, - "errorMessage":"Invalid foramt.", - "recommendation":"Please correct the error and retry the operation.", - "possibleCauses":"Invalid input in the data.", - "solution":"mysolution", - "machine":"mymachine2" - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/MigrateError02", - "name":"MigrateError02", - "type":"Microsoft.Migrate/MigrateProjects/MigrateErrors" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json deleted file mode 100644 index 16683169cd8b..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json deleted file mode 100644 index 369327631b40..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Get.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "registeredTools":[ - "SAS", - "SMS" - ], - "summary":{ - "discoveredCount":23223, - "assessedCount":43, - "replicatingCount":123, - "migratedCount":10023 - } - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"West Us", - "tags":{ - - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json deleted file mode 100644 index 62e5559050cb..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Patch.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "project":{ - "properties":{ - "registeredTools":[ - "SMS" - ], - "summary":{ - - } - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"Southeast Asia", - "tags":{ - - } - } - }, - "responses":{ - "200":{ - "body":{ - "properties":{ - "registeredTools":[ - "SMS" - ], - "summary":{ - - } - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"Southeast Asia", - "tags":{ - - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json deleted file mode 100644 index 63b7ad8c4208..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_Put.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "project":{ - "properties":{ - - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"Southeast Asia", - "tags":{ - - } - } - }, - "responses":{ - "201":{ - "body":{ - "properties":{ - "registeredTools":[ - - ], - "summary":{ - - } - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"Southeast Asia", - "tags":{ - - } - } - }, - "200":{ - "body":{ - "properties":{ - "registeredTools":[ - - ], - "summary":{ - - } - }, - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01", - "name":"project01", - "type":"Microsoft.Migrate/MigrateProjects", - "eTag":"\"b701c73a-0000-0000-0000-59c12ff00000\"", - "location":"Southeast Asia", - "tags":{ - - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json deleted file mode 100644 index 8c2f70e4f05d..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RefreshSummary.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - "body":{ - "isRefreshed":true - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json deleted file mode 100644 index 8691f5998a84..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/MigrateProjects_RegisterTool.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - "body":{ - "isRegistered":true - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json deleted file mode 100644 index cdd19ef51dc8..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Operations_List.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "name":"Microsoft.Migrate/MigrateProjects/read", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects", - "operation":"Read", - "description":"Reads a migrate project" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Write", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects", - "operation":"Write", - "description":"Creates or updates a migrate project" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Delete", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects", - "operation":"Delete", - "description":"Deletes a migrate project" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/registerTool/action", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects", - "operation":"Register tool with migrate project", - "description":"Registers a tool with the migrate project" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Solutions/read", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/Solutions", - "operation":"Read", - "description":"Reads a solution" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Solutions/write", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/Solutions", - "operation":"Write", - "description":"Creates or updates a solution" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Solutions/delete", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/Solutions", - "operation":"Delete", - "description":"Deletes a solution" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Solutions/getConfig/action", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/Solutions", - "operation":"Gets solution config", - "description":"Gets configuration of a solution" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/Machines/read", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/Machines", - "operation":"Read", - "description":"Reads a machine" - }, - "origin":"user,system" - }, - { - "name":"Microsoft.Migrate/MigrateProjects/MigrateErrors/read", - "display":{ - "provider":"Microsoft.Migrate", - "resource":"Microsoft.Migrate/MigrateProjects/MigrateErrors", - "operation":"Read", - "description":"Reads a migrate error" - }, - "origin":"user,system" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json deleted file mode 100644 index 5781a29e1a8b..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Delete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "solutionName":"smssolution" - }, - "responses":{ - "200":{ - - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json deleted file mode 100644 index 7e7fad9b5af2..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Get.json +++ /dev/null @@ -1,37 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "solutionName":"smssolution" - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", - "name":"smssolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json deleted file mode 100644 index 6354f1ed4428..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_GetConfig.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "solutionName":"smssolution" - }, - "responses":{ - "200":{ - "body":{ - "publisherSasUri": "Endpoint=sb://xxx.servicebus.windows.net/;SharedAccessSignature=SharedAccessSignature sr=sb%3a%2f%2fxxx.servicebus.windows.net%2fIsvMigrationPayloadEventHub%2fPublishers%2ffad35230-08cd-4d96-bb75-6e41508adb3b-pub-smssolution&sig=Wpf0ORIJI9AFESLDLlJH1ejrUj2W7hy%2fMac%2f7ewZ6j8%3d&se=1541501430&skn=SendPolicy;EntityPath=xyz;Publisher=fad35230-08cd-4d96-bb75-6e41508adb3b-pub-smssolution" - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json deleted file mode 100644 index f88c5b5d457c..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_List.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01" - }, - "responses":{ - "200":{ - "body":{ - "value":[ - { - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", - "name":"smssolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - }, - { - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/sassolution", - "name":"sassolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SAS", - "purpose":"assessment", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json deleted file mode 100644 index 48541b6cc141..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Patch.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "solutionName":"smssolution", - "solutionInput":{ - "properties":{ - "isInactive":false - } - } - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", - "name":"smssolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json deleted file mode 100644 index 4ff10343517f..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/examples/Solutions_Put.json +++ /dev/null @@ -1,70 +0,0 @@ -{ - "parameters":{ - "resourceGroupName":"myResourceGroup", - "api-version":"2018-09-01-preview", - "subscriptionId":"75dd7e42-4fd1-4512-af04-83ad9864335b", - "migrateProjectName":"project01", - "solutionName":"smssolution", - "solutionInput":{ - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers" - } - } - }, - "responses":{ - "200":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", - "name":"smssolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - } - }, - "201":{ - "body":{ - "id":"/subscriptions/75dd7e42-4fd1-4512-af04-83ad9864335b/resourceGroups/myResourceGroup/providers/Microsoft.Migrate/MigrateProjects/project01/Solutions/smssolution", - "name":"smssolution", - "type":"Microsoft.Migrate/MigrateProjects/Solutions", - "properties":{ - "tool":"SMS", - "purpose":"migration", - "goal":"servers", - "isInactive":false, - "summary":{ - "discoveredCount":0, - "assessedCount":0, - "replicatingCount":0, - "migratedCount":0 - }, - "details":{ - "groupCount":0, - "assessmentCount":0, - "extendedDetails":{ - - } - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json b/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json deleted file mode 100644 index b905da16eef3..000000000000 --- a/specification/migrateprojects/resource-manager/Microsoft.Migrate/preview/2018-09-01-preview/migrate.json +++ /dev/null @@ -1,2554 +0,0 @@ -{ - "swagger":"2.0", - "info":{ - "version":"2018-09-01-preview", - "title":"Azure Migrate Hub", - "description":"Migrate your workloads to Azure.", - "contact":{ - "name":"Microsoft", - "email":"azuremigrate@microsoft.com" - } - }, - "host":"management.azure.com", - "schemes":[ - "https" - ], - "produces":[ - "application/json" - ], - "consumes":[ - "application/json" - ], - "parameters":{ - "subscriptionId":{ - "name":"subscriptionId", - "description":"Azure Subscription Id in which migrate project was created.", - "type":"string", - "in":"path", - "required":true - }, - "resourceGroupName":{ - "name":"resourceGroupName", - "description":"Name of the Azure Resource Group that migrate project is part of.", - "type":"string", - "in":"path", - "x-ms-parameter-location":"method", - "required":true - }, - "migrateProjectName":{ - "name":"migrateProjectName", - "description":"Name of the Azure Migrate project.", - "type":"string", - "in":"path", - "x-ms-parameter-location":"method", - "required":true - }, - "machineName":{ - "name":"machineName", - "description":"Unique name of a machine in Azure migration hub.", - "type":"string", - "in":"path", - "x-ms-parameter-location":"method", - "required":true - }, - "solutionName":{ - "name":"solutionName", - "description":"Unique name of a migration solution within a migrate project.", - "type":"string", - "in":"path", - "x-ms-parameter-location":"method", - "required":true - }, - "errorName":{ - "name":"errorName", - "description":"Unique name of an error within a migrate project.", - "type":"string", - "in":"path", - "x-ms-parameter-location":"method", - "required":true - }, - "continuationToken":{ - "name":"continuationToken", - "description":"The continuation token.", - "type":"string", - "in":"query", - "required":false, - "x-ms-parameter-location":"method" - }, - "api-version":{ - "name":"api-version", - "description":"Standard request header. Used by service to identify API version used by client.", - "type":"string", - "in":"query", - "required":true, - "enum":[ - "2018-09-01-preview" - ] - }, - "acceptLanguage":{ - "description":"Standard request header. Used by service to respond to client in appropriate language.", - "name":"Accept-Language", - "type":"string", - "in":"header", - "x-ms-parameter-location":"client" - } - }, - "securityDefinitions":{ - "azure_auth":{ - "type":"oauth2", - "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", - "flow":"implicit", - "description":"Azure Active Directory OAuth2 Flow", - "scopes":{ - "user_impersonation":"impersonate your user account" - } - } - }, - "security":[ - { - "azure_auth":[ - "user_impersonation" - ] - } - ], - "paths":{ - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/MigrateErrors":{ - "get":{ - "tags":[ - "Errors" - ], - "summary":"Gets a list of errors in the migrate project.", - "operationId":"Errors_EnumerateErrors", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/continuationToken" - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/ErrorCollection" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateErrors_List":{ - "$ref":"./examples/MigrateErrors_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/MigrateErrors/{errorName}":{ - "get":{ - "tags":[ - "Errors" - ], - "summary":"Gets an error in the migrate project.", - "operationId":"Errors_GetError", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/errorName" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/Error" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateErrors_Get":{ - "$ref":"./examples/MigrateErrors_Get.json" - } - } - }, - "delete":{ - "tags":[ - "Errors" - ], - "summary":"Delete the migrate error", - "description":"Delete the migrate error. Deleting non-existent migrate error is a no-operation.", - "operationId":"Errors_DeleteError", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/errorName" - } - ], - "responses":{ - "200":{ - "description":"OK" - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateErrors_Delete":{ - "$ref":"./examples/MigrateErrors_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Machines":{ - "get":{ - "tags":[ - "Machines" - ], - "summary":"Gets a list of machines in the migrate project.", - "operationId":"Machines_EnumerateMachines", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/continuationToken" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/MachineCollection" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Machines_List":{ - "$ref":"./examples/Machines_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Machines/{machineName}":{ - "get":{ - "tags":[ - "Machines" - ], - "summary":"Gets a machine in the migrate project.", - "operationId":"Machines_GetMachine", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/machineName" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/Machine" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Machines_Get":{ - "$ref":"./examples/Machines_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}":{ - "get":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Method to get a migrate project.", - "operationId":"MigrateProjects_GetMigrateProject", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_Get":{ - "$ref":"./examples/MigrateProjects_Get.json" - } - } - }, - "put":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Method to create or update a migrate project.", - "operationId":"MigrateProjects_PutMigrateProject", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "name":"body", - "in":"body", - "description":"Body with migrate project details.", - "required":true, - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - }, - "201":{ - "description":"Created", - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_Put":{ - "$ref":"./examples/MigrateProjects_Put.json" - } - } - }, - "patch":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Update migrate project.", - "description":"Update a migrate project with specified name. Supports partial updates, for example only tags can be provided.", - "operationId":"MigrateProjects_PatchMigrateProject", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "name":"body", - "in":"body", - "description":"Body with migrate project details.", - "required":true, - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/MigrateProject" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_Patch":{ - "$ref":"./examples/MigrateProjects_Patch.json" - } - } - }, - "delete":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Delete the migrate project", - "description":"Delete the migrate project. Deleting non-existent project is a no-operation.", - "operationId":"MigrateProjects_DeleteMigrateProject", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK" - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_Delete":{ - "$ref":"./examples/MigrateProjects_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/registerTool":{ - "post":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Registers a tool with the migrate project.", - "operationId":"MigrateProjects_RegisterTool", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "name":"input", - "in":"body", - "description":"Input containing the name of the tool to be registered.", - "required":true, - "schema":{ - "$ref":"#/definitions/RegisterToolInput" - } - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/RegistrationResult" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_RegisterTool":{ - "$ref":"./examples/MigrateProjects_RegisterTool.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/refreshSummary":{ - "post":{ - "tags":[ - "MigrateProjects" - ], - "summary":"Refresh the summary of the migrate project.", - "operationId":"MigrateProjects_RefreshMigrateProjectSummary", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/RefreshSummaryResult" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "MigrateProjects_RefreshSummary":{ - "$ref":"./examples/MigrateProjects_RefreshSummary.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions/{solutionName}":{ - "get":{ - "tags":[ - "Solutions" - ], - "summary":"Gets a solution in the migrate project.", - "operationId":"Solutions_GetSolution", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/solutionName" - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/Solution" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_Get":{ - "$ref":"./examples/Solutions_Get.json" - } - } - }, - "put":{ - "tags":[ - "Solutions" - ], - "summary":"Creates a solution in the migrate project.", - "operationId":"Solutions_PutSolution", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/solutionName" - }, - { - "name":"solutionInput", - "in":"body", - "description":"The input for the solution.", - "required":true, - "schema":{ - "$ref":"#/definitions/Solution" - } - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/Solution" - } - }, - "201":{ - "description":"Created", - "schema":{ - "$ref":"#/definitions/Solution" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_Put":{ - "$ref":"./examples/Solutions_Put.json" - } - } - }, - "patch":{ - "tags":[ - "Solutions" - ], - "summary":"Update solution.", - "description":"Update a solution with specified name. Supports partial updates, for example only tags can be provided.", - "operationId":"Solutions_PatchSolution", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/solutionName" - }, - { - "name":"solutionInput", - "in":"body", - "description":"The input for the solution.", - "required":true, - "schema":{ - "$ref":"#/definitions/Solution" - } - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/Solution" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_Patch":{ - "$ref":"./examples/Solutions_Patch.json" - } - } - }, - "delete":{ - "tags":[ - "Solutions" - ], - "summary":"Delete the solution", - "description":"Delete the solution. Deleting non-existent project is a no-operation.", - "operationId":"Solutions_DeleteSolution", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/solutionName" - }, - { - "$ref":"#/parameters/api-version" - }, - { - "$ref":"#/parameters/acceptLanguage" - } - ], - "responses":{ - "200":{ - "description":"OK" - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_Delete":{ - "$ref":"./examples/Solutions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions":{ - "get":{ - "tags":[ - "Solutions" - ], - "summary":"Gets the list of solutions in the migrate project.", - "operationId":"Solutions_EnumerateSolutions", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/SolutionsCollection" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_List":{ - "$ref":"./examples/Solutions_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/MigrateProjects/{migrateProjectName}/Solutions/{solutionName}/getConfig":{ - "post":{ - "tags":[ - "Solutions" - ], - "summary":"Gets the config for the solution in the migrate project.", - "operationId":"Solutions_GetConfig", - "parameters":[ - { - "$ref":"#/parameters/subscriptionId" - }, - { - "$ref":"#/parameters/resourceGroupName" - }, - { - "$ref":"#/parameters/migrateProjectName" - }, - { - "$ref":"#/parameters/solutionName" - }, - { - "$ref":"#/parameters/api-version" - } - ], - "responses":{ - "200":{ - "description":"OK", - "schema":{ - "$ref":"#/definitions/SolutionConfig" - } - } - }, - "deprecated":false, - "x-ms-examples":{ - "Solutions_GetConfig":{ - "$ref":"./examples/Solutions_GetConfig.json" - } - } - } - }, - "/providers/Microsoft.Migrate/operations":{ - "get":{ - "summary":"Get list of operations supported in the API.", - "description":"Get a list of REST API supported by Microsoft.Migrate provider.", - "operationId":"Operations_List", - "responses":{ - "200":{ - "description":"OK. Returns list of operations.", - "schema":{ - "$ref":"#/definitions/OperationResultList" - } - } - }, - "x-ms-pageable":{ - "nextLinkName":null - }, - "x-ms-examples":{ - "Operations_List":{ - "$ref":"./examples/Operations_List.json" - } - } - } - } - }, - "definitions":{ - "Object":{ - "type":"object", - "properties":{ - - } - }, - "ErrorCollection":{ - "description":"Collection of errors.", - "type":"object", - "properties":{ - "value":{ - "description":"Gets or sets the machines.", - "type":"array", - "items":{ - "$ref":"#/definitions/Error" - } - }, - "nextLink":{ - "description":"Gets or sets the value of nextLink.", - "type":"string" - } - } - }, - "Error":{ - "description":"Error REST resource.", - "type":"object", - "properties":{ - "id":{ - "description":"Gets or sets the relative URL to get to this REST resource.", - "type":"string" - }, - "name":{ - "description":"Gets or sets the name of this REST resource.", - "type":"string" - }, - "type":{ - "description":"Gets the type of this REST resource.", - "type":"string", - "readOnly":true - }, - "properties":{ - "$ref":"#/definitions/ErrorProperties", - "description":"Gets or sets the properties of the error." - } - } - }, - "ErrorProperties":{ - "description":"Properties of the error resource.", - "type":"object", - "properties":{ - "errorCode":{ - "description":"Gets or sets the error code.", - "type":"string" - }, - "errorMessage":{ - "description":"Gets or sets the error message.", - "type":"string" - }, - "recommendation":{ - "description":"Gets or sets the recommendation for the error.", - "type":"string" - }, - "possibleCauses":{ - "description":"Gets or sets the possible causes for the error.", - "type":"string" - }, - "solution":{ - "description":"Gets or sets the solution for which the error is being reported.", - "type":"string" - }, - "machine":{ - "description":"Gets or sets the machine for which the error is being reported.", - "type":"string" - } - } - }, - "ODataQueryOptions`1":{ - "type":"object", - "properties":{ - "ifMatch":{ - "$ref":"#/definitions/Object", - "readOnly":true - }, - "ifNoneMatch":{ - "$ref":"#/definitions/Object", - "readOnly":true - }, - "request":{ - "$ref":"#/definitions/Object", - "readOnly":true - }, - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "rawValues":{ - "$ref":"#/definitions/ODataRawQueryOptions", - "readOnly":true - }, - "selectExpand":{ - "$ref":"#/definitions/SelectExpandQueryOption", - "readOnly":true - }, - "apply":{ - "$ref":"#/definitions/ApplyQueryOption", - "readOnly":true - }, - "filter":{ - "$ref":"#/definitions/FilterQueryOption", - "readOnly":true - }, - "orderBy":{ - "$ref":"#/definitions/OrderByQueryOption", - "readOnly":true - }, - "skip":{ - "$ref":"#/definitions/SkipQueryOption", - "readOnly":true - }, - "top":{ - "$ref":"#/definitions/TopQueryOption", - "readOnly":true - }, - "count":{ - "$ref":"#/definitions/CountQueryOption", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/ODataQueryValidator" - } - } - }, - "ODataQueryContext":{ - "type":"object", - "properties":{ - "defaultQuerySettings":{ - "$ref":"#/definitions/DefaultQuerySettings", - "readOnly":true - }, - "model":{ - "$ref":"#/definitions/IEdmModel", - "readOnly":true - }, - "elementType":{ - "$ref":"#/definitions/IEdmType", - "readOnly":true - }, - "navigationSource":{ - "$ref":"#/definitions/IEdmNavigationSource", - "readOnly":true - }, - "elementClrType":{ - "type":"string", - "readOnly":true - }, - "path":{ - "$ref":"#/definitions/ODataPath", - "readOnly":true - }, - "requestContainer":{ - "$ref":"#/definitions/IServiceProvider", - "readOnly":true - } - } - }, - "ODataRawQueryOptions":{ - "type":"object", - "properties":{ - "filter":{ - "type":"string", - "readOnly":true - }, - "apply":{ - "type":"string", - "readOnly":true - }, - "orderBy":{ - "type":"string", - "readOnly":true - }, - "top":{ - "type":"string", - "readOnly":true - }, - "skip":{ - "type":"string", - "readOnly":true - }, - "select":{ - "type":"string", - "readOnly":true - }, - "expand":{ - "type":"string", - "readOnly":true - }, - "count":{ - "type":"string", - "readOnly":true - }, - "format":{ - "type":"string", - "readOnly":true - }, - "skipToken":{ - "type":"string", - "readOnly":true - }, - "deltaToken":{ - "type":"string", - "readOnly":true - } - } - }, - "SelectExpandQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "rawSelect":{ - "type":"string", - "readOnly":true - }, - "rawExpand":{ - "type":"string", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/SelectExpandQueryValidator" - }, - "selectExpandClause":{ - "$ref":"#/definitions/SelectExpandClause", - "readOnly":true - }, - "levelsMaxLiteralExpansionDepth":{ - "format":"int32", - "type":"integer" - } - } - }, - "ApplyQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "resultClrType":{ - "type":"string", - "readOnly":true - }, - "applyClause":{ - "$ref":"#/definitions/ApplyClause", - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - } - } - }, - "FilterQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/FilterQueryValidator" - }, - "filterClause":{ - "$ref":"#/definitions/FilterClause", - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - } - } - }, - "OrderByQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "orderByNodes":{ - "type":"array", - "items":{ - "$ref":"#/definitions/OrderByNode" - }, - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/OrderByQueryValidator" - }, - "orderByClause":{ - "$ref":"#/definitions/OrderByClause", - "readOnly":true - } - } - }, - "SkipQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - }, - "value":{ - "format":"int32", - "type":"integer", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/SkipQueryValidator" - } - } - }, - "TopQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - }, - "value":{ - "format":"int32", - "type":"integer", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/TopQueryValidator" - } - } - }, - "CountQueryOption":{ - "type":"object", - "properties":{ - "context":{ - "$ref":"#/definitions/ODataQueryContext", - "readOnly":true - }, - "rawValue":{ - "type":"string", - "readOnly":true - }, - "value":{ - "type":"boolean", - "readOnly":true - }, - "validator":{ - "$ref":"#/definitions/CountQueryValidator" - } - } - }, - "ODataQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "DefaultQuerySettings":{ - "type":"object", - "properties":{ - "enableExpand":{ - "type":"boolean" - }, - "enableSelect":{ - "type":"boolean" - }, - "enableCount":{ - "type":"boolean" - }, - "enableOrderBy":{ - "type":"boolean" - }, - "enableFilter":{ - "type":"boolean" - }, - "maxTop":{ - "format":"int32", - "type":"integer" - } - } - }, - "IEdmModel":{ - "type":"object", - "properties":{ - "schemaElements":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmSchemaElement" - }, - "readOnly":true - }, - "vocabularyAnnotations":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmVocabularyAnnotation" - }, - "readOnly":true - }, - "referencedModels":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmModel" - }, - "readOnly":true - }, - "declaredNamespaces":{ - "type":"array", - "items":{ - "type":"string" - }, - "readOnly":true - }, - "directValueAnnotationsManager":{ - "$ref":"#/definitions/IEdmDirectValueAnnotationsManager", - "readOnly":true - }, - "entityContainer":{ - "$ref":"#/definitions/IEdmEntityContainer", - "readOnly":true - } - } - }, - "IEdmType":{ - "type":"object", - "properties":{ - "typeKind":{ - "enum":[ - "None", - "Primitive", - "Entity", - "Complex", - "Collection", - "EntityReference", - "Enum", - "TypeDefinition", - "Untyped", - "Path" - ], - "type":"string", - "readOnly":true - } - } - }, - "IEdmNavigationSource":{ - "type":"object", - "properties":{ - "navigationPropertyBindings":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmNavigationPropertyBinding" - }, - "readOnly":true - }, - "path":{ - "$ref":"#/definitions/IEdmPathExpression", - "readOnly":true - }, - "type":{ - "$ref":"#/definitions/IEdmType", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "ODataPath":{ - "type":"object", - "properties":{ - "edmType":{ - "$ref":"#/definitions/IEdmType", - "readOnly":true - }, - "navigationSource":{ - "$ref":"#/definitions/IEdmNavigationSource", - "readOnly":true - }, - "segments":{ - "type":"array", - "items":{ - "$ref":"#/definitions/ODataPathSegment" - }, - "readOnly":true - }, - "pathTemplate":{ - "type":"string", - "readOnly":true - }, - "path":{ - "type":"array", - "items":{ - "$ref":"#/definitions/ODataPathSegment" - }, - "readOnly":true - } - } - }, - "IServiceProvider":{ - "type":"object", - "properties":{ - - } - }, - "SelectExpandQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "SelectExpandClause":{ - "type":"object", - "properties":{ - "selectedItems":{ - "type":"array", - "items":{ - "$ref":"#/definitions/SelectItem" - }, - "readOnly":true - }, - "allSelected":{ - "type":"boolean", - "readOnly":true - } - } - }, - "ApplyClause":{ - "type":"object", - "properties":{ - "transformations":{ - "type":"array", - "items":{ - "$ref":"#/definitions/TransformationNode" - }, - "readOnly":true - } - } - }, - "FilterQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "FilterClause":{ - "type":"object", - "properties":{ - "expression":{ - "$ref":"#/definitions/SingleValueNode", - "readOnly":true - }, - "rangeVariable":{ - "$ref":"#/definitions/RangeVariable", - "readOnly":true - }, - "itemType":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - } - } - }, - "OrderByNode":{ - "type":"object", - "properties":{ - "direction":{ - "enum":[ - "Ascending", - "Descending" - ], - "type":"string", - "readOnly":true - } - } - }, - "OrderByQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "OrderByClause":{ - "type":"object", - "properties":{ - "thenBy":{ - "$ref":"#/definitions/OrderByClause", - "readOnly":true - }, - "expression":{ - "$ref":"#/definitions/SingleValueNode", - "readOnly":true - }, - "direction":{ - "enum":[ - "Ascending", - "Descending" - ], - "type":"string", - "readOnly":true - }, - "rangeVariable":{ - "$ref":"#/definitions/RangeVariable", - "readOnly":true - }, - "itemType":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - } - } - }, - "SkipQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "TopQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "CountQueryValidator":{ - "type":"object", - "properties":{ - - } - }, - "IEdmSchemaElement":{ - "type":"object", - "properties":{ - "schemaElementKind":{ - "enum":[ - "None", - "TypeDefinition", - "Term", - "Action", - "EntityContainer", - "Function" - ], - "type":"string", - "readOnly":true - }, - "namespace":{ - "type":"string", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmVocabularyAnnotation":{ - "type":"object", - "properties":{ - "qualifier":{ - "type":"string", - "readOnly":true - }, - "term":{ - "$ref":"#/definitions/IEdmTerm", - "readOnly":true - }, - "target":{ - "$ref":"#/definitions/IEdmVocabularyAnnotatable", - "readOnly":true - }, - "value":{ - "$ref":"#/definitions/IEdmExpression", - "readOnly":true - } - } - }, - "IEdmDirectValueAnnotationsManager":{ - "type":"object", - "properties":{ - - } - }, - "IEdmEntityContainer":{ - "type":"object", - "properties":{ - "elements":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmEntityContainerElement" - }, - "readOnly":true - }, - "schemaElementKind":{ - "enum":[ - "None", - "TypeDefinition", - "Term", - "Action", - "EntityContainer", - "Function" - ], - "type":"string", - "readOnly":true - }, - "namespace":{ - "type":"string", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmNavigationPropertyBinding":{ - "type":"object", - "properties":{ - "navigationProperty":{ - "$ref":"#/definitions/IEdmNavigationProperty", - "readOnly":true - }, - "target":{ - "$ref":"#/definitions/IEdmNavigationSource", - "readOnly":true - }, - "path":{ - "$ref":"#/definitions/IEdmPathExpression", - "readOnly":true - } - } - }, - "IEdmPathExpression":{ - "type":"object", - "properties":{ - "pathSegments":{ - "type":"array", - "items":{ - "type":"string" - }, - "readOnly":true - }, - "path":{ - "type":"string", - "readOnly":true - }, - "expressionKind":{ - "enum":[ - "None", - "BinaryConstant", - "BooleanConstant", - "DateTimeOffsetConstant", - "DecimalConstant", - "FloatingConstant", - "GuidConstant", - "IntegerConstant", - "StringConstant", - "DurationConstant", - "Null", - "Record", - "Collection", - "Path", - "If", - "Cast", - "IsType", - "FunctionApplication", - "LabeledExpressionReference", - "Labeled", - "PropertyPath", - "NavigationPropertyPath", - "DateConstant", - "TimeOfDayConstant", - "EnumMember", - "AnnotationPath" - ], - "type":"string", - "readOnly":true - } - } - }, - "ODataPathSegment":{ - "type":"object", - "properties":{ - "edmType":{ - "$ref":"#/definitions/IEdmType", - "readOnly":true - }, - "identifier":{ - "type":"string" - } - } - }, - "SelectItem":{ - "type":"object", - "properties":{ - - } - }, - "TransformationNode":{ - "type":"object", - "properties":{ - "kind":{ - "enum":[ - "Aggregate", - "GroupBy", - "Filter", - "Compute" - ], - "type":"string", - "readOnly":true - } - } - }, - "SingleValueNode":{ - "type":"object", - "properties":{ - "typeReference":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "kind":{ - "enum":[ - "None", - "Constant", - "Convert", - "NonResourceRangeVariableReference", - "BinaryOperator", - "UnaryOperator", - "SingleValuePropertyAccess", - "CollectionPropertyAccess", - "SingleValueFunctionCall", - "Any", - "CollectionNavigationNode", - "SingleNavigationNode", - "SingleValueOpenPropertyAccess", - "SingleResourceCast", - "All", - "CollectionResourceCast", - "ResourceRangeVariableReference", - "SingleResourceFunctionCall", - "CollectionFunctionCall", - "CollectionResourceFunctionCall", - "NamedFunctionParameter", - "ParameterAlias", - "EntitySet", - "KeyLookup", - "SearchTerm", - "CollectionOpenPropertyAccess", - "CollectionComplexNode", - "SingleComplexNode", - "Count", - "SingleValueCast", - "CollectionPropertyNode", - "AggregatedCollectionPropertyNode", - "In", - "CollectionConstant" - ], - "type":"string", - "readOnly":true - } - } - }, - "RangeVariable":{ - "type":"object", - "properties":{ - "name":{ - "type":"string", - "readOnly":true - }, - "typeReference":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "kind":{ - "format":"int32", - "type":"integer", - "readOnly":true - } - } - }, - "IEdmTypeReference":{ - "type":"object", - "properties":{ - "isNullable":{ - "type":"boolean", - "readOnly":true - }, - "definition":{ - "$ref":"#/definitions/IEdmType", - "readOnly":true - } - } - }, - "IEdmTerm":{ - "type":"object", - "properties":{ - "type":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "appliesTo":{ - "type":"string", - "readOnly":true - }, - "defaultValue":{ - "type":"string", - "readOnly":true - }, - "schemaElementKind":{ - "enum":[ - "None", - "TypeDefinition", - "Term", - "Action", - "EntityContainer", - "Function" - ], - "type":"string", - "readOnly":true - }, - "namespace":{ - "type":"string", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmVocabularyAnnotatable":{ - "type":"object", - "properties":{ - - } - }, - "IEdmExpression":{ - "type":"object", - "properties":{ - "expressionKind":{ - "enum":[ - "None", - "BinaryConstant", - "BooleanConstant", - "DateTimeOffsetConstant", - "DecimalConstant", - "FloatingConstant", - "GuidConstant", - "IntegerConstant", - "StringConstant", - "DurationConstant", - "Null", - "Record", - "Collection", - "Path", - "If", - "Cast", - "IsType", - "FunctionApplication", - "LabeledExpressionReference", - "Labeled", - "PropertyPath", - "NavigationPropertyPath", - "DateConstant", - "TimeOfDayConstant", - "EnumMember", - "AnnotationPath" - ], - "type":"string", - "readOnly":true - } - } - }, - "IEdmEntityContainerElement":{ - "type":"object", - "properties":{ - "containerElementKind":{ - "enum":[ - "None", - "EntitySet", - "ActionImport", - "FunctionImport", - "Singleton" - ], - "type":"string", - "readOnly":true - }, - "container":{ - "$ref":"#/definitions/IEdmEntityContainer", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmNavigationProperty":{ - "type":"object", - "properties":{ - "partner":{ - "$ref":"#/definitions/IEdmNavigationProperty", - "readOnly":true - }, - "onDelete":{ - "enum":[ - "None", - "Cascade" - ], - "type":"string", - "readOnly":true - }, - "containsTarget":{ - "type":"boolean", - "readOnly":true - }, - "referentialConstraint":{ - "$ref":"#/definitions/IEdmReferentialConstraint", - "readOnly":true - }, - "propertyKind":{ - "enum":[ - "None", - "Structural", - "Navigation" - ], - "type":"string", - "readOnly":true - }, - "type":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "declaringType":{ - "$ref":"#/definitions/IEdmStructuredType", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmReferentialConstraint":{ - "type":"object", - "properties":{ - "propertyPairs":{ - "type":"array", - "items":{ - "$ref":"#/definitions/EdmReferentialConstraintPropertyPair" - }, - "readOnly":true - } - } - }, - "IEdmStructuredType":{ - "type":"object", - "properties":{ - "isAbstract":{ - "type":"boolean", - "readOnly":true - }, - "isOpen":{ - "type":"boolean", - "readOnly":true - }, - "baseType":{ - "$ref":"#/definitions/IEdmStructuredType", - "readOnly":true - }, - "declaredProperties":{ - "type":"array", - "items":{ - "$ref":"#/definitions/IEdmProperty" - }, - "readOnly":true - }, - "typeKind":{ - "enum":[ - "None", - "Primitive", - "Entity", - "Complex", - "Collection", - "EntityReference", - "Enum", - "TypeDefinition", - "Untyped", - "Path" - ], - "type":"string", - "readOnly":true - } - } - }, - "EdmReferentialConstraintPropertyPair":{ - "type":"object", - "properties":{ - "dependentProperty":{ - "$ref":"#/definitions/IEdmStructuralProperty", - "readOnly":true - }, - "principalProperty":{ - "$ref":"#/definitions/IEdmStructuralProperty", - "readOnly":true - } - } - }, - "IEdmProperty":{ - "type":"object", - "properties":{ - "propertyKind":{ - "enum":[ - "None", - "Structural", - "Navigation" - ], - "type":"string", - "readOnly":true - }, - "type":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "declaringType":{ - "$ref":"#/definitions/IEdmStructuredType", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "IEdmStructuralProperty":{ - "type":"object", - "properties":{ - "defaultValueString":{ - "type":"string", - "readOnly":true - }, - "propertyKind":{ - "enum":[ - "None", - "Structural", - "Navigation" - ], - "type":"string", - "readOnly":true - }, - "type":{ - "$ref":"#/definitions/IEdmTypeReference", - "readOnly":true - }, - "declaringType":{ - "$ref":"#/definitions/IEdmStructuredType", - "readOnly":true - }, - "name":{ - "type":"string", - "readOnly":true - } - } - }, - "MachineCollection":{ - "description":"Collection of machines.", - "type":"object", - "properties":{ - "value":{ - "description":"Gets or sets the machines.", - "type":"array", - "items":{ - "$ref":"#/definitions/Machine" - } - }, - "nextLink":{ - "description":"Gets or sets the value of nextLink.", - "type":"string" - } - } - }, - "Machine":{ - "description":"Machine REST resource.", - "type":"object", - "properties":{ - "id":{ - "description":"Gets or sets the relative URL to get to this REST resource.", - "type":"string" - }, - "name":{ - "description":"Gets or sets the name of this REST resource.", - "type":"string" - }, - "type":{ - "description":"Gets the type of this REST resource.", - "type":"string", - "readOnly":true - }, - "properties":{ - "$ref":"#/definitions/MachineProperties", - "description":"Gets or sets the properties of the machine." - } - } - }, - "MachineProperties":{ - "description":"Properties of the machine resource.", - "type":"object", - "properties":{ - "discoveryData":{ - "description":"Gets or sets the discovery details of the machine published by various sources.", - "type":"array", - "items":{ - "$ref":"#/definitions/DiscoveryDetails" - } - }, - "assessmentData":{ - "description":"Gets or sets the assessment details of the machine published by various sources.", - "type":"array", - "items":{ - "$ref":"#/definitions/AssessmentDetails" - } - }, - "migrationData":{ - "description":"Gets or sets the migration details of the machine published by various sources.", - "type":"array", - "items":{ - "$ref":"#/definitions/MigrationDetails" - } - } - } - }, - "DiscoveryDetails":{ - "description":"Discovery properties that can be published by various ISVs.", - "type":"object", - "properties":{ - "osType":{ - "description":"Gets or sets the OS type.", - "type":"string" - }, - "osName":{ - "description":"Gets or sets the OS name.", - "type":"string" - }, - "osVersion":{ - "description":"Gets or sets the OS version.", - "type":"string" - }, - "enqueueTime":{ - "description":"Gets or sets the time the message was enqueued.", - "type":"string" - }, - "solutionName":{ - "description":"Gets or sets the name of the solution that sent the data.", - "type":"string" - }, - "machineId":{ - "description":"Gets or sets the unique identifier of the machine.", - "type":"string" - }, - "machineManagerId":{ - "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", - "type":"string" - }, - "machineName":{ - "description":"Gets or sets the name of the machine.", - "type":"string" - }, - "extendedInfo":{ - "description":"Gets or sets the ISV specific extended information.", - "type":"object", - "additionalProperties":{ - "type":"string" - } - } - } - }, - "AssessmentDetails":{ - "description":"Assessment properties that can be shared by various publishers.", - "type":"object", - "properties":{ - "assessmentId":{ - "description":"Gets or sets the id of the assessment done on the machine.", - "type":"string" - }, - "targetVMSize":{ - "description":"Gets or sets the target VM size.", - "type":"string" - }, - "targetVMLocation":{ - "description":"Gets or sets the target VM location.", - "type":"string" - }, - "targetStorageType":{ - "description":"Gets or sets the target storage type.", - "type":"object", - "additionalProperties":{ - "type":"string" - } - }, - "enqueueTime":{ - "description":"Gets or sets the time the message was enqueued.", - "type":"string" - }, - "solutionName":{ - "description":"Gets or sets the name of the solution that sent the data.", - "type":"string" - }, - "machineId":{ - "description":"Gets or sets the unique identifier of the machine.", - "type":"string" - }, - "machineManagerId":{ - "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", - "type":"string" - }, - "machineName":{ - "description":"Gets or sets the name of the machine.", - "type":"string" - }, - "extendedInfo":{ - "description":"Gets or sets the ISV specific extended information.", - "type":"object", - "additionalProperties":{ - "type":"string" - } - } - } - }, - "MigrationDetails":{ - "description":"Migration properties that can be shared by various publishers.", - "type":"object", - "properties":{ - "migrationPhase":{ - "description":"Gets or sets the phase of migration of the machine.", - "type":"string" - }, - "migrationTested":{ - "description":"Gets or sets a value indicating whether migration was tested on the machine.", - "type":"boolean" - }, - "replicationProgressPercentage":{ - "format":"int32", - "description":"Gets or sets the progress percentage of migration on the machine.", - "type":"integer" - }, - "targetVMArmId":{ - "description":"Gets or sets the ARM id the migrated VM.", - "type":"string" - }, - "enqueueTime":{ - "description":"Gets or sets the time the message was enqueued.", - "type":"string" - }, - "solutionName":{ - "description":"Gets or sets the name of the solution that sent the data.", - "type":"string" - }, - "machineId":{ - "description":"Gets or sets the unique identifier of the machine.", - "type":"string" - }, - "machineManagerId":{ - "description":"Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM).", - "type":"string" - }, - "machineName":{ - "description":"Gets or sets the name of the machine.", - "type":"string" - }, - "extendedInfo":{ - "description":"Gets or sets the ISV specific extended information.", - "type":"object", - "additionalProperties":{ - "type":"string" - } - } - } - }, - "MigrateProject":{ - "description":"Migrate Project REST Resource.", - "type":"object", - "x-ms-azure-resource":true, - "properties":{ - "eTag":{ - "description":"Gets or sets the eTag for concurrency control.", - "type":"string" - }, - "location":{ - "description":"Gets or sets the Azure location in which migrate project is created.", - "type":"string" - }, - "properties":{ - "$ref":"#/definitions/MigrateProjectProperties", - "description":"Gets or sets the nested properties." - }, - "id":{ - "description":"Gets the relative URL to get this migrate project.", - "type":"string", - "readOnly":true - }, - "name":{ - "description":"Gets or sets the name of the migrate project.", - "type":"string", - "readOnly":true - }, - "type":{ - "description":"Handled by resource provider. Type = Microsoft.Migrate/MigrateProject.", - "type":"string", - "readOnly":true - } - } - }, - "MigrateProjectProperties":{ - "description":"Class for migrate project properties.", - "type":"object", - "properties":{ - "registeredTools":{ - "description":"Gets or sets the list of tools registered with the migrate project.", - "type":"array", - "items":{ - "type":"string" - } - }, - "summary":{ - "description":"Gets or sets the goals summary of the migrate Project. \r\n It maps the goal to its summary object.", - "type":"object", - "additionalProperties":{ - "$ref":"#/definitions/GoalSummary" - } - } - } - }, - "GoalSummary":{ - "description":"Class representing the summary object for goal.", - "type":"object", - "properties":{ - "discoveredCount":{ - "format":"int32", - "description":"Gets or sets the count of entities discovered.", - "type":"integer" - }, - "assessedCount":{ - "format":"int32", - "description":"Gets or sets the count of entities assessed.", - "type":"integer" - }, - "replicatingCount":{ - "format":"int32", - "description":"Gets or sets the count of entities being replicated.", - "type":"integer" - }, - "migratedCount":{ - "format":"int32", - "description":"Gets or sets the count of entities migrated.", - "type":"integer" - } - } - }, - "RegisterToolInput":{ - "description":"Class representing the register tool input.", - "type":"object", - "properties":{ - "tool":{ - "description":"Gets or sets the tool to be registered.", - "type":"string" - } - } - }, - "RegistrationResult":{ - "description":"Class representing the registration status of a tool with the migrate project.", - "type":"object", - "properties":{ - "isRegistered":{ - "description":"Gets or sets a value indicating whether the tool is registered or not.", - "type":"boolean" - } - } - }, - "RefreshSummaryResult":{ - "description":"Class representing the refresh summary status of the migrate project.", - "type":"object", - "properties":{ - "isRefreshed":{ - "description":"Gets or sets a value indicating whether the migrate project summary is refreshed.", - "type":"boolean" - } - } - }, - "Solution":{ - "description":"Solution REST Resource.", - "type":"object", - "x-ms-azure-resource":true, - "properties":{ - "id":{ - "description":"Gets or sets the relative URL to get to this REST resource.", - "type":"string", - "readOnly":true - }, - "name":{ - "description":"Gets or sets the name of this REST resource.", - "type":"string", - "readOnly":true - }, - "type":{ - "description":"Gets the type of this REST resource.", - "type":"string", - "readOnly":true - }, - "properties":{ - "$ref":"#/definitions/SolutionProperties", - "description":"Gets or sets the properties of the solution." - } - } - }, - "SolutionProperties":{ - "description":"Class for solution properties.", - "type":"object", - "properties":{ - "tool":{ - "description":"Gets or sets the tool being used in the solution.", - "type":"string" - }, - "purpose":{ - "description":"Gets or sets the purpose of the solution.", - "type":"string" - }, - "goal":{ - "description":"Gets or sets the goal of the solution.", - "type":"string" - }, - "isInactive":{ - "description":"Gets or sets a value indicating whether the solution is active or not.", - "type":"boolean" - }, - "summary":{ - "$ref":"#/definitions/SolutionSummary", - "description":"Gets or sets the summary of the solution." - }, - "details":{ - "$ref":"#/definitions/SolutionDetails", - "description":"Gets or sets the details of the solution." - } - } - }, - "SolutionSummary":{ - "description":"Class representing the summary object for solution.", - "type":"object", - "properties":{ - "discoveredCount":{ - "format":"int32", - "description":"Gets or sets the count of entities discovered.", - "type":"integer" - }, - "assessedCount":{ - "format":"int32", - "description":"Gets or sets the count of entities assessed.", - "type":"integer" - }, - "replicatingCount":{ - "format":"int32", - "description":"Gets or sets the count of entities being replicated.", - "type":"integer" - }, - "migratedCount":{ - "format":"int32", - "description":"Gets or sets the count of entities migrated.", - "type":"integer" - } - } - }, - "SolutionDetails":{ - "description":"Class representing the details of the solution.", - "type":"object", - "properties":{ - "groupCount":{ - "format":"int32", - "description":"Gets or sets the count of groups reported by the solution.", - "type":"integer" - }, - "assessmentCount":{ - "format":"int32", - "description":"Gets or sets the count of assessments reported by the solution.", - "type":"integer" - }, - "extendedDetails":{ - "description":"Gets or sets the extended details reported by the solution.", - "type":"object", - "additionalProperties":{ - "type":"string" - } - } - } - }, - "SolutionsCollection":{ - "description":"Collection of solutions.", - "type":"object", - "properties":{ - "value":{ - "description":"Gets or sets the list of solutions.", - "type":"array", - "items":{ - "$ref":"#/definitions/Solution" - } - }, - "nextLink":{ - "description":"Gets or sets the value of next link.", - "type":"string" - } - } - }, - "SolutionConfig":{ - "description":"Class representing the config for the solution in the migrate project.", - "type":"object", - "properties":{ - "publisherSasUri":{ - "description":"Gets or sets the publisher sas uri for the solution.", - "type":"string" - } - } - }, - "OperationResultList":{ - "type":"object", - "description":"List of API operations.", - "properties":{ - "value":{ - "type":"array", - "description":"List of operations.", - "items":{ - "$ref":"#/definitions/Operation" - } - } - } - }, - "Operation":{ - "type":"object", - "description":"A REST API operation supported by the provider.", - "properties":{ - "name":{ - "type":"string", - "description":"Name of the operation.", - "readOnly":true - }, - "display":{ - "description":"Displayable properties of the operation.", - "$ref":"#/definitions/OperationDisplay" - }, - "origin":{ - "type":"string", - "description":"Origin of the operation.", - "readOnly":true - } - } - }, - "OperationDisplay":{ - "type":"object", - "description":"Displayable properties of the operation.", - "readOnly":true, - "properties":{ - "provider":{ - "type":"string", - "description":"Provider of the operation.", - "readOnly":true - }, - "resource":{ - "type":"string", - "description":"Resource operated on by the operation.", - "readOnly":true - }, - "operation":{ - "type":"string", - "description":"Operation Type.", - "readOnly":true - }, - "description":{ - "type":"string", - "description":"Description of the operation.", - "readOnly":true - } - } - } - } -} \ No newline at end of file diff --git a/specification/migrateprojects/resource-manager/readme.md b/specification/migrateprojects/resource-manager/readme.md deleted file mode 100644 index 238f17ac9b91..000000000000 --- a/specification/migrateprojects/resource-manager/readme.md +++ /dev/null @@ -1,99 +0,0 @@ -# Azure Migrate - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for Azure Migrate. - ---- - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-09 -``` - -### Tag: package-2018-09 and java - -These settings apply only when `--tag=package-2018-09 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-09' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.azuremigrate.v2018_09_01 - output-folder: $(azure-libraries-for-java-folder)/azuremigrate/resource-manager/v2018_09_01 -regenerate-manager: true -generate-interface: true -``` - - -## Getting Started -To build the SDK for Migrate, 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 API. - -``` yaml -openapi-type: arm -tag: package-2018-09 -``` - - -### Tag: package-2018-09 - -These settings apply only when `--tag=package-2018-09` is specified on the command line. - -``` yaml $(tag) == 'package-2018-09' -input-file: -- Microsoft.Migrate/preview/2018-09-01-preview/migrate.json -``` - -# Code Generation - -## Swagger to SDK - -This section describes what SDK should be generated by the automatic system. -This is not used by Autorest itself. - -``` yaml $(swagger-to-sdk) -swagger-to-sdk: - - repo: azure-sdk-for-go -``` - -## Go - -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - clear-output-folder: true - namespace: migrate -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2018-09 -``` - -### Tag: package-2018-09 and go - -These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag)=='package-2018-09' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01-preview/$(namespace) -``` diff --git a/specification/migrateprojects/resource-manager/readme.nodejs.md b/specification/migrateprojects/resource-manager/readme.nodejs.md deleted file mode 100644 index 659dab26dfe8..000000000000 --- a/specification/migrateprojects/resource-manager/readme.nodejs.md +++ /dev/null @@ -1,15 +0,0 @@ -## Node.js - -These settings apply only when `--nodejs` is specified on the command line. -Please also specify `--node-sdks-folder=`. - -``` yaml $(nodejs) -nodejs: - azure-arm: true - package-name: azure-arm-migrateprojects - package-version: 1.0.0-preview - output-folder: $(node-sdks-folder)/lib/services/migrateprojectsManagement - generate-license-txt: true - generate-package-json: true - generate-readme-md: true -``` From 7a2f5dc75b16941fccfe95e488248b865861c021 Mon Sep 17 00:00:00 2001 From: Daniel Qiu Date: Thu, 15 Nov 2018 13:40:59 -0800 Subject: [PATCH 141/464] Adds Geo Replication Stats in Azure Storage Account's properties (#4455) --- .../examples/StorageAccountGetProperties.json | 4 ++ .../stable/2018-07-01/storage.json | 47 ++++++++++++++++++- 2 files changed, 50 insertions(+), 1 deletion(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json index 5211dc5949db..4f5742ea9e54 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json @@ -14,6 +14,10 @@ "location": "eastus2(stage)", "name": "sto8596", "properties": { + "geoReplicationStats": { + "status": "Live", + "lastSyncTime": "2018-10-30T00:25:34Z" + }, "isHnsEnabled": true, "azureFilesAadIntegration": true, "creationTime": "2017-06-01T02:42:41.7633306Z", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json index a93156382337..6840123bcb4e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json @@ -223,6 +223,20 @@ }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within account's properties. By default, data is not included when fecthing properties. Currently we only support geoReplicationStats.", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "geoReplicationStats" + ], + "x-ms-enum": { + "name": "StorageAccountExpand", + "modelAsString": false + } } ], "responses": { @@ -1300,6 +1314,31 @@ }, "description": "The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object." }, + "GeoReplicationStats": { + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable.", + "enum": [ + "Live", + "Bootstrap", + "Unavailable" + ], + "x-ms-enum": { + "name": "GeoReplicationStatus", + "modelAsString": true + } + }, + "lastSyncTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap." + } + }, + "description": "Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account." + }, "StorageAccountProperties": { "properties": { "provisioningState": { @@ -1418,9 +1457,15 @@ "x-ms-client-name": "IsHnsEnabled", "description": "Account HierarchicalNamespace enabled if sets to true." }, + "geoReplicationStats": { + "$ref": "#/definitions/GeoReplicationStats", + "x-ms-client-name": "GeoReplicationStats", + "description": "Geo Replication Stats", + "readOnly": true + }, "failoverInProgress": { "type": "boolean", - "x-ms-client-name": "FailoverInProgress ", + "x-ms-client-name": "FailoverInProgress", "description": "If the failover is in progress, the value will be true, otherwise, it will be null.", "readOnly": true } From 45e82e67d42ee347edbdb8b15807473b5aaf3a06 Mon Sep 17 00:00:00 2001 From: refortie <37600290+refortie@users.noreply.github.com> Date: Thu, 15 Nov 2018 14:21:21 -0800 Subject: [PATCH 142/464] Add 2 missing endpoints to newest versions Microsoft.Logic (#4332) * Add missing endpoints to newest versions * Changing copy error of POST to GET. Added missing page links * Fix for top level properties errir * Adding CloudErrors to new endpoints * Rename CloudError to not a potentially reserved name and removed the x-ms-external flag * Use already existing error response object --- ...ActionRepetitionsRequestHistories_Get.json | 69 ++++ ...ctionRepetitionsRequestHistories_List.json | 72 ++++ ...WorkflowRunActionRequestHistories_Get.json | 68 +++ ...orkflowRunActionRequestHistories_List.json | 71 ++++ .../preview/2018-07-01-preview/logic.json | 387 ++++++++++++++++++ ...ActionRepetitionsRequestHistories_Get.json | 69 ++++ ...ctionRepetitionsRequestHistories_List.json | 72 ++++ ...WorkflowRunActionRequestHistories_Get.json | 68 +++ ...orkflowRunActionRequestHistories_List.json | 71 ++++ .../stable/2016-06-01/logic.json | 387 ++++++++++++++++++ 10 files changed, 1334 insertions(+) create mode 100644 specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_List.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_Get.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_List.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_Get.json create mode 100644 specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_List.json diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json new file mode 100644 index 000000000000..5b06c98ac5bf --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001", + "requestHistoryName": "08586611142732800686" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_List.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_List.json new file mode 100644 index 000000000000..72adfc688a82 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRepetitionsRequestHistories_List.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_Get.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_Get.json new file mode 100644 index 000000000000..a39cfc2daa86 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "requestHistoryName": "08586611142732800686" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_List.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_List.json new file mode 100644 index 000000000000..e2177e2559a4 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/WorkflowRunActionRequestHistories_List.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json index f17786cc5756..82ad4eabcd2c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json @@ -1993,6 +1993,296 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_List", + "description": "List a workflow run repetition request history.", + "x-ms-examples": { + "List repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_Get", + "description": "Gets a workflow run repetition request history.", + "x-ms-examples": { + "Get a repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "requestHistoryName", + "description": "The request history name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRequestHistories_List", + "description": "List a workflow run request history.", + "x-ms-examples": { + "List a request history": { + "$ref": "./examples/WorkflowRunActionRequestHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRequestHistories_Get", + "description": "Gets a workflow run request history.", + "x-ms-examples": { + "Get a request history": { + "$ref": "./examples/WorkflowRunActionRequestHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "requestHistoryName", + "description": "The request history name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": { "get": { "tags": [ @@ -9641,6 +9931,103 @@ "description": "The recurrence." } } + }, + "RequestHistoryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestHistory" + }, + "description": "A list of workflow request histories." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow request histories." + }, + "RequestHistory": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "properties": { + "$ref": "#/definitions/RequestHistoryProperties", + "description": "The request history properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "RequestHistoryProperties": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the request started." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the request ended." + }, + "request": { + "$ref": "#/definitions/Request", + "description": "The request." + }, + "response": { + "$ref": "#/definitions/Response", + "description": "The response." + } + } + }, + "Request": { + "type": "object", + "additionalProperties": false, + "description": "A request.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the request." + }, + "uri": { + "type": "string", + "description": "The destination for the request." + }, + "method": { + "type": "string", + "description": "The HTTP method used for the request." + } + } + }, + "Response": { + "type": "object", + "additionalProperties": false, + "description": "A response.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the response." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "description": "The status code of the response." + }, + "bodyLink": { + "$ref": "#/definitions/ContentLink", + "description": "Details on the location of the body content." + } + } } }, "parameters": { diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json new file mode 100644 index 000000000000..5b06c98ac5bf --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_Get.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001", + "requestHistoryName": "08586611142732800686" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json new file mode 100644 index 000000000000..72adfc688a82 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "repetitionName": "000001" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_Get.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_Get.json new file mode 100644 index 000000000000..a39cfc2daa86 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_Get.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook", + "requestHistoryName": "08586611142732800686" + }, + "responses": { + "200": { + "body": { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_List.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_List.json new file mode 100644 index 000000000000..e2177e2559a4 --- /dev/null +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/examples/WorkflowRunActionRequestHistories_List.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2018-07-01-preview", + "resourceGroupName": "test-resource-group", + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "workflowName": "test-workflow", + "runName": "08586776228332053161046300351", + "actionName": "HTTP_Webhook" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "startTime": "2018-10-25T18:36:51.9206732Z", + "endTime": "2018-10-25T18:36:52.1863033Z", + "request": { + "headers": { + "Accept-Language": "en-US", + "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)", + "x-ms-execution-location": "brazilsouth", + "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-version": "08586611142904036539", + "x-ms-workflow-name": "test-workflow", + "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56", + "x-ms-workflow-run-id": "08586611142736787787412824395CU21", + "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8", + "x-ms-workflow-operation-name": "HTTP_Webhook", + "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "x-ms-workflow-resourcegroup-name": "test-resource-group", + "x-ms-workflow-subscription-capacity": "Large", + "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256", + "x-ms-client-tracking-id": "08586611142736787787412824395CU21", + "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8" + }, + "uri": "http://tempuri.org", + "method": "GET" + }, + "response": { + "headers": { + "Cache-Control": "private", + "Date": "Thu, 25 Oct 2018 18:36:51 GMT", + "Location": "http://www.bing.com/", + "Server": "Microsoft-IIS/10.0", + "X-AspNet-Version": "4.0.30319", + "X-Powered-By": "ASP.NET" + }, + "statusCode": 302, + "bodyLink": { + "uri": "https://tempuri.org", + "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==", + "contentSize": 137, + "contentHash": { + "algorithm": "md5", + "value": "2LOOAR8Eh2pd7AvRHXUhRg==" + } + } + } + }, + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Logic/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686", + "name": "08586611142732800686", + "type": "Microsoft.Logic/workflows/runs/actions/requestHistories" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json index cdefcc99dbee..88be3b519f46 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/stable/2016-06-01/logic.json @@ -1993,6 +1993,296 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_List", + "description": "List a workflow run repetition request history.", + "x-ms-examples": { + "List repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRepetitionsRequestHistories_Get", + "description": "Gets a workflow run repetition request history.", + "x-ms-examples": { + "Get a repetition request history": { + "$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "repetitionName", + "description": "The workflow repetition.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "requestHistoryName", + "description": "The request history name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRequestHistories_List", + "description": "List a workflow run request history.", + "x-ms-examples": { + "List a request history": { + "$ref": "./examples/WorkflowRunActionRequestHistories_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistoryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}": { + "get": { + "tags": [ + "WorkflowRunActions" + ], + "operationId": "WorkflowRunActionRequestHistories_Get", + "description": "Gets a workflow run request history.", + "x-ms-examples": { + "Get a request history": { + "$ref": "./examples/WorkflowRunActionRequestHistories_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "The resource group name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "workflowName", + "description": "The workflow name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "runName", + "description": "The workflow run name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "actionName", + "description": "The workflow action name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "requestHistoryName", + "description": "The request history name.", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RequestHistory" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": { "get": { "tags": [ @@ -9686,6 +9976,103 @@ "description": "The recurrence." } } + }, + "RequestHistoryListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RequestHistory" + }, + "description": "A list of workflow request histories." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The list of workflow request histories." + }, + "RequestHistory": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "properties": { + "$ref": "#/definitions/RequestHistoryProperties", + "description": "The request history properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "RequestHistoryProperties": { + "type": "object", + "additionalProperties": false, + "description": "The request history.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time the request started." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The time the request ended." + }, + "request": { + "$ref": "#/definitions/Request", + "description": "The request." + }, + "response": { + "$ref": "#/definitions/Response", + "description": "The response." + } + } + }, + "Request": { + "type": "object", + "additionalProperties": false, + "description": "A request.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the request." + }, + "uri": { + "type": "string", + "description": "The destination for the request." + }, + "method": { + "type": "string", + "description": "The HTTP method used for the request." + } + } + }, + "Response": { + "type": "object", + "additionalProperties": false, + "description": "A response.", + "properties": { + "headers": { + "$ref": "#/definitions/Object", + "description": "A list of all the headers attached to the response." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "description": "The status code of the response." + }, + "bodyLink": { + "$ref": "#/definitions/ContentLink", + "description": "Details on the location of the body content." + } + } } }, "parameters": { From fa24c3ee2969ff29bca73f4b646045fb2a93ed07 Mon Sep 17 00:00:00 2001 From: refortie <37600290+refortie@users.noreply.github.com> Date: Fri, 16 Nov 2018 11:47:02 -0800 Subject: [PATCH 143/464] Don't make ResourceReference id readonly, it's causing a bug in the SDK where an Logic Apps with integration accounts can't be saved (#4491) --- .../Microsoft.Logic/preview/2018-07-01-preview/logic.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json index 82ad4eabcd2c..81db69c569cb 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json @@ -5169,7 +5169,6 @@ "properties": { "id": { "type": "string", - "readOnly": true, "description": "The resource id." }, "name": { From 5ff6dda38a407c2556a7b2d012c1ad98da7e9115 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Fri, 16 Nov 2018 14:13:30 -0800 Subject: [PATCH 144/464] [HDInsight] - Support KV URL (#4449) --- .../preview/2015-03-01-preview/cluster.json | 111 ++++++++++++++++++ ...teLinuxHadoopClusterDiskEncryptionKey.json | 17 +++ .../preview/2018-06-01-preview/cluster.json | 111 ++++++++++++++++++ ...teLinuxHadoopClusterDiskEncryptionKey.json | 17 +++ 4 files changed, 256 insertions(+) create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json index 5ae64d94394c..9c62de695cb5 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json @@ -375,6 +375,58 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_RotateDiskEncryptionKey", + "x-ms-examples": { + "Rotate disk encryption key of the specified HDInsight cluster": { + "$ref": "./examples/RotateLinuxHadoopClusterDiskEncryptionKey.json" + } + }, + "description": "Rotate disk encryption key of the specified HDInsight cluster.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterDiskEncryptionParameters" + }, + "description": "The parameters for the disk encryption operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } } }, "definitions": { @@ -686,6 +738,10 @@ "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "The storage profile." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." } } }, @@ -854,6 +910,10 @@ "$ref": "#/definitions/ConnectivityEndpoint" }, "description": "The list of connectivity endpoints." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." } }, "required": [ @@ -1109,6 +1169,57 @@ }, "description": "The Resize Cluster request parameters." }, + "ClusterDiskEncryptionParameters": { + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + } + }, + "description": "The Disk Encryption Cluster request parameters." + }, + "DiskEncryptionProperties": { + "description": "The disk encryption properties", + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Algorithm identifier for encryption, default RSA-OAEP.", + "enum": [ + "RSA-OAEP", + "RSA-OAEP-256", + "RSA1_5" + ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "msiResourceId": { + "type": "string", + "description": "Resource ID of Managed Identity that is used to access the key vault." + } + } + }, "OperationResource": { "properties": { "status": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json new file mode 100644 index 000000000000..ec02df616300 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "vaultUri": "https://newkeyvault.vault.azure.net/", + "keyName": "newkeyname", + "keyVersion": "newkeyversion" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json index 937f746ec649..772af1b8f092 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/cluster.json @@ -375,6 +375,58 @@ "nextLinkName": "nextLink" } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_RotateDiskEncryptionKey", + "x-ms-examples": { + "Rotate disk encryption key of the specified HDInsight cluster": { + "$ref": "./examples/RotateLinuxHadoopClusterDiskEncryptionKey.json" + } + }, + "description": "Rotate disk encryption key of the specified HDInsight cluster.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterDiskEncryptionParameters" + }, + "description": "The parameters for the disk encryption operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true + } } }, "definitions": { @@ -686,6 +738,10 @@ "storageProfile": { "$ref": "#/definitions/StorageProfile", "description": "The storage profile." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." } } }, @@ -854,6 +910,10 @@ "$ref": "#/definitions/ConnectivityEndpoint" }, "description": "The list of connectivity endpoints." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." } }, "required": [ @@ -1109,6 +1169,57 @@ }, "description": "The Resize Cluster request parameters." }, + "ClusterDiskEncryptionParameters": { + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + } + }, + "description": "The Disk Encryption Cluster request parameters." + }, + "DiskEncryptionProperties": { + "description": "The disk encryption properties", + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Algorithm identifier for encryption, default RSA-OAEP.", + "enum": [ + "RSA-OAEP", + "RSA-OAEP-256", + "RSA1_5" + ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "msiResourceId": { + "type": "string", + "description": "Resource ID of Managed Identity that is used to access the key vault." + } + } + }, "OperationResource": { "properties": { "status": { diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json new file mode 100644 index 000000000000..b5c58b8ebe81 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2018-06-01-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "vaultUri": "https://newkeyvault.vault.azure.net/", + "keyName": "newkeyname", + "keyVersion": "newkeyversion" + } + }, + "responses": { + "200": {}, + "202": {} + } +} \ No newline at end of file From 19e68db4b247c9576a8e94884e6ca9da83aee605 Mon Sep 17 00:00:00 2001 From: Yadi Reyes <36422356+yareyes@users.noreply.github.com> Date: Fri, 16 Nov 2018 14:15:23 -0800 Subject: [PATCH 145/464] New Swagger specification for Microsoft.SqlVirtualMachine Resource Provider. (#4385) * Adding new SQL VM Resource Manager swagger and examples * Final swagger * Addressing code review comments, adding readme file * Addressing code review comments * Addressing code review comments * Addressing comments --- ...eateOrUpdateAvailabilityGroupListener.json | 71 + .../CreateOrUpdateSqlVirtualMachineGroup.json | 67 + .../CreateOrUpdateSqlVirtualMachineMAX.json | 86 + .../CreateOrUpdateSqlVirtualMachineMIN.json | 44 + ...eateOrUpdateVirtualMachineWithVMGroup.json | 52 + .../DeleteAvailabilityGroupListener.json | 14 + .../examples/DeleteSqlVirtualMachine.json | 13 + .../DeleteSqlVirtualMachineGroup.json | 13 + .../GetAvailabilityGroupListener.json | 35 + .../examples/GetSqlVirtualMachine.json | 27 + .../examples/GetSqlVirtualMachineGroup.json | 35 + .../ListByGroupAvailabilityGroupListener.json | 38 + .../ListByResourceGroupSqlVirtualMachine.json | 41 + ...ByResourceGroupSqlVirtualMachineGroup.json | 81 + .../examples/ListOperation.json | 112 ++ .../ListSubscriptionSqlVirtualMachine.json | 53 + ...istSubscriptionSqlVirtualMachineGroup.json | 80 + .../examples/UpdateSqlVirtualMachine.json | 33 + .../UpdateSqlVirtualMachineGroup.json | 35 + .../preview/2017-03-01-preview/sqlvm.json | 1792 +++++++++++++++++ .../resource-manager/readme.md | 101 + 21 files changed, 2823 insertions(+) create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateAvailabilityGroupListener.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMIN.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateVirtualMachineWithVMGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteAvailabilityGroupListener.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachine.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetAvailabilityGroupListener.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachine.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByGroupAvailabilityGroupListener.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachine.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListOperation.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachine.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachine.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachineGroup.json create mode 100644 specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json create mode 100644 specification/sqlvirtualmachine/resource-manager/readme.md diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateAvailabilityGroupListener.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateAvailabilityGroupListener.json new file mode 100644 index 000000000000..6b19a28e1869 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateAvailabilityGroupListener.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "availabilityGroupListenerName": "agl-test", + "api-version": "2017-03-01-preview", + "parameters": { + "AvailabilityGroupName": "ag-test", + "LoadBalancerConfigurations": [ + { + "PrivateIPAddress": { + "IpAddress": "10.1.0.112", + "SubnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + }, + "LoadBalancerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test", + "ProbePort": "59983", + "SqlVirtualMachineInstances": [ + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3" + ] + } + ], + "Port": "1433" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Updating", + "loadBalancerConfigurations": [ + { + "privateIpAddress": { + "ipAddress": "10.1.0.113", + "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + }, + "sqlVirtualMachineInstances": [ "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3" ] + } + ], + "port": 1433 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test", + "name": "agl-test", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "Provisioning", + "loadBalancerConfigurations": [ + { + "privateIpAddress": { + "ipAddress": "10.1.0.112", + "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + }, + "sqlVirtualMachineInstances": [ "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3" ] + } + ], + "port": 1433 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test", + "name": "agl-test", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..9797079548a8 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": { + "SqlImageOffer": "SQL2016-WS2016", + "SqlImageSku": "Enterprise", + "WsfcDomainProfile": { + "DomainFQDN": "testdomain.com", + "OUPath": "OU=WSCluster,DC=testdomain,DC=com", + "ClusterBootstrapAccount": "testrpadmin", + "ClusterOperatorAccount": "testrp@testdomain.com", + "SqlServiceAccount": "sqlservice@testdomain.com", + "StorageAccountUrl": "https://storgact.blob.core.windows.net/", + "StorageAccountPrimaryKey": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "UpdatingDomainful", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + }, + "201": { + "body": { + "properties": { + "provisioningState": "ProvisioningDomainful", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json new file mode 100644 index 000000000000..eb165d5d9f3b --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName":"testvm", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "properties": { + "sqlServerLicenseType": "PAYG", + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "ServerConfigurationsManagementSettings": { + "SQLConnectivityUpdateSettings": { + "ConnectivityType": "Private", + "Port": 1433, + "SQLAuthUpdateUserName": "sqllogin", + "SQLAuthUpdatePassword": "" + }, + "SQLStorageUpdateSettings": { + "DiskCount": 1, + "DiskConfigurationType": "NEW" + }, + "SQLWorkloadTypeUpdateSettings": { + "SQLWorkloadType": "OLTP" + }, + "AdditionalFeaturesServerConfigurations": { + "IsRServicesEnabled": false + } + }, + "KeyVaultCredentialSettings": { + "Enable": false + }, + "AutoPatchingSettings": { + "Enable": true, + "DayOfWeek": "Sunday", + "MaintenanceWindowStartingHour": 2, + "MaintenanceWindowDuration": 60 + }, + "AutoBackupSettings": { + "Enable": true, + "RetentionPeriod": 17, + "EnableEncryption": true, + "Password": "", + "BackupScheduleType": "Manual", + "BackupSystemDbs": true, + "StorageAccountUrl": "https://teststorage.blob.core.windows.net/", + "StorageAccessKey": "", + "FullBackupFrequency": "Daily", + "FullBackupStartTime": 6, + "FullBackupWindowHours": 11, + "LogBackupFrequency": 10 + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Updating", + "sqlServerLicenseType": "PAYG", + "sqlImageSku": "Enterprise" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + }, + "201": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Provisioning", + "sqlServerLicenseType": "PAYG", + "sqlImageSku": "Unknown" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMIN.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMIN.json new file mode 100644 index 000000000000..b1afdafb9408 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMIN.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName": "testvm", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Updating", + "sqlServerLicenseType": "PAYG", + "sqlImageSku": "Enterprise" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + }, + "201": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Provisioning", + "sqlServerLicenseType": "PAYG", + "sqlImageSku": "Unknown" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateVirtualMachineWithVMGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateVirtualMachineWithVMGroup.json new file mode 100644 index 000000000000..1d591806ded8 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateVirtualMachineWithVMGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName": "testvm", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2", + "SqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup", + "WsfcDomainCredentials": { + "ClusterBootstrapAccountPassword": "", + "ClusterOperatorAccountPassword": "", + "SqlServiceAccountPassword": "" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2", + "provisioningState": "Updating", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG", + "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "name": "testvm2", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + }, + "201": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm2", + "provisioningState": "Provisioning", + "sqlImageSku": "Unknown", + "sqlServerLicenseType": "PAYG", + "sqlVirtualMachineGroupResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "name": "testvm2", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + } + } +} diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteAvailabilityGroupListener.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteAvailabilityGroupListener.json new file mode 100644 index 000000000000..98d9c96eb0f2 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteAvailabilityGroupListener.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "availabilityGroupListenerName": "agl-test", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachine.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachine.json new file mode 100644 index 000000000000..f4489c95f57e --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachine.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName": "testvm1", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..b3d3c439e4cb --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/DeleteSqlVirtualMachineGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetAvailabilityGroupListener.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetAvailabilityGroupListener.json new file mode 100644 index 000000000000..de85cdc4c309 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetAvailabilityGroupListener.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "availabilityGroupListenerName": "agl-test", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "availabilityGroupName": "ag-test", + "loadBalancerConfigurations": [ + { + "privateIpAddress": { + "ipAddress": "10.1.0.112", + "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + }, + "loadBalancerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test", + "probePort": 59983, + "sqlVirtualMachineInstances": [ "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3", + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2" ] + } + ], + "port": 1433 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test", + "name": "agl-test", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachine.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachine.json new file mode 100644 index 000000000000..36e4c9ee375f --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachine.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName": "testvm", + "api-version": "2017-03-01-preview", + "parameters": { + } + }, + "responses": { + "200": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..2fc27894ba40 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/GetSqlVirtualMachineGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByGroupAvailabilityGroupListener.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByGroupAvailabilityGroupListener.json new file mode 100644 index 000000000000..b79af039a5df --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByGroupAvailabilityGroupListener.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "availabilityGroupName": "ag-test", + "loadBalancerConfigurations": [ + { + "privateIpAddress": { + "ipAddress": "10.1.0.112", + "subnetResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/default" + }, + "loadBalancerResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb-test", + "probePort": 59983, + "sqlVirtualMachineInstances": [ "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm3", + "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2" ] + } + ], + "port": 1433 + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup/availabilityGroupListeners/agl-test", + "name": "agl-test", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachine.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachine.json new file mode 100644 index 000000000000..6785d0d40347 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachine.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + }, + { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm1", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2017-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm1", + "name": "testvm1", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..cad9a73fd09d --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListByResourceGroupSqlVirtualMachineGroup.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2017-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + }, + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup1", + "name": "testvmgroup1", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + }, + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/testvmgroup2", + "name": "testvmgroup2", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + ] + } + } + } +} diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListOperation.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListOperation.json new file mode 100644 index 000000000000..1be629af051c --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListOperation.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/read", + "display": { + "resource": "SQL VirtualMachine Group", + "operation": "Get SQL VirtualMachine Group details", + "description": "Retrives details of SQL VirtualMachine Group" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/write", + "display": { + "resource": "SQL VirtualMachine Group", + "operation": "Create a new or update existing SQL VirtualMachine Group", + "description": "Create a new or change properties of existing SQL VirtualMachine Group" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/delete", + "display": { + "resource": "SQL VirtualMachine Group", + "operation": "Delete existing SQL VirtualMachine Group", + "description": "Delete existing SQL VirtualMachine Group" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/read", + "display": { + "resource": "SQL AvailabilityGroup Listener", + "operation": "Get AvailabilityGroup Listener details", + "description": "Retrieves details of SQL AvailabilityGroup Listener on a given SQL VirtualMachine Group" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/write", + "display": { + "resource": "SQL AvailabilityGroup Listener", + "operation": "Create new or update exising AvailabilityGroup Listener", + "description": "Create a new or change properties of existing SQL AvailabilityGroup Listener" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/availabilityGroupListeners/delete", + "display": { + "resource": "SQL AvailabilityGroup Listener", + "operation": "Delete existing AvailabilityGroup Listener", + "description": "Delete existing AvailabilityGroup Listener" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/locations/availabilityGroupListenerOperationResults/read", + "display": { + "resource": "SQL AvailabilityGroup Listener", + "operation": "Get AvailabilityGroup Listener operation result", + "description": "Get result of an AvailabilityGroup Listener operation" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/operations/read", + "display": { + "resource": "Available REST operations" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineGroupOperationResults/read", + "display": { + "resource": "SQL VirtualMachine Group", + "operation": "Get SQL VirtualMachine Group operation result", + "description": "Get result of a SQL VirtualMachine Group operation" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/read", + "display": { + "operation": "Get SQL VirtualMachine Instance details", + "description": "Retrieves details of SQL VirtualMachine" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/write", + "display": { + "operation": "Create new or update existing SQL VirtualMachine", + "description": "Create a new or change properties of existing SQL VirtualMachine" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/sqlVirtualMachines/delete", + "display": { + "operation": "Delete exisiting SQL VirtualMachine", + "description": "Delete exisiting SQL VirtualMachine" + } + }, + { + "name": "Microsoft.SqlVirtualMachine/locations/sqlVirtualMachineOperationResults/read", + "display": { + "resource": "SQL VirtualMachine", + "operation": "Get SQL VirtualMachine operation result", + "description": "Get result of SQL VirtualMachine operation" + } + } + ] + } + } + } +} diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachine.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachine.json new file mode 100644 index 000000000000..74eee8a07a81 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachine.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + }, + { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm1", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2017-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm1", + "name": "testvm1", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + }, + { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.Compute/virtualMachines/testvm2", + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "sqlServerLicenseType": "PAYG" + }, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm2", + "name": "testvm2", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..b47490f3b56e --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/ListSubscriptionSqlVirtualMachineGroup.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2017-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + }, + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/", + "name": "testvmgroup1", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + }, + { + "properties": { + "provisioningState": "Succeeded", + "sqlImageOffer": "SQL2016-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "domainFqdn": "testdomain.com", + "ouPath": "OU=WSCluster,DC=testdomain,DC=com", + "clusterBootstrapAccount": "testrpadmin", + "clusterOperatorAccount": "testrp@testdomain.com", + "sqlServiceAccount": "sqlservice@testdomain.com", + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg2/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/", + "name": "testvmgroup2", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + ] + } + } + } +} diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachine.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachine.json new file mode 100644 index 000000000000..8493fc02413a --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachine.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineName": "testvm", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "virtualMachineResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachines/testvm", + "provisioningState": "Updating", + "sqlServerLicenseType": "PAYG", + "sqlImageSku": "Unknown" + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvm", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachines" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachineGroup.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachineGroup.json new file mode 100644 index 000000000000..7808f0432f6c --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/UpdateSqlVirtualMachineGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlVirtualMachineGroupName": "testvmgroup", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "northeurope", + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "UpdatingDomainful", + "sqlImageOffer": "SQL2017-WS2016", + "sqlImageSku": "Enterprise", + "wsfcDomainProfile": { + "storageAccountUrl": "https://storgact.blob.core.windows.net/" + } + }, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/testvm", + "name": "testvmgroup", + "type": "Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json new file mode 100644 index 000000000000..48070b1972ca --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json @@ -0,0 +1,1792 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlVirtualMachineManagementClient", + "description": "The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}": { + "get": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Gets an availability group listener.", + "operationId": "AvailabilityGroupListeners_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + } + }, + "x-ms-examples": { + "Gets an availability group listener.": { + "$ref": "./examples/GetAvailabilityGroupListener.json" + } + } + }, + "put": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Creates or updates an availability group listener.", + "operationId": "AvailabilityGroupListeners_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The availability group listener.", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + }, + "201": { + "description": "Successfully created the availability group listener.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListener" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates an availability group listener.": { + "$ref": "./examples/CreateOrUpdateAvailabilityGroupListener.json" + } + } + }, + "delete": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Deletes an availability group listener.", + "operationId": "AvailabilityGroupListeners_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "availabilityGroupListenerName", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the availability group listener." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + }, + "202": { + "description": "Deleting the availability group listener." + }, + "204": { + "description": "The availability group listener does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes an availability group listener.": { + "$ref": "./examples/DeleteAvailabilityGroupListener.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners": { + "get": { + "tags": [ + "AvailabilityGroupListeners" + ], + "description": "Lists all availability group listeners in a SQL virtual machine group.", + "operationId": "AvailabilityGroupListeners_ListByGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all availability group listeners in a SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/AvailabilityGroupListenerListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all availability group listeners in a SQL virtual machine group.": { + "$ref": "./examples/ListByGroupAvailabilityGroupListener.json" + } + } + } + }, + "/providers/Microsoft.SqlVirtualMachine/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available SQL Rest API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Lists all of the available SQL Rest API operations.": { + "$ref": "./examples/ListOperation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + } + }, + "x-ms-examples": { + "Gets a SQL virtual machine group.": { + "$ref": "./examples/GetSqlVirtualMachineGroup.json" + } + } + }, + "put": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Creates or updates a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine group.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + }, + "201": { + "description": "Successfully created the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a SQL virtual machine group.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineGroup.json" + } + } + }, + "delete": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Deletes a SQL virtual machine group.", + "operationId": "SqlVirtualMachineGroups_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL virtual machine group." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + }, + "202": { + "description": "Deleting the SQL virtual machine group." + }, + "204": { + "description": "The specified SQL virtual machine group does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a SQL virtual machine group.": { + "$ref": "./examples/DeleteSqlVirtualMachineGroup.json" + } + } + }, + "patch": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Updates SQL virtual machine group tags.", + "operationId": "SqlVirtualMachineGroups_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineGroupName", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine group.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a SQL virtual machine group tags.": { + "$ref": "./examples/UpdateSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets all SQL virtual machine groups in a resource group.", + "operationId": "SqlVirtualMachineGroups_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machine groups in the resource group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machine groups in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups": { + "get": { + "tags": [ + "SqlVirtualMachineGroups" + ], + "description": "Gets all SQL virtual machine groups in a subscription.", + "operationId": "SqlVirtualMachineGroups_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machine groups in the subscription.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineGroupListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machine groups in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlVirtualMachineGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines/{sqlVirtualMachineName}": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets a SQL virtual machine.", + "operationId": "SqlVirtualMachines_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "The child resources to include in the response.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + } + }, + "x-ms-examples": { + "Gets a SQL virtual machine.": { + "$ref": "./examples/GetSqlVirtualMachine.json" + } + } + }, + "put": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Creates or updates a SQL virtual machine.", + "operationId": "SqlVirtualMachines_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + }, + "201": { + "description": "Successfully created the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates or updates a SQL virtual machine with max paramenters.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMAX.json" + }, + "Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineWithVMGroup.json" + }, + "Creates or updates a SQL virtual machine with min parameters.": { + "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMIN.json" + } + } + }, + "delete": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Deletes a SQL virtual machine.", + "operationId": "SqlVirtualMachines_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL virtual machine." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + }, + "202": { + "description": "Deleting the SQL virtual machine." + }, + "204": { + "description": "The specified SQL virtual machine does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a SQL virtual machine.": { + "$ref": "./examples/DeleteSqlVirtualMachine.json" + } + } + }, + "patch": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Updates a SQL virtual machine.", + "operationId": "SqlVirtualMachines_Update", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL virtual machine.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlVirtualMachineUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SQL virtual machine.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachine" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a SQL virtual machine tags.": { + "$ref": "./examples/UpdateSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets all SQL virtual machines in a resource group.", + "operationId": "SqlVirtualMachines_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machines in the resource group.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machines in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines": { + "get": { + "tags": [ + "SqlVirtualMachines" + ], + "description": "Gets all SQL virtual machines in a subscription.", + "operationId": "SqlVirtualMachines_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved all SQL virtual machines in the subscription.", + "schema": { + "$ref": "#/definitions/SqlVirtualMachineListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL virtual machines in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlVirtualMachine.json" + } + } + } + } + }, + "definitions": { + "AvailabilityGroupListenerProperties": { + "description": "The properties of an availability group listener.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state to track the aysnc operation status.", + "type": "string", + "readOnly": true + }, + "availabilityGroupName": { + "description": "Name of the availability group.", + "type": "string" + }, + "loadBalancerConfigurations": { + "description": "List of load balancer configurations for an availability group listener.", + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancerConfiguration" + } + }, + "createDefaultAvailabilityGroupIfNotExist": { + "description": "Create a default availability group if it does not exist.", + "type": "boolean" + }, + "port": { + "format": "int32", + "description": "Listener port.", + "type": "integer" + } + } + }, + "LoadBalancerConfiguration": { + "description": "A load balancer configuration for an availability group listener.", + "type": "object", + "properties": { + "privateIpAddress": { + "$ref": "#/definitions/PrivateIPAddress", + "description": "Private IP address." + }, + "publicIpAddressResourceId": { + "description": "Resource id of the public IP.", + "type": "string" + }, + "loadBalancerResourceId": { + "description": "Subnet used to include private IP.", + "type": "string" + }, + "probePort": { + "format": "int32", + "description": "Probe port.", + "type": "integer" + }, + "sqlVirtualMachineInstances": { + "description": "List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateIPAddress": { + "description": "A private IP address bound to the availability group listener.", + "type": "object", + "properties": { + "ipAddress": { + "description": "Private IP address bound to the availability group listener.", + "type": "string" + }, + "subnetResourceId": { + "description": "Subnet used to include private IP.", + "type": "string" + } + } + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "AvailabilityGroupListener": { + "description": "A SQL Server availability group listener.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AvailabilityGroupListenerProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "AvailabilityGroupListenerListResult": { + "description": "A list of availability group listeners.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilityGroupListener" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list SQL operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "SQL REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action.", + "readOnly": true + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + }, + "SqlVirtualMachineGroupProperties": { + "description": "The properties of a SQL virtual machine group.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state to track the aysnc operation status.", + "type": "string", + "readOnly": true + }, + "sqlImageOffer": { + "description": "SQL image offer. Examples may include SQL2016-WS2016, SQL2017-WS2016.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "sqlImageSku": { + "description": "SQL image sku.", + "enum": [ + "Developer", + "Express", + "Standard", + "Enterprise", + "Web" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlImageSku", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "scaleType": { + "description": "Scale type.", + "enum": [ + "HA" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ScaleType", + "modelAsString": true + } + }, + "clusterManagerType": { + "description": "Type of cluster manager: Windows Server Failover Cluster (WSFC), implied by the scale type of the group and the OS type.", + "enum": [ + "WSFC" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClusterManagerType", + "modelAsString": true + } + }, + "clusterConfiguration": { + "description": "Cluster type.", + "enum": [ + "Domainful" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ClusterConfiguration", + "modelAsString": true + } + }, + "wsfcDomainProfile": { + "$ref": "#/definitions/WsfcDomainProfile", + "description": "Cluster Active Directory domain profile.", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "WsfcDomainProfile": { + "description": "Active Directory account details to operate Windows Server Failover Cluster.", + "type": "object", + "properties": { + "domainFqdn": { + "description": "Fully qualified name of the domain.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "ouPath": { + "description": "Organizational Unit path in which the nodes and cluster will be present.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterBootstrapAccount": { + "description": "Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain).", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "clusterOperatorAccount": { + "description": "Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster.", + "type": "string", + "x-ms-mutability": [ + "update" + ] + }, + "sqlServiceAccount": { + "description": "Account name under which SQL service will run on all participating SQL virtual machines in the cluster.", + "type": "string", + "x-ms-mutability": [ + "update" + ] + }, + "fileShareWitnessPath": { + "description": "Optional path for fileshare witness.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageAccountUrl": { + "description": "Fully qualified ARM resource id of the witness storage account.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "storageAccountPrimaryKey": { + "description": "Primary key of the witness storage account.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "TrackedResource": { + "description": "ARM tracked top level resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlVirtualMachineGroup": { + "description": "A SQL virtual machine group.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlVirtualMachineGroupProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlVirtualMachineGroupUpdate": { + "description": "An update to a SQL virtual machine group.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlVirtualMachineGroupListResult": { + "description": "A list of SQL virtual machine groups.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlVirtualMachineGroup" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceIdentity": { + "description": "Azure Active Directory identity configuration for a resource.", + "type": "object", + "properties": { + "principalId": { + "format": "uuid", + "description": "The Azure Active Directory principal id.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.", + "enum": [ + "SystemAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "tenantId": { + "format": "uuid", + "description": "The Azure Active Directory tenant id.", + "type": "string", + "readOnly": true + } + } + }, + "SqlVirtualMachineProperties": { + "description": "The SQL virtual machine properties.", + "type": "object", + "properties": { + "virtualMachineResourceId": { + "description": "ARM Resource id of underlying virtual machine created from SQL marketplace image.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "Provisioning state to track the aysnc operation status.", + "type": "string", + "readOnly": true + }, + "sqlImageOffer": { + "description": "SQL image offer. Examples include SQL2016-WS2016, SQL2017-WS2016.", + "type": "string", + "readOnly": true + }, + "sqlServerLicenseType": { + "description": "SQL Server license type.", + "enum": [ + "PAYG", + "AHUB" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlServerLicenseType", + "modelAsString": true + } + }, + "sqlImageSku": { + "description": "SQL image sku.", + "enum": [ + "Developer", + "Express", + "Standard", + "Enterprise", + "Web" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SqlImageSku", + "modelAsString": true + } + }, + "sqlVirtualMachineGroupResourceId": { + "description": "ARM resource id of the SQL virtual machine group this SQL virtual machine is or will be part of.", + "type": "string", + "x-ms-mutability": [ + "update" + ] + }, + "wsfcDomainCredentials": { + "$ref": "#/definitions/WsfcDomainCredentials", + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group." + }, + "autoPatchingSettings": { + "$ref": "#/definitions/AutoPatchingSettings", + "description": "Auto patching settings for applying critical security updates to SQL virtual machine." + }, + "autoBackupSettings": { + "$ref": "#/definitions/AutoBackupSettings", + "description": "Auto backup settings for SQL Server." + }, + "keyVaultCredentialSettings": { + "$ref": "#/definitions/KeyVaultCredentialSettings", + "description": "Key vault credential settings." + }, + "serverConfigurationsManagementSettings": { + "$ref": "#/definitions/ServerConfigurationsManagementSettings", + "description": "SQL Server configuration management settings." + } + } + }, + "WsfcDomainCredentials": { + "description": "Domain credentials for setting up Windows Server Failover Cluster for SQL availability group.", + "type": "object", + "properties": { + "clusterBootstrapAccountPassword": { + "description": "Cluster bootstrap account password.", + "type": "string" + }, + "clusterOperatorAccountPassword": { + "description": "Cluster operator account password.", + "type": "string" + }, + "sqlServiceAccountPassword": { + "description": "SQL service account password.", + "type": "string" + } + } + }, + "AutoPatchingSettings": { + "description": "Set a patching window during which Windows and SQL patches will be applied.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable autopatching on SQL virtual machine.", + "type": "boolean" + }, + "dayOfWeek": { + "description": "Day of week to apply the patch on.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "maintenanceWindowStartingHour": { + "format": "int32", + "description": "Hour of the day when patching is initiated. Local VM time.", + "type": "integer" + }, + "maintenanceWindowDuration": { + "format": "int32", + "description": "Duration of patching.", + "type": "integer" + } + } + }, + "AutoBackupSettings": { + "description": "Configure backups for databases in your SQL virtual machine.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable autobackup on SQL virtual machine.", + "type": "boolean" + }, + "enableEncryption": { + "description": "Enable or disable encryption for backup on SQL virtual machine.", + "type": "boolean" + }, + "retentionPeriod": { + "format": "int32", + "description": "Retention period of backup: 1-30 days.", + "type": "integer" + }, + "storageAccountUrl": { + "description": "Storage account url where backup will be taken to.", + "type": "string" + }, + "storageAccessKey": { + "description": "Storage account key where backup will be taken to.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "password": { + "description": "Password for encryption on backup.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "backupSystemDbs": { + "description": "Include or exclude system databases from auto backup.", + "type": "boolean" + }, + "backupScheduleType": { + "description": "Backup schedule type.", + "enum": [ + "Manual", + "Automated" + ], + "type": "string", + "x-ms-enum": { + "name": "BackupScheduleType", + "modelAsString": true + } + }, + "fullBackupFrequency": { + "description": "Frequency of full backups. In both cases, full backups begin during the next scheduled time window.", + "enum": [ + "Daily", + "Weekly" + ], + "type": "string", + "x-ms-enum": { + "name": "FullBackupFrequencyType", + "modelAsString": true + } + }, + "fullBackupStartTime": { + "format": "int32", + "description": "Start time of a given day during which full backups can take place. 0-23 hours.", + "type": "integer" + }, + "fullBackupWindowHours": { + "format": "int32", + "description": "Duration of the time window of a given day during which full backups can take place. 1-23 hours.", + "type": "integer" + }, + "logBackupFrequency": { + "format": "int32", + "description": "Frequency of log backups. 5-60 minutes.", + "type": "integer" + } + } + }, + "KeyVaultCredentialSettings": { + "description": "Configure your SQL virtual machine to be able to connect to the Azure Key Vault service.", + "type": "object", + "properties": { + "enable": { + "description": "Enable or disable key vault credential setting.", + "type": "boolean" + }, + "credentialName": { + "description": "Credential name.", + "type": "string" + }, + "azureKeyVaultUrl": { + "description": "Azure Key Vault url.", + "type": "string" + }, + "servicePrincipalName": { + "description": "Service principal name to access key vault.", + "type": "string" + }, + "servicePrincipalSecret": { + "description": "Service principal name secret to access key vault.", + "type": "string", + "x-ms-mutability": [ + "create", + "update" + ] + } + } + }, + "ServerConfigurationsManagementSettings": { + "description": "Set the connectivity, storage and workload settings.", + "type": "object", + "properties": { + "sqlConnectivityUpdateSettings": { + "$ref": "#/definitions/SqlConnectivityUpdateSettings", + "description": "SQL connectivity type settings." + }, + "sqlWorkloadTypeUpdateSettings": { + "$ref": "#/definitions/SqlWorkloadTypeUpdateSettings", + "description": "SQL workload type settings." + }, + "sqlStorageUpdateSettings": { + "$ref": "#/definitions/SqlStorageUpdateSettings", + "description": "SQL storage update settings." + }, + "additionalFeaturesServerConfigurations": { + "$ref": "#/definitions/AdditionalFeaturesServerConfigurations", + "description": "Additional SQL feature settings." + } + } + }, + "SqlConnectivityUpdateSettings": { + "description": "Set the access level and network port settings for SQL Server.", + "type": "object", + "properties": { + "connectivityType": { + "description": "SQL Server connectivity option.", + "enum": [ + "LOCAL", + "PRIVATE", + "PUBLIC" + ], + "type": "string", + "x-ms-enum": { + "name": "ConnectivityType", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "SQL Server port.", + "type": "integer" + }, + "sqlAuthUpdateUserName": { + "description": "SQL Server sysadmin login to create.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "sqlAuthUpdatePassword": { + "description": "SQL Server sysadmin login password.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "SqlWorkloadTypeUpdateSettings": { + "description": "Set workload type to optimize storage for SQL Server.", + "type": "object", + "properties": { + "sqlWorkloadType": { + "description": "SQL Server workload type.", + "enum": [ + "GENERAL", + "OLTP", + "DW" + ], + "type": "string", + "x-ms-enum": { + "name": "SqlWorkloadType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "SqlStorageUpdateSettings": { + "description": "Set disk storage settings for SQL Server.", + "type": "object", + "properties": { + "diskCount": { + "format": "int32", + "description": "Virtual machine disk count.", + "type": "integer" + }, + "diskConfigurationType": { + "description": "Disk configuration to apply to SQL Server.", + "enum": [ + "NEW", + "EXTEND", + "ADD" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskConfigurationType", + "modelAsString": true + } + } + } + }, + "AdditionalFeaturesServerConfigurations": { + "description": "Additional SQL Server feature settings.", + "type": "object", + "properties": { + "isRServicesEnabled": { + "description": "Enable or disable R services (SQL 2016 onwards).", + "type": "boolean" + }, + "backupPermissionsForAzureBackupSvc": { + "description": "Enable or disable Azure Backup service.", + "type": "boolean" + } + } + }, + "SqlVirtualMachine": { + "description": "A SQL virtual machine.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "Azure Active Directory identity of the server.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "$ref": "#/definitions/SqlVirtualMachineProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlVirtualMachineUpdate": { + "description": "An update to a SQL virtual machine.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlVirtualMachineListResult": { + "description": "A list of SQL virtual machines.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlVirtualMachine" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineNameParameter": { + "name": "sqlVirtualMachineName", + "in": "path", + "description": "Name of the SQL virtual machine.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineGroupNameParameter": { + "name": "sqlVirtualMachineGroupNameParameter", + "in": "path", + "description": "Name of the SQL virtual machine group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AvailabilityGroupListenerNameParameter": { + "name": "availabilityGroupListenerNameParameter", + "in": "path", + "description": "Name of the availability group listener.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/sqlvirtualmachine/resource-manager/readme.md b/specification/sqlvirtualmachine/resource-manager/readme.md new file mode 100644 index 000000000000..1809a016ac95 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/readme.md @@ -0,0 +1,101 @@ +# SQL virtual machine + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for SQL virtual machine. + + + +--- +## Getting Started +To build the SDK for SQL virtual machine, 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 SQL virtual machine API. + +``` yaml +title: SqlVirtualMachineManagementClient +description: The SQL virtual machine management API provides a RESTful set of web APIs that interact with Azure Compute, Network & Storage services to manage your SQL Server virtual machine. The API enables users to create, delete and retrieve a SQL virtual machine, SQL virtual machine group or availability group listener. +openapi-type: arm +tag: package-2017-03-01-preview +``` + +### Tag: package-2017-03-01-preview + +These settings apply only when `--tag=package-2017-03-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2017-03-01-preview' +input-file: +- Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python +``` + + +### C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.SqlVirtualMachine + output-folder: $(csharp-sdks-folder)/SqlVirtualMachine/Management.SqlVirtualMachine/Generated + clear-output-folder: true +``` + + +### Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.sqlvirtualmachine + package-name: azure-mgmt-sqlvirtualmachine + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-sqlvirtualmachine/azure/mgmt/sqlvirtualmachine +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-sqlvirtualmachine +``` From b07db548a8344d996d778669c8ded158275c8363 Mon Sep 17 00:00:00 2001 From: Mike Dodaro Date: Fri, 16 Nov 2018 14:40:19 -0800 Subject: [PATCH 146/464] Description of Autosuggest usage needs improvement. (#4490) --- .../data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json index a07198e64b18..c584fa8398eb 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json +++ b/specification/cognitiveservices/data-plane/AutoSuggest/stable/v1.0/AutoSuggest.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "AutoSuggest Client", - "description": "The AutoSuggest Search API lets you send a search query to Bing and get back a list of news that are relevant to the search query. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).", + "description": "Autosuggest supplies search terms derived from a root text sent to the service. The terms Autosuggest supplies are related to the root text based on similarity and their frequency or ratings of usefulness in other searches. For examples that show how to use Autosuggest, see [Search using AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).", "version": "1.0" }, "parameters": { @@ -54,7 +54,7 @@ "paths": { "/Suggestions": { "get": { - "summary": "The AutoSuggest API lets you send a search query to Bing and get back a list of suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.", + "summary": "The AutoSuggest API lets you send a search query to Bing and get back a list of query suggestions. This section provides technical details about the query parameters and headers that you use to request suggestions and the JSON response objects that contain them.", "operationId": "AutoSuggest", "tags": [ "AutoSuggest" @@ -653,4 +653,4 @@ } } } -} \ No newline at end of file +} From 8767b017b00b7af642638c0f553302f5365dbdc1 Mon Sep 17 00:00:00 2001 From: haitsongmsft <31645751+haitsongmsft@users.noreply.github.com> Date: Fri, 16 Nov 2018 15:22:08 -0800 Subject: [PATCH 147/464] add clientData properties to data migration tasks (#4462) --- .../preview/2018-07-15-preview/definitions/Tasks.json | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json index 7a27c3a1a67a..7ad603981325 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json @@ -60,6 +60,13 @@ "$ref": "./Commands.json#/definitions/CommandProperties" }, "readOnly": true + }, + "clientData": { + "type": "object", + "description": "Key value pairs of client data to attach meta data information to task", + "additionalProperties": { + "type": "string" + } } }, "required": [ "taskType" ], From e5cfd84419b24271e162875fe158dcb43b8515ca Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Sun, 18 Nov 2018 21:35:26 -0800 Subject: [PATCH 148/464] Microsoft.StorageSync : Update ApiVersion 2018-10-01 (#4249) * Update ApiVersion , still in Preview folder. (Andre's change) * fix Go SDK codegen for package-2018-10-01 * Update specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json * Update Examples * Update specification/storagesync/resource-manager/readme.typescript.md * Fix example * Update specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json * Matching with service implementation --- .../examples/CloudEndpoints_Create.json | 19 +++--- .../examples/CloudEndpoints_Delete.json | 10 +-- .../examples/CloudEndpoints_Get.json | 2 +- .../CloudEndpoints_ListBySyncGroup.json | 2 +- .../examples/CloudEndpoints_PostBackup.json | 6 +- .../examples/CloudEndpoints_PostRestore.json | 22 +++---- .../examples/CloudEndpoints_PreBackup.json | 12 ++-- .../examples/CloudEndpoints_PreRestore.json | 22 +++---- .../CloudEndpoints_RestoreHeatbeat.json | 2 +- .../2018-10-01/examples/Operations_List.json | 2 +- .../examples/RegisteredServers_Create.json | 11 ++-- .../examples/RegisteredServers_Delete.json | 9 ++- .../examples/RegisteredServers_Get.json | 2 +- ...teredServers_ListByStorageSyncService.json | 2 +- .../RegisteredServers_TriggerRollover.json | 8 +-- .../examples/ServerEndpoints_Create.json | 48 +++++--------- .../examples/ServerEndpoints_Delete.json | 8 +-- .../examples/ServerEndpoints_Get.json | 16 +++-- .../ServerEndpoints_ListBySyncGroup.json | 43 +++++++----- .../examples/ServerEndpoints_Recall.json | 8 +-- .../examples/ServerEndpoints_Update.json | 27 +++++--- ...ceCheckNameAvailability_AlreadyExists.json | 32 ++++----- ...erviceCheckNameAvailability_Available.json | 28 ++++---- .../examples/StorageSyncServices_Create.json | 2 +- .../examples/StorageSyncServices_Delete.json | 2 +- .../examples/StorageSyncServices_Get.json | 2 +- ...orageSyncServices_ListByResourceGroup.json | 66 +++++++++---------- ...torageSyncServices_ListBySubscription.json | 66 +++++++++---------- .../examples/StorageSyncServices_Update.json | 2 +- .../examples/SyncGroups_Create.json | 3 +- .../examples/SyncGroups_Delete.json | 6 +- .../2018-10-01/examples/SyncGroups_Get.json | 2 +- .../SyncGroups_ListByStorageSyncService.json | 22 +++---- .../2018-10-01/examples/Workflows_Abort.json | 2 +- .../2018-10-01/examples/Workflows_Get.json | 2 +- .../Workflows_ListByStorageSyncService.json | 2 +- .../preview/2018-10-01/storagesync.json | 36 +++++++++- 37 files changed, 296 insertions(+), 260 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Create.json index a590250f4ea0..ee40a99d1ced 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Create.json @@ -5,13 +5,13 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01", + "api-version": "2018-10-01", "parameters": { "properties": { - "provisioningState": "Created", "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage", "storageAccountShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4", - "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"" + "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"", + "friendlyName": "ankushbsubscriptionmgmtmab" }, "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" } @@ -25,27 +25,28 @@ "body": { "name": "SampleCloudEndpoint_1", "properties": { + "backupEnabled" : "false", "provisioningState": "Succeeded", "storageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/tminienv59svc/providers/Microsoft.Storage/storageAccounts/tminienv59storage", "storageAccountShareName": "cvcloud-afscv-0719-058-a94a1354-a1fd-4e9a-9a50-919fad8c4ba4", "storageAccountTenantId": "\"72f988bf-86f1-41af-91ab-2d7cd011db47\"", "friendlyName": "ankushbsubscriptionmgmtmab", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", + "lastWorkflowId": "storageSyncServices/GATest/workflows/24ba0c4a-348e-419b-8f7a-091d0d9f07a4", "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC", "lastOperationName": "ICreateCloudEndpointWorkflow" }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/cloudEndpoints" + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" } }, "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } } } -} +} \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Delete.json index 69f04db152a7..d8108a1e2628 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Delete.json @@ -5,19 +5,19 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { - "200": { + "200": { "headers": { "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Get.json index 8b7937271b20..e9c6a0210475 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_Get.json @@ -5,7 +5,7 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_ListBySyncGroup.json index efbe34179951..97e59243a4a3 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_ListBySyncGroup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_ListBySyncGroup.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostBackup.json index d9696e57c2e3..f426b8a091eb 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostBackup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostBackup.json @@ -8,7 +8,7 @@ "parameters": { "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare" }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -18,13 +18,13 @@ }, "body": { "backupMetadata": { - "cloudEndpointName": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1" + "cloudEndpointName": "subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1" } } }, "202": { "headers": { - "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/baa40401-b043-4d1b-a80b-cb4e79fa1398?api-version=2018-07-01&resourcetype=PostBackupResourceType&ifxctx3=1847a938-7638-4d1b-943c-96ff2f8a2ec8", + "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/baa40401-b043-4d1b-a80b-cb4e79fa1398?api-version=2018-10-01&resourcetype=PostBackupResourceType&ifxctx3=1847a938-7638-4d1b-943c-96ff2f8a2ec8", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostRestore.json index 65f8ddd0cac6..301f8b4c4626 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostRestore.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PostRestore.json @@ -10,24 +10,24 @@ "sourceAzureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare", "status": "Succeeded", "restoreFileSpec": [ - { + { "path": "text1.txt", - "isdir" : false + "isdir" : false }, - { + { "path": "MyDir", - "isdir" : true + "isdir" : true }, - { + { "path": "MyDir/SubDir", - "isdir" : false + "isdir" : false }, - { + { "path": "MyDir/SubDir/File1.pdf", - "isdir" : false + "isdir" : false }] }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -36,9 +36,9 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-07-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-10-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreBackup.json index cdf0d9c32694..91c96e444650 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreBackup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreBackup.json @@ -5,10 +5,10 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01", - "parameters" : { - "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare" - } + "api-version": "2018-10-01", + "parameters" : { + "azureFileShare": "https://sampleserver.file.core.test-cint.azure-test.net/sampleFileShare" + } }, "responses": { "200": { @@ -17,9 +17,9 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-07-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "x-ms-location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-10-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreRestore.json index e674432ddab0..c9e86428f4db 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreRestore.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_PreRestore.json @@ -5,25 +5,25 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01", + "api-version": "2018-10-01", "parameters": { "azureFileShareUri": "https://hfsazbackupdevintncus2.file.core.test-cint.azure-test.net/sampleFileShare", "restoreFileSpec": [ - { + { "path": "text1.txt", - "isdir" : false + "isdir" : false }, - { + { "path": "MyDir", - "isdir" : true + "isdir" : true }, - { + { "path": "MyDir/SubDir", - "isdir" : false + "isdir" : false }, - { + { "path": "MyDir/SubDir/File1.pdf", - "isdir" : false + "isdir" : false }] } }, @@ -34,9 +34,9 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-07-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", + "x-ms-location": "https: //management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/HfsMabFS1/syncGroups/HfsMabDS1/cloudEndpoints/HfsMabCE1/operationresults/d67cfb91-1b13-4710-8226-83467bb5b66d?api-version=2018-10-01&resourcetype=preBackupResourceType&ifxctx3=005909ad-d156-4514-a26e-dd1cc566db64", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_RestoreHeatbeat.json index ea502c15f337..ed0fa8ad8438 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_RestoreHeatbeat.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/CloudEndpoints_RestoreHeatbeat.json @@ -5,7 +5,7 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Operations_List.json index 06584b89d825..1cd542994397 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Operations_List.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Operations_List.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json index af85f4dc4d17..1f00b3a4a60a 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json @@ -8,7 +8,6 @@ "name": "SampleServer-prod3.redmond.corp.microsoft.com", "properties": { "serverRole": "Standalone", - "provisioningState": "Created", "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", "serverManagementtErrorCode": 0, @@ -17,7 +16,7 @@ }, "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -26,8 +25,8 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" }, "body": { - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "type": "10.91.86.47/storageSyncServices/registeredServers", + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers", "name": "ankushb-prod3.redmond.corp.microsoft.com", "properties": { "agentVersion": "3.1.5.0", @@ -52,8 +51,8 @@ }, "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Delete.json index 99cf9e77b7ea..2aa6677150ca 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Delete.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -13,17 +13,16 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, "204": { - } } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json index d05673fe045d..3bb5b421fcb6 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json index cd3481d9730f..a7a896e77b31 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json @@ -3,7 +3,7 @@ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_TriggerRollover.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_TriggerRollover.json index 0136bc789ffc..741873ba1a59 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_TriggerRollover.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_TriggerRollover.json @@ -7,7 +7,7 @@ "parameters": { "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"" }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -16,10 +16,10 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d222" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Create.json index 46a5f9ca16ee..3c873c5a91e1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Create.json @@ -4,20 +4,20 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", "serverEndpointName": "SampleServerEndpoint_1", "parameters": { "properties": { - "provisioningState": "Created", "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", "cloudTiering": "off", "volumeFreeSpacePercent": 100, - "tierFilesOlderThanDays": 0 + "tierFilesOlderThanDays": 0, + "offlineDataTransfer": "on", + "offlineDataTransferShareName": "myfileshare" }, "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -28,43 +28,29 @@ "body": { "name": "SampleServerEndpoint_1", "properties": { - "serverLocalPath": "C:\\data_quota", + "serverLocalPath": "D:\\SampleServerEndpoint_1", "cloudTiering": "off", - "volumeFreeSpacePercent": 20, + "volumeFreeSpacePercent": 100, "friendlyName": "somemachine.redmond.corp.microsoft.com", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", "provisioningState": "Succeeded", "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", "lastOperationName": "ICreateServerEndpointWorkflow", "tierFilesOlderThanDays" : 0, - "syncStatus": { - "downloadHealth": "Healthy", - "uploadHealth": "Error", - "combinedHealth": "Error", - "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", - "uploadStatus": { - "lastSyncResult": -2134351810, - "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", - "lastSyncSuccessTimestamp": null, - "lastSyncPerItemErrorCount": 69 - }, - "downloadStatus": { - "lastSyncResult": 0, - "lastSyncTimestamp": "2018-06-11T23:28:33.9217334Z", - "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", - "lastSyncPerItemErrorCount": 0 - }, - "currentProgress": null - } + "syncStatus": null, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare" }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" } }, "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Delete.json index 406e8750f6be..e98d72d2f7f4 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Delete.json @@ -5,7 +5,7 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -14,10 +14,10 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json index 841c87231c30..6cd5540ed2aa 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json @@ -5,7 +5,7 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -16,11 +16,11 @@ "body": { "name": "SampleServerEndpoint_1", "properties": { - "serverLocalPath": "C:\\data_quota", + "serverLocalPath": "D:\\SampleServerEndpoint_1", "cloudTiering": "off", - "volumeFreeSpacePercent": 20, + "volumeFreeSpacePercent": 100, "friendlyName": "somemachine.redmond.corp.microsoft.com", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", "provisioningState": "Succeeded", "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", "lastOperationName": "ICreateServerEndpointWorkflow", @@ -43,9 +43,13 @@ "lastSyncPerItemErrorCount": 0 }, "currentProgress": null - } + }, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare" }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" } } diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json index c249b2644b5f..076baf7fe3dc 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -16,14 +16,15 @@ "value": [{ "name": "SampleServerEndpoint_1", "properties": { - "serverLocalPath": "C:\\data_quota", + "serverLocalPath": "D:\\SampleServerEndpoint_1", "cloudTiering": "off", - "volumeFreeSpacePercent": 20, + "volumeFreeSpacePercent": 100, "friendlyName": "somemachine.redmond.corp.microsoft.com", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", "provisioningState": "Succeeded", "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11a", "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays" : 0, "syncStatus": { "downloadHealth": "Healthy", "uploadHealth": "Error", @@ -42,31 +43,36 @@ "lastSyncPerItemErrorCount": 0 }, "currentProgress": null - } + }, + "offlineDataTransfer": "on", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare" }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" }, { "name": "SampleServerEndpoint_2", "properties": { - "serverLocalPath": "C:\\data_quota2", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_2", + "cloudTiering": "on", + "volumeFreeSpacePercent": 80, "friendlyName": "somemachine2.redmond.corp.microsoft.com", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", "provisioningState": "Succeeded", - "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/569afb5c-7172-4cf8-a8ea-d987f727f11b", + "lastWorkflowId": "storageSyncServices/healthDemo1/workflows/40b1dc00-d7d9-4721-a1e9-ab60139b830a", "lastOperationName": "ICreateServerEndpointWorkflow", + "tierFilesOlderThanDays" : 5, "syncStatus": { "downloadHealth": "Healthy", - "uploadHealth": "Error", - "combinedHealth": "Error", + "uploadHealth": "Healthy", + "combinedHealth": "Healthy", "lastUpdatedTimestamp": "2018-06-11T23:32:51.1057915Z", "uploadStatus": { - "lastSyncResult": -2134351810, + "lastSyncResult": 0, "lastSyncTimestamp": "2018-06-11T23:32:51.1057915Z", - "lastSyncSuccessTimestamp": null, - "lastSyncPerItemErrorCount": 69 + "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", + "lastSyncPerItemErrorCount": 0 }, "downloadStatus": { "lastSyncResult": 0, @@ -75,9 +81,10 @@ "lastSyncPerItemErrorCount": 0 }, "currentProgress": null - } + }, + "offlineDataTransfer": "off" }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_2", + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_2", "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" }] } diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Recall.json index e3df14383eb0..822648c210e1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Recall.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Recall.json @@ -5,7 +5,7 @@ "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2018-07-01", + "api-version": "2018-10-01", "parameters": { "pattern": "", "recallPath": "" @@ -18,10 +18,10 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json index 56a8b939c5eb..a1875bc3e672 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json @@ -6,13 +6,15 @@ "cloudEndpointName": "SampleCloudEndpoint_1", "syncGroupName": "SampleSyncGroup_1", "serverEndpointName": "SampleServerEndpoint_1", - "parameters" : { + "parameters" : { "properties": { "cloudTiering": "off", - "volumeFreeSpacePercent": 100 + "volumeFreeSpacePercent": 100, + "tierFilesOlderThanDays" : 0, + "offlineDataTransfer": "off" } - }, - "api-version": "2018-07-01" + }, + "api-version": "2018-10-01" }, "responses": { "200": { @@ -26,6 +28,7 @@ "serverLocalPath": "C:\\data_quota2", "cloudTiering": "off", "volumeFreeSpacePercent": 20, + "tierFilesOlderThanDays": 0, "friendlyName": "somemachine2.redmond.corp.microsoft.com", "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/anpintDemoRG/providers/kailanitest07.one.microsoft.com/storageSyncServices/healthdemo1/registeredServers/f94e2944-b48d-4e5b-bdc7-c48ab3712659", "provisioningState": "Succeeded", @@ -49,16 +52,20 @@ "lastSyncPerItemErrorCount": 0 }, "currentProgress": null - } + }, + "offlineDataTransfer": "off", + "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", + "offlineDataTransferStorageAccountTenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "offlineDataTransferShareName": "myfileshare" }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" } }, - "202": { + "202": { "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2018-07-01", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2018-07-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2018-10-01", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2018-10-01", "Retry-After": "10", "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json index eddb9c226ab0..4a6791d4eb02 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_AlreadyExists.json @@ -1,20 +1,20 @@ { - "parameters": { - "api-version": "2018-07-01", - "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", - "locationName": "westus", "parameters": { - "name": "newstoragesyncservicename", - "type": "Microsoft.StorageSync/storageSyncServices" + "api-version": "2018-10-01", + "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", + "locationName": "westus", + "parameters": { + "name": "newstoragesyncservicename", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'newstoragesyncservicename' is already in use." + } + } } - }, - "responses": { - "200": { - "body": { - "nameAvailable": false, - "reason": "AlreadyExists", - "message": "An account named 'newstoragesyncservicename' is already in use." - } - } - } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_Available.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_Available.json index 528cbbe0319d..ebbb297ec612 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_Available.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServiceCheckNameAvailability_Available.json @@ -1,18 +1,18 @@ { - "parameters": { - "api-version": "2018-07-01", - "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", - "locationName": "westus", "parameters": { - "name": "newstoragesyncservicename", - "type": "Microsoft.StorageSync/storageSyncServices" + "api-version": "2018-10-01", + "subscriptionId": "5c6bc8e1-1eaf-4192-94d8-58ce463ac86c", + "locationName": "westus", + "parameters": { + "name": "newstoragesyncservicename", + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } } - }, - "responses": { - "200": { - "body": { - "nameAvailable": true - } - } - } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Create.json index fadfd4c0cf4b..7e1a3d40a951 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Create.json @@ -8,7 +8,7 @@ "tags": {}, "properties": {} }, - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Delete.json index be39f9b2193d..842ca3022ae4 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Delete.json @@ -3,7 +3,7 @@ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Get.json index 44a42c2d4da4..ec7ad30699f4 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListByResourceGroup.json index 98e01908a7ba..c8a4eed062ac 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListByResourceGroup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListByResourceGroup.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -11,38 +11,38 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" }, "body": { - "value": [{ - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - }, { - "name": "SampleStorageSyncService_2", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", - "type": "Microsoft.StorageSync/storageSyncServices" - }, { - "name": "SampleStorageSyncService_3", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", - "type": "Microsoft.StorageSync/storageSyncServices" - }] -} + "value": [{ + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + }, { + "name": "SampleStorageSyncService_2", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", + "type": "Microsoft.StorageSync/storageSyncServices" + }, { + "name": "SampleStorageSyncService_3", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", + "type": "Microsoft.StorageSync/storageSyncServices" + }] + } } } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListBySubscription.json index b692ba14ebad..90a7c1889ad4 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListBySubscription.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_ListBySubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -10,38 +10,38 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" }, "body": { - "value": [{ - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - }, { - "name": "SampleStorageSyncService_2", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", - "type": "Microsoft.StorageSync/storageSyncServices" - }, { - "name": "SampleStorageSyncService_3", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", - "type": "Microsoft.StorageSync/storageSyncServices" - }] -} + "value": [{ + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + }, { + "name": "SampleStorageSyncService_2", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_2", + "type": "Microsoft.StorageSync/storageSyncServices" + }, { + "name": "SampleStorageSyncService_3", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"b2c58ee5-933e-462c-8a9e-b30f2bdd8fa3\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_3", + "type": "Microsoft.StorageSync/storageSyncServices" + }] + } } } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Update.json index 38725183d6ce..c87a5bdb26b3 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/StorageSyncServices_Update.json @@ -3,7 +3,7 @@ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2018-07-01", + "api-version": "2018-10-01", "parameters": { "tags": { "Environment": "Test", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Create.json index fe748a0880e4..6ed4695412b1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Create.json @@ -4,12 +4,11 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01", + "api-version": "2018-10-01", "parameters": { "properties": {}, "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" } - }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Delete.json index 0501688779ce..e38d69d301dd 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Delete.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -13,7 +13,7 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" } }, - "204": { - } + "204": { + } } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Get.json index ac0272a4a29e..88e3f9357511 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "syncGroupName": "SampleSyncGroup_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_ListByStorageSyncService.json index fcfa4f9688ae..d16112052d9c 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_ListByStorageSyncService.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/SyncGroups_ListByStorageSyncService.json @@ -3,7 +3,7 @@ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { @@ -12,16 +12,16 @@ "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" }, "body": { - "value": [{ - "name": "SampleSyncGroup_1", - "properties": { - "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", - "syncGroupStatus": "0" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - }] -} + "value": [{ + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", + "syncGroupStatus": "0" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + }] + } } } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Abort.json index 84e34badbf83..2325f07cd2cf 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Abort.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Abort.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "workflowId": "7ffd50b3-5574-478d-9ff2-9371bc42ce68", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Get.json index 4d4d39648d21..d58e5a85339d 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_Get.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_ListByStorageSyncService.json index c5f24afc125a..e31db2d79c0d 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_ListByStorageSyncService.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/Workflows_ListByStorageSyncService.json @@ -3,7 +3,7 @@ "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", "resourceGroupName": "SampleResourceGroup_1", "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2018-07-01" + "api-version": "2018-10-01" }, "responses": { "200": { diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index fdf5225bbcde..2f389cc66529 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -2588,6 +2588,14 @@ "serverResourceId": { "$ref": "#/definitions/ResourceId", "description": "Server Resource Id." + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" } } }, @@ -3256,7 +3264,7 @@ "description": "Friendly Name" }, "backupEnabled": { - "type": "boolean", + "type": "string", "description": "Backup Enabled", "readOnly": true }, @@ -3293,6 +3301,14 @@ "minimum": 0, "maximum": 2147483647, "description": "Tier files older than days." + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" } } }, @@ -3343,6 +3359,24 @@ "syncStatus": { "type": "object", "description": "Sync Health Status" + }, + "offlineDataTransfer": { + "$ref": "#/definitions/FeatureStatus", + "description": "Offline data transfer" + }, + "offlineDataTransferStorageAccountResourceId": { + "type": "string", + "description": "Offline data transfer storage account resource ID", + "readOnly": true + }, + "offlineDataTransferStorageAccountTenantId": { + "type": "string", + "description": "Offline data transfer storage account tenant ID", + "readOnly": true + }, + "offlineDataTransferShareName": { + "type": "string", + "description": "Offline data transfer share name" } } }, From c511d1d244e6726311f44e2c7a40ccbaa65eb14d Mon Sep 17 00:00:00 2001 From: Haitao Chen Date: Sun, 18 Nov 2018 21:45:51 -0800 Subject: [PATCH 149/464] split swagger to multiple area for easy upgrade (#4461) * split swagger to multiple area for easy upgrade * update suppression due to file split --- .../blueprintAssignment.json | 533 ++++++++++++++++++ ...lueprint.json => blueprintDefinition.json} | 317 ----------- .../blueprint/resource-manager/readme.md | 18 +- 3 files changed, 543 insertions(+), 325 deletions(-) create mode 100644 specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json rename specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/{blueprint.json => blueprintDefinition.json} (81%) diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json new file mode 100644 index 000000000000..fe32bc4b17bd --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json @@ -0,0 +1,533 @@ +{ + "swagger": "2.0", + "info": { + "title": "BlueprintClient", + "description": "Azure Blueprint Client.", + "version": "2017-11-11-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}": { + "put": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_CreateOrUpdate", + "description": "Create or update a Blueprint assignment.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_Create.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + }, + { + "name": "assignment", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Assignment" + }, + "description": "assignment object to save." + } + ], + "responses": { + "201": { + "description": "Created - Blueprint assignment saved", + "schema": { + "$ref": "#/definitions/Assignment" + } + } + } + }, + "get": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_Get", + "description": "Get a Blueprint assignment.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK - Blueprint assignment retrieved.", + "schema": { + "$ref": "#/definitions/Assignment" + } + } + } + }, + "delete": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_Delete", + "description": "Delete a Blueprint assignment.", + "x-ms-examples": { + "Assignment_Delete": { + "$ref": "./examples/BlueprintAssignment_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AssignmentNameParameter" + } + ], + "responses": { + "202": { + "description": "OK - Blueprint assignment deleted.", + "schema": { + "$ref": "#/definitions/Assignment" + } + }, + "204": { + "description": "no content" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments": { + "get": { + "tags": [ + "Assignment" + ], + "operationId": "Assignments_List", + "description": "List Blueprint assignments within a subscription.", + "x-ms-examples": { + "Assignment": { + "$ref": "./examples/BlueprintAssignment_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - all Blueprint assignment retrieved.", + "schema": { + "$ref": "#/definitions/AssignmentList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Assignment": { + "type": "object", + "description": "Represents a Blueprint assignment.", + "properties": { + "identity": { + "description": "Managed Service Identity for this Blueprint assignment", + "$ref": "#/definitions/ManagedServiceIdentity" + }, + "properties": { + "description": "Properties for Assignment object.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AssignmentProperties" + } + }, + "required": [ + "identity", + "properties" + ], + "allOf": [ + { "$ref": "#/definitions/TrackedResource" } + ] + }, + "AssignmentList": { + "type": "object", + "description": "List of Blueprint assignments", + "properties": { + "value": { + "type": "array", + "description": "List of Blueprint assignments.", + "items": { + "$ref": "#/definitions/Assignment" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link to the next page of results." + } + } + }, + "ManagedServiceIdentity": { + "type": "object", + "description": "Managed Service Identity", + "properties": { + "type": { + "type": "string", + "description": "Type of the Managed Service Identity.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedServiceIdentityType", + "modelAsString": true + } + }, + "principalId": { + "type": "string", + "description": "Azure Active Directory principal ID associated with this Identity." + }, + "tenantId": { + "type": "string", + "description": "ID of the Azure Active Directory." + } + }, + "required": [ + "type" + ] + }, + "AssignmentStatus": { + "description": "The status of Blueprint assignment. This field is readonly.", + "type": "object", + "properties": { + }, + "allOf": [ + { "$ref": "#/definitions/BlueprintResourceStatusBase" } + ] + }, + "AssignmentLockSettings": { + "description": "Defines how Blueprint-managed resources will be locked.", + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Lock mode.", + "enum": [ + "None", + "AllResources" + ], + "x-ms-enum": { + "name": "AssignmentLockMode", + "modelAsString": true + } + } + } + }, + "AssignmentProperties": { + "type": "object", + "description": "Detailed properties for Assignment.", + "properties": { + "blueprintId": { + "type": "string", + "description": "ID of the Blueprint definition resource." + }, + "parameters": { + "$ref": "#/definitions/ParameterValueCollection", + "description": "Blueprint parameter values." + }, + "resourceGroups": { + "$ref": "#/definitions/ResourceGroupValueCollection", + "description": "Names and locations of resource group placeholders." + }, + "status": { + "description": "Status of Blueprint assignment. This field is readonly.", + "readOnly": true, + "$ref": "#/definitions/AssignmentStatus" + }, + "locks": { + "description": "Defines how Blueprint-managed resources will be locked.", + "$ref": "#/definitions/AssignmentLockSettings" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "State of the assignment.", + "enum": [ + "creating", + "validating", + "waiting", + "deploying", + "cancelling", + "locking", + "succeeded", + "failed", + "canceled", + "deleting" + ], + "x-ms-enum": { + "name": "AssignmentProvisioningState", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/BlueprintResourcePropertiesBase" + } + ], + "required": [ + "parameters", + "resourceGroups" + ] + }, + "ParameterValueCollection": { + "description": "A dictionary for parameters and their corresponding values.", + "type": "object", + "properties": {}, + "additionalProperties": { + "description": "keyValue pair of parameter fullfillment.", + "$ref": "#/definitions/ParameterValueBase" + } + }, + "ParameterValueBase": { + "description": "Base class for ParameterValue.", + "type": "object", + "properties": { + "description": { + "description": "Optional property, just to establish ParameterValueBase as a BaseClass.", + "type": "string" + } + } + }, + "ParameterValue": { + "description": "Value for the specified parameter.", + "type": "object", + "properties": { + "value": { + "description": "actual value." + } + }, + "required": [ "value" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretReferenceParameterValue": { + "description": "The reference to a secret, if the parameter should be protected.", + "type": "object", + "properties": { + "reference": { + "description": "Specifies the reference.", + "$ref": "#/definitions/SecretValueReference" + } + }, + "required": [ "reference" ], + "allOf": [ + { "$ref": "#/definitions/ParameterValueBase" } + ] + }, + "SecretValueReference": { + "description": "Reference to a KeyVault secret.", + "type": "object", + "properties": { + "keyVault": { + "description": "Specifies the reference to a given Azure KeyVault.", + "$ref": "#/definitions/keyVaultReference" + }, + "secretName": { + "description": "Name of the secret.", + "type": "string" + }, + "secretVersion": { + "description": "Version of the secret, (if there are multiple versions)", + "type": "string" + } + }, + "required": [ + "keyVault", + "secretName" + ] + }, + "keyVaultReference": { + "description": "Specifies the link to a KeyVault.", + "type": "object", + "properties": { + "id": { + "description": "Azure resource ID of the KeyVault.", + "type": "string" + } + }, + "required": [ "id" ] + }, + "ResourceGroupValueCollection": { + "description": "A dictionary which maps resource group placeholders to the resource groups which will be created.", + "type": "object", + "properties": {}, + "additionalProperties": { + "$ref": "#/definitions/ResourceGroupValue" + } + }, + "ResourceGroupValue": { + "description": "Represents an Azure resource group.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the resource group", + "minLength": 1, + "maxLength": 90 + }, + "location": { + "type": "string", + "description": "Location of the resource group" + } + } + }, + "TrackedResource": { + "description": "Common properties for all Azure tracked resources.", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of this Blueprint assignment.", + "x-ms-mutability": [ "read", "create" ] + } + }, + "required": [ "location" ], + "allOf": [ + { "$ref": "#/definitions/AzureResourceBase" } + ] + }, + "AzureResourceBase": { + "description": "Common properties for all Azure resources.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + } + } + }, + "BlueprintResourcePropertiesBase": { + "description": "Shared properties between all Blueprint resources.", + "type": "object", + "x-ms-external": true, + "properties": { + "displayName": { + "type": "string", + "description": "One-liner string explain this resource.", + "maxLength": 256 + }, + "description": { + "type": "string", + "description": "Multi-line explain this resource.", + "maxLength": 500 + } + } + }, + "BlueprintResourceStatusBase": { + "description": "Shared status properties between all Blueprint resources.", + "type": "object", + "properties": { + "timeCreated": { + "type": "string", + "readOnly": true, + "description": "Creation time of this blueprint." + }, + "lastModified": { + "type": "string", + "readOnly": true, + "description": "Last modified time of this blueprint." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "azure subscriptionId, which we assign the blueprint to." + }, + "AssignmentNameParameter": { + "name": "assignmentName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "name of the assignment." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client Api Version." + } + } +} \ No newline at end of file diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprint.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json similarity index 81% rename from specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprint.json rename to specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json index 9a15670774ba..2a4c12664a30 100644 --- a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprint.json +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json @@ -571,146 +571,6 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments/{assignmentName}": { - "put": { - "tags": [ - "Assignment" - ], - "operationId": "Assignments_CreateOrUpdate", - "description": "Create or update a Blueprint assignment.", - "x-ms-examples": { - "Assignment": { - "$ref": "./examples/BlueprintAssignment_Create.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/AssignmentNameParameter" - }, - { - "name": "assignment", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Assignment" - }, - "description": "assignment object to save." - } - ], - "responses": { - "201": { - "description": "Created - Blueprint assignment saved", - "schema": { - "$ref": "#/definitions/Assignment" - } - } - } - }, - "get": { - "tags": [ - "Assignment" - ], - "operationId": "Assignments_Get", - "description": "Get a Blueprint assignment.", - "x-ms-examples": { - "Assignment": { - "$ref": "./examples/BlueprintAssignment_Get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/AssignmentNameParameter" - } - ], - "responses": { - "200": { - "description": "OK - Blueprint assignment retrieved.", - "schema": { - "$ref": "#/definitions/Assignment" - } - } - } - }, - "delete": { - "tags": [ - "Assignment" - ], - "operationId": "Assignments_Delete", - "description": "Delete a Blueprint assignment.", - "x-ms-examples": { - "Assignment_Delete": { - "$ref": "./examples/BlueprintAssignment_Delete.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/AssignmentNameParameter" - } - ], - "responses": { - "202": { - "description": "OK - Blueprint assignment deleted.", - "schema": { - "$ref": "#/definitions/Assignment" - } - }, - "204": { - "description": "no content" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Blueprint/blueprintAssignments": { - "get": { - "tags": [ - "Assignment" - ], - "operationId": "Assignments_List", - "description": "List Blueprint assignments within a subscription.", - "x-ms-examples": { - "Assignment": { - "$ref": "./examples/BlueprintAssignment_List.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK - all Blueprint assignment retrieved.", - "schema": { - "$ref": "#/definitions/AssignmentList" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/providers/Microsoft.Blueprint/operations": { "get": { "tags": [ @@ -787,28 +647,6 @@ "kind" ] }, - "Assignment": { - "type": "object", - "description": "Represents a Blueprint assignment.", - "properties": { - "identity": { - "description": "Managed Service Identity for this Blueprint assignment", - "$ref": "#/definitions/ManagedServiceIdentity" - }, - "properties": { - "description": "Properties for Assignment object.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AssignmentProperties" - } - }, - "required": [ - "identity", - "properties" - ], - "allOf": [ - { "$ref": "#/definitions/TrackedResource" } - ] - }, "PublishedBlueprint": { "type": "object", "description": "Represents a published Blueprint.", @@ -884,24 +722,6 @@ } } }, - "AssignmentList": { - "type": "object", - "description": "List of Blueprint assignments", - "properties": { - "value": { - "type": "array", - "description": "List of Blueprint assignments.", - "items": { - "$ref": "#/definitions/Assignment" - } - }, - "nextLink": { - "type": "string", - "readOnly": true, - "description": "Link to the next page of results." - } - } - }, "ResourceProviderOperationList": { "description": "Result of the request to list operations.", "readOnly": true, @@ -946,36 +766,6 @@ } } }, - "ManagedServiceIdentity": { - "type": "object", - "description": "Managed Service Identity", - "properties": { - "type": { - "type": "string", - "description": "Type of the Managed Service Identity.", - "enum": [ - "None", - "SystemAssigned", - "UserAssigned" - ], - "x-ms-enum": { - "name": "ManagedServiceIdentityType", - "modelAsString": true - } - }, - "principalId": { - "type": "string", - "description": "Azure Active Directory principal ID associated with this Identity." - }, - "tenantId": { - "type": "string", - "description": "ID of the Azure Active Directory." - } - }, - "required": [ - "type" - ] - }, "SharedBlueprintProperties": { "description": "Shared Schema for both blueprintProperties and publishedBlueprintProperties.", "type": "object", @@ -1062,90 +852,6 @@ { "$ref": "#/definitions/BlueprintResourceStatusBase" } ] }, - "AssignmentStatus": { - "description": "The status of Blueprint assignment. This field is readonly.", - "type": "object", - "properties": { - }, - "allOf": [ - { "$ref": "#/definitions/BlueprintResourceStatusBase" } - ] - }, - "AssignmentLockSettings": { - "description": "Defines how Blueprint-managed resources will be locked.", - "type": "object", - "properties": { - "mode": { - "type": "string", - "description": "Lock mode.", - "enum": [ - "None", - "AllResources" - ], - "x-ms-enum": { - "name": "AssignmentLockMode", - "modelAsString": true - } - } - } - }, - "AssignmentProperties": { - "type": "object", - "description": "Detailed properties for Assignment.", - "properties": { - "blueprintId": { - "type": "string", - "description": "ID of the Blueprint definition resource." - }, - "parameters": { - "$ref": "#/definitions/ParameterValueCollection", - "description": "Blueprint parameter values." - }, - "resourceGroups": { - "$ref": "#/definitions/ResourceGroupValueCollection", - "description": "Names and locations of resource group placeholders." - }, - "status": { - "description": "Status of Blueprint assignment. This field is readonly.", - "readOnly": true, - "$ref": "#/definitions/AssignmentStatus" - }, - "locks": { - "description": "Defines how Blueprint-managed resources will be locked.", - "$ref": "#/definitions/AssignmentLockSettings" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "State of the assignment.", - "enum": [ - "creating", - "validating", - "waiting", - "deploying", - "cancelling", - "locking", - "succeeded", - "failed", - "canceled", - "deleting" - ], - "x-ms-enum": { - "name": "AssignmentProvisioningState", - "modelAsString": true - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/BlueprintResourcePropertiesBase" - } - ], - "required": [ - "parameters", - "resourceGroups" - ] - }, "TemplateArtifactProperties": { "type": "object", "description": "Properties of a Template Artifact.", @@ -1508,21 +1214,6 @@ } } }, - "TrackedResource": { - "description": "Common properties for all Azure tracked resources.", - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The location of this Blueprint assignment.", - "x-ms-mutability": [ "read", "create" ] - } - }, - "required": [ "location" ], - "allOf": [ - { "$ref": "#/definitions/AzureResourceBase" } - ] - }, "AzureResourceBase": { "description": "Common properties for all Azure resources.", "type": "object", @@ -1635,14 +1326,6 @@ "x-ms-parameter-location": "method", "description": "version of the published blueprint." }, - "AssignmentNameParameter": { - "name": "assignmentName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method", - "description": "name of the assignment." - }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/blueprint/resource-manager/readme.md b/specification/blueprint/resource-manager/readme.md index e13d9aaf0dfd..1c86463570e2 100644 --- a/specification/blueprint/resource-manager/readme.md +++ b/specification/blueprint/resource-manager/readme.md @@ -34,7 +34,8 @@ These settings apply only when `--tag=package-2017-11-preview` is specified on t ``` yaml $(tag) == 'package-2017-11-preview' input-file: -- Microsoft.Blueprint/preview/2017-11-11-preview/blueprint.json +- Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json +- Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json ``` --- @@ -121,18 +122,19 @@ java: ``` yaml directive: - - from: blueprint.json - suppress: R3006 # BodyTopLevelProperties/R3006/RPCViolation - reason: properties etag defined as eTag in model - - from: blueprint.json - suppress: R3026 # Tracked resource 'XXX' must have patch operation that at least supports the update of tags. + - from: blueprintAssignment.json + suppress: TrackedResourcePatchOperation reason: Assignment is proxy resource. - - from: blueprint.json + - from: blueprintDefinition.json suppress: UniqueResourcePaths where: $.paths reason: Microsoft.Management is a proxy resource provider - - from: blueprint.json + - from: blueprintAssignment.json suppress: OperationsAPIImplementation where: $.paths reason: OperationsAPI for Microsoft.Management is out of scope. + - from: blueprintDefinition.json + suppress: OperationsAPIImplementation + where: $.paths + reason: OperationsAPI for Microsoft.Management is out of scope. ``` From c4244e69a8da780083f6c8430f47c80f3d6154db Mon Sep 17 00:00:00 2001 From: Sergey Shandar Date: Sun, 18 Nov 2018 21:56:01 -0800 Subject: [PATCH 150/464] Update OAV (#4496) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 6d0dd1e06fee..270c65eef6a1 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "json-schema-ref-parser": "^3.1.2", "mocha": "*", "oad": "^0.1.11", - "oav": "^0.6.2", + "oav": "^0.8.1", "request": "^2.61.0", "request-promise-native": "^1.0.5", "z-schema": "^3.16.1" From 633272e674bf252baaa0e2aed5125381e4e97d7c Mon Sep 17 00:00:00 2001 From: Xiangzhi Sheng Date: Tue, 20 Nov 2018 01:16:49 +0800 Subject: [PATCH 151/464] Add new resource provider Microsoft.EngagementFabric (#4480) * Add new resource provider Microsoft.EngagementFabric * Rename directory `2018-09-01-preview` to `2018-09-01` * Fix incorrect folder name * Add file read.typescript.md * Add readme.go.md * Fix incorrect package name --- .../preview/2018-09-01/EngagementFabric.json | 1280 +++++++++++++++++ .../AccountsCreateOrUpdateExample.json | 28 + .../examples/AccountsDeleteExample.json | 11 + .../examples/AccountsGetExample.json | 22 + .../AccountsListByResourceGroupExample.json | 45 + .../AccountsListChannelTypesExample.json | 41 + .../examples/AccountsListExample.json | 44 + .../examples/AccountsListKeysExample.json | 36 + .../AccountsRegenerateKeyExample.json | 19 + .../examples/AccountsUpdateExample.json | 30 + .../ChannelsCreateOrUpdateExample.json | 42 + .../examples/ChannelsDeleteExample.json | 12 + .../examples/ChannelsGetExample.json | 29 + .../examples/ChannelsListExample.json | 48 + .../CheckNameAvailabilityExample.json | 17 + .../examples/OperationsListExample.json | 121 ++ .../2018-09-01/examples/SKUsListExample.json | 80 ++ .../resource-manager/readme.go.md | 26 + .../resource-manager/readme.md | 124 ++ .../resource-manager/readme.nodejs.md | 15 + .../resource-manager/readme.ruby.md | 19 + .../resource-manager/readme.typescript.md | 13 + 22 files changed, 2102 insertions(+) create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsCreateOrUpdateExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsDeleteExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsGetExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListByResourceGroupExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListChannelTypesExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListKeysExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsRegenerateKeyExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsUpdateExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsCreateOrUpdateExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsDeleteExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsGetExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsListExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/CheckNameAvailabilityExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/OperationsListExample.json create mode 100644 specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/SKUsListExample.json create mode 100644 specification/engagementfabric/resource-manager/readme.go.md create mode 100644 specification/engagementfabric/resource-manager/readme.md create mode 100644 specification/engagementfabric/resource-manager/readme.nodejs.md create mode 100644 specification/engagementfabric/resource-manager/readme.ruby.md create mode 100644 specification/engagementfabric/resource-manager/readme.typescript.md diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json new file mode 100644 index 000000000000..0f3f01793fb8 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json @@ -0,0 +1,1280 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-09-01-preview", + "title": "EngagementFabric", + "description": "Microsoft Customer Engagement Fabric" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "Get the EngagementFabric account", + "operationId": "Accounts_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsGetExample": { + "$ref": "./examples/AccountsGetExample.json" + } + } + }, + "put": { + "tags": [ + "Accounts" + ], + "summary": "Create or Update the EngagementFabric account", + "operationId": "Accounts_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "account", + "in": "body", + "description": "The EngagementFabric account description", + "required": true, + "schema": { + "$ref": "#/definitions/Account" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsCreateOrUpdateExample": { + "$ref": "./examples/AccountsCreateOrUpdateExample.json" + } + } + }, + "delete": { + "tags": [ + "Accounts" + ], + "summary": "Delete the EngagementFabric account", + "operationId": "Accounts_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsDeleteExample": { + "$ref": "./examples/AccountsDeleteExample.json" + } + } + }, + "patch": { + "tags": [ + "Accounts" + ], + "summary": "Update EngagementFabric account", + "operationId": "Accounts_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "accountPatch", + "in": "body", + "description": "The account patch", + "required": true, + "schema": { + "$ref": "#/definitions/AccountPatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Account" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsUpdateExample": { + "$ref": "./examples/AccountsUpdateExample.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/Accounts": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "List the EngagementFabric accounts in given subscription", + "operationId": "Accounts_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsListExample": { + "$ref": "./examples/AccountsListExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts": { + "get": { + "tags": [ + "Accounts" + ], + "summary": "List EngagementFabric accounts in given resource group", + "operationId": "Accounts_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsListByResourceGroupExample": { + "$ref": "./examples/AccountsListByResourceGroupExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listKeys": { + "post": { + "tags": [ + "Accounts" + ], + "summary": "List keys of the EngagementFabric account", + "operationId": "Accounts_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KeyDescriptionList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsListKeysExample": { + "$ref": "./examples/AccountsListKeysExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/regenerateKey": { + "post": { + "tags": [ + "Accounts" + ], + "summary": "Regenerate key of the EngagementFabric account", + "operationId": "Accounts_RegenerateKey", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameter", + "in": "body", + "description": "Parameters specifying the key to be regenerated", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameter" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/KeyDescription" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsRegenerateKeyExample": { + "$ref": "./examples/AccountsRegenerateKeyExample.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/listChannelTypes": { + "post": { + "tags": [ + "Accounts" + ], + "summary": "List available EngagementFabric channel types and functions", + "operationId": "Accounts_ListChannelTypes", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ChannelTypeDescriptionList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AccountsListChannelTypesExample": { + "$ref": "./examples/AccountsListChannelTypesExample.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels/{channelName}": { + "get": { + "tags": [ + "Channels" + ], + "summary": "Get the EngagementFabric channel", + "operationId": "Channels_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ChannelNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Channel" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ChannelsGetExample": { + "$ref": "./examples/ChannelsGetExample.json" + } + } + }, + "put": { + "tags": [ + "Channels" + ], + "summary": "Create or Update the EngagementFabric channel", + "operationId": "Channels_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ChannelNameParameter" + }, + { + "name": "channel", + "in": "body", + "description": "The EngagementFabric channel description", + "required": true, + "schema": { + "$ref": "#/definitions/Channel" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Channel" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ChannelsCreateOrUpdateExample": { + "$ref": "./examples/ChannelsCreateOrUpdateExample.json" + } + } + }, + "delete": { + "tags": [ + "Channels" + ], + "summary": "Delete the EngagementFabric channel", + "operationId": "Channels_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "channelName", + "in": "path", + "description": "The EngagementFabric channel name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ChannelsDeleteExample": { + "$ref": "./examples/ChannelsDeleteExample.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/Accounts/{accountName}/Channels": { + "get": { + "tags": [ + "Channels" + ], + "summary": "List the EngagementFabric channels", + "operationId": "Channels_ListByAccount", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ChannelList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ChannelsListExample": { + "$ref": "./examples/ChannelsListExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EngagementFabric/checkNameAvailability": { + "post": { + "tags": [ + "NameAvailability" + ], + "summary": "Check availability of EngagementFabric resource", + "operationId": "CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameter describing the name to be checked", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameter" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CheckNameAvailabilityExample": { + "$ref": "./examples/CheckNameAvailabilityExample.json" + } + } + } + }, + "/providers/Microsoft.EngagementFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List operation of EngagementFabric resources", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OperationsListExample": { + "$ref": "./examples/OperationsListExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EngagementFabric/skus": { + "get": { + "tags": [ + "Skus" + ], + "summary": "List available SKUs of EngagementFabric resource", + "operationId": "SKUs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SkuDescriptionList" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SKUsListExample": { + "$ref": "./examples/SKUsListExample.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "SKU": { + "description": "The EngagementFabric SKU", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU", + "type": "string" + }, + "tier": { + "description": "The price tier of the SKU", + "type": "string" + } + } + }, + "Resource": { + "description": "The base model for Azure resource", + "type": "object", + "properties": { + "id": { + "description": "The ID of the resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The fully qualified type of the resource", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The base model for the tracked Azure resource", + "required": [ + "location", + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The location of the resource", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "description": "The tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/SKU", + "description": "The SKU of the resource" + } + } + }, + "Account": { + "description": "The EngagementFabric account", + "required": [ + "location", + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ] + }, + "CloudError": { + "description": "The default error response", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Content of the error" + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "Content of the default error response", + "type": "object", + "properties": { + "code": { + "description": "The error code", + "type": "string" + }, + "message": { + "description": "The error message", + "type": "string" + }, + "target": { + "description": "The target of the particular error", + "type": "string" + }, + "details": { + "description": "The list of additional details", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "x-ms-external": true + }, + "AccountPatch": { + "description": "The patch of EngagementFabric account", + "type": "object", + "properties": { + "tags": { + "description": "The tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "AccountList": { + "description": "The list of the EngagementFabric accounts", + "type": "object", + "properties": { + "value": { + "description": "EngagementFabric accounts", + "type": "array", + "items": { + "$ref": "#/definitions/Account" + } + } + } + }, + "KeyDescriptionList": { + "description": "The list of the EngagementFabric account keys", + "type": "object", + "properties": { + "value": { + "description": "Account keys", + "type": "array", + "items": { + "$ref": "#/definitions/KeyDescription" + }, + "readOnly": true + } + } + }, + "KeyDescription": { + "description": "The description of the EngagementFabric account key", + "type": "object", + "properties": { + "name": { + "description": "The name of the key", + "type": "string", + "readOnly": true + }, + "rank": { + "$ref": "#/definitions/KeyRank", + "description": "The rank of the key", + "readOnly": true + }, + "value": { + "description": "The value of the key", + "type": "string", + "readOnly": true + } + } + }, + "RegenerateKeyParameter": { + "description": "The parameter to regenerate single EngagementFabric account key", + "required": [ + "name", + "rank" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of key to be regenerated", + "type": "string" + }, + "rank": { + "$ref": "#/definitions/KeyRank", + "description": "The rank of the key to be regenerated" + } + } + }, + "ChannelTypeDescriptionList": { + "description": "List of the EngagementFabric channel descriptions", + "type": "object", + "properties": { + "value": { + "description": "Channel descriptions", + "type": "array", + "items": { + "$ref": "#/definitions/ChannelTypeDescription" + } + } + } + }, + "ChannelTypeDescription": { + "description": "EngagementFabric channel description", + "type": "object", + "properties": { + "channelType": { + "description": "Channel type", + "type": "string" + }, + "channelDescription": { + "description": "Text description for the channel", + "type": "string" + }, + "channelFunctions": { + "description": "All the available functions for the channel", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ChannelProperties": { + "description": "The EngagementFabric channel properties", + "required": [ + "channelType" + ], + "type": "object", + "properties": { + "channelType": { + "description": "The channel type", + "type": "string" + }, + "channelFunctions": { + "description": "The functions to be enabled for the channel", + "type": "array", + "items": { + "type": "string" + } + }, + "credentials": { + "description": "The channel credentials", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ProxyOnlyResource": { + "description": "The base model for the proxy-only Azure resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Channel": { + "description": "The EngagementFabric channel", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ChannelProperties", + "description": "The properties of the channel", + "x-ms-client-flatten": true + } + } + }, + "ChannelList": { + "description": "The list of the EngagementFabric channels", + "type": "object", + "properties": { + "value": { + "description": "EngagementFabric channels", + "type": "array", + "items": { + "$ref": "#/definitions/Channel" + } + } + } + }, + "CheckNameAvailabilityParameter": { + "description": "The parameter for name availability check", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name to be checked", + "type": "string" + }, + "type": { + "description": "The fully qualified resource type for the name to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResult": { + "description": "The result of name availability check", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The name to be checked", + "type": "boolean", + "readOnly": true + }, + "reason": { + "$ref": "#/definitions/CheckNameUnavailableReason", + "description": "The reason if name is unavailable", + "readOnly": true + }, + "message": { + "description": "The message if name is unavailable", + "type": "string", + "readOnly": true + } + } + }, + "OperationList": { + "description": "The list of the EngagementFabric operations", + "type": "object", + "properties": { + "value": { + "description": "The EngagementFabric operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + } + } + }, + "Operation": { + "description": "The EngagementFabric operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the EngagementFabric operation", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The display content of the EngagementFabric operation", + "readOnly": true + } + } + }, + "OperationDisplay": { + "description": "The display information of the EngagementFabric operation", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider namespace of the EngagementFabric operation", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource type of the EngagementFabric operation", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The name of the EngagementFabric operation", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the EngagementFabric operation", + "type": "string", + "readOnly": true + } + } + }, + "SkuDescriptionList": { + "description": "The list of the EngagementFabric SKU descriptions", + "type": "object", + "properties": { + "value": { + "description": "SKU descriptions", + "type": "array", + "items": { + "$ref": "#/definitions/SkuDescription" + }, + "readOnly": true + } + } + }, + "SkuDescription": { + "description": "The EngagementFabric SKU description of given resource type", + "type": "object", + "properties": { + "resourceType": { + "description": "The fully qualified resource type", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the SKU", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The price tier of the SKU", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "The set of locations that the SKU is available", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "Locations and zones", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfoItem" + }, + "readOnly": true + }, + "restrictions": { + "description": "The restrictions because of which SKU cannot be used", + "type": "array", + "items": { + "type": "object" + }, + "readOnly": true + } + } + }, + "SkuLocationInfoItem": { + "description": "The Locations and zones info for SKU", + "type": "object", + "properties": { + "location": { + "description": "The available location of the SKU", + "type": "string" + }, + "zones": { + "description": "The available zone of the SKU", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "KeyRank": { + "description": "The rank of the EngagementFabric account key", + "enum": [ + "PrimaryKey", + "SecondaryKey" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyRank", + "modelAsString": true + } + }, + "CheckNameUnavailableReason": { + "description": "The reason of name availability result", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "x-ms-enum": { + "name": "CheckNameUnavailableReason", + "modelAsString": true + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription ID", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "description": "Account Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ChannelNameParameter": { + "name": "channelName", + "in": "path", + "description": "Channel Name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "API version", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsCreateOrUpdateExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsCreateOrUpdateExample.json new file mode 100644 index 000000000000..0ff2ae0fa1c1 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsCreateOrUpdateExample.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview", + "account": { + "location": "WestUS", + "sku": { + "name": "B1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WestUS", + "sku": { + "name": "B1", + "tier": "Basic" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsDeleteExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsDeleteExample.json new file mode 100644 index 000000000000..18383bf9c693 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsDeleteExample.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsGetExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsGetExample.json new file mode 100644 index 000000000000..b5efaaa01572 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsGetExample.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "WestUS", + "sku": { + "name": "B1", + "tier": "Basic" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListByResourceGroupExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListByResourceGroupExample.json new file mode 100644 index 000000000000..2fb6fec5f08d --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListByResourceGroupExample.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WestUS", + "sku": { + "name": "B1", + "tier": "Basic" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + }, + { + "location": "WestUS", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount2", + "name": "ExampleAccount2", + "type": "Microsoft.EngagementFabric/Accounts" + }, + { + "location": "WestUS", + "sku": { + "name": "P1", + "tier": "Premium" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount3", + "name": "ExampleAccount3", + "type": "Microsoft.EngagementFabric/Accounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListChannelTypesExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListChannelTypesExample.json new file mode 100644 index 000000000000..55ca1947f54a --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListChannelTypesExample.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "channelType": "MockChannel1", + "channelDescription": "Description of mockChannel1", + "channelFunctions": [ + "MockFunction1", + "MockFunction2" + ] + }, + { + "channelType": "MockChannel2", + "channelDescription": "Description of mockChannel2", + "channelFunctions": [ + "MockFunction1", + "MockFunction3" + ] + }, + { + "channelType": "MockChannel3", + "channelDescription": "Description of mockChannel3", + "channelFunctions": [ + "MockFunction1", + "MockFunction2", + "MockFunction3" + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListExample.json new file mode 100644 index 000000000000..df252196096f --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListExample.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WestUS", + "sku": { + "name": "B1", + "tier": "Basic" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + }, + { + "location": "WestUS", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount2", + "name": "ExampleAccount2", + "type": "Microsoft.EngagementFabric/Accounts" + }, + { + "location": "WestUS", + "sku": { + "name": "P1", + "tier": "Premium" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount3", + "name": "ExampleAccount3", + "type": "Microsoft.EngagementFabric/Accounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListKeysExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListKeysExample.json new file mode 100644 index 000000000000..b4068d389f9f --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsListKeysExample.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Full", + "rank": "PrimaryKey", + "value": "" + }, + { + "name": "Full", + "rank": "SecondaryKey", + "value": "" + }, + { + "name": "Device", + "rank": "PrimaryKey", + "value": "" + }, + { + "name": "Device", + "rank": "SecondaryKey", + "value": "" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsRegenerateKeyExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsRegenerateKeyExample.json new file mode 100644 index 000000000000..7be181bd6dc9 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsRegenerateKeyExample.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview", + "name": "Full", + "rank": "PrimaryKey" + }, + "responses": { + "200": { + "body": { + "name": "Full", + "rank": "PrimaryKey", + "value": "" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsUpdateExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsUpdateExample.json new file mode 100644 index 000000000000..84b2fa0c8497 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/AccountsUpdateExample.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview", + "accountPatch": { + "tags": { + "tagName": "tagValue" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WestUS", + "tags": { + "tagName": "tagValue" + }, + "sku": { + "name": "B1", + "tier": "Basic" + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsCreateOrUpdateExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsCreateOrUpdateExample.json new file mode 100644 index 000000000000..fcb3560aeb3e --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsCreateOrUpdateExample.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "channelName": "ExampleChannel", + "api-version": "2018-09-01-preview", + "channel": { + "properties": { + "channelType": "MockChannel", + "channelFunctions": [ + "MockFunction1", + "MockFunction2" + ], + "credentials": { + "AppId": "exampleApp", + "AppKey": "exampleAppKey" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "channelType": "MockChannel", + "channelFunctions": [ + "MockFunction1", + "MockFunction2" + ], + "credentials": { + "AppId": "exampleApp", + "AppKey": "" + } + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel", + "name": "ExampleChannel", + "type": "Microsoft.EngagementFabric/Accounts/Channels" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsDeleteExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsDeleteExample.json new file mode 100644 index 000000000000..554f188988cd --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsDeleteExample.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "channelName": "ExampleChannel", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsGetExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsGetExample.json new file mode 100644 index 000000000000..f653585d53fe --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsGetExample.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "channelName": "ExampleChannel", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "channelType": "MockChannel", + "channelFunctions": [ + "MockFunction1", + "MockFunction2" + ], + "credentials": { + "AppId": "exampleApp", + "AppKey": "" + } + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel", + "name": "ExampleChannel", + "type": "Microsoft.EngagementFabric/Accounts/Channels" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsListExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsListExample.json new file mode 100644 index 000000000000..b364e7818c94 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/ChannelsListExample.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "resourceGroupName": "ExampleRg", + "accountName": "ExampleAccount", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "channelType": "MockChannel", + "channelFunctions": [ + "MockFunction1", + "MockFunction2" + ], + "credentials": { + "AppId": "exampleApp", + "AppKey": "" + } + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel", + "name": "ExampleChannel", + "type": "Microsoft.EngagementFabric/Accounts/Channels" + }, + { + "properties": { + "channelType": "MockChannel2", + "channelFunctions": [ + "MockFunction1", + "MockFunction3" + ], + "credentials": { + "AppId": "exampleApp2", + "AppKey": "" + } + }, + "id": "subscriptions/EDBF0095-A524-4A84-95FB-F72DA41AA6A1/resourceGroups/ExampleRg/providers/Microsoft.EngagementFabric/Accounts/ExampleAccount/Channels/ExampleChannel2", + "name": "ExampleChannel2", + "type": "Microsoft.EngagementFabric/Accounts/Channels" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/CheckNameAvailabilityExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/CheckNameAvailabilityExample.json new file mode 100644 index 000000000000..355462f31134 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/CheckNameAvailabilityExample.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "api-version": "2018-09-01-preview", + "name": "ExampleAccount", + "type": "Microsoft.EngagementFabric/Accounts" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Account 'ExampleAccount' already exists" + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/OperationsListExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/OperationsListExample.json new file mode 100644 index 000000000000..7b2548520167 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/OperationsListExample.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EngagementFabric/Accounts/read", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "List or get the EngagementFabric account", + "description": "List or get the EngagementFabric account" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/write", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "Create or update the EngagementFabric account", + "description": "Create or update the EngagementFabric account" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/delete", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "Delete the EngagementFabric account", + "description": "Delete the EngagementFabric account" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/ListKeys/action", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "Get all keys of the EngagementFabric account", + "description": "Get all keys of the EngagementFabric account" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/RegenerateKey/action", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "Regenerate the EngagementFabric account key", + "description": "Regenerate the EngagementFabric account key" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/ListChannelTypes/action", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "List available EngagementFabric channel types and functions", + "description": "List available EngagementFabric channel types and functions" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/Channels/read", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Channels", + "operation": "List or get the EngagementFabric channel", + "description": "List or get the EngagementFabric channel" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/Channels/write", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Channels", + "operation": "Create or update the EngagementFabric channel", + "description": "Create or update the EngagementFabric channel" + } + }, + { + "name": "Microsoft.EngagementFabric/Accounts/Channels/delete", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Channels", + "operation": "Delete the EngagementFabric channel", + "description": "Delete the EngagementFabric channel" + } + }, + { + "name": "Microsoft.EngagementFabric/checkNameAvailability/action", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "Check name availability", + "description": "Check name availability" + } + }, + { + "name": "Microsoft.EngagementFabric/operations/read", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Operations", + "operation": "List available operations", + "description": "List available operations" + } + }, + { + "name": "Microsoft.EngagementFabric/skus/read", + "display": { + "provider": "Microsoft Customer Engagement Fabric", + "resource": "Accounts", + "operation": "List available SKUs", + "description": "List available SKUs" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/SKUsListExample.json b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/SKUsListExample.json new file mode 100644 index 000000000000..d96c97992f11 --- /dev/null +++ b/specification/engagementfabric/resource-manager/Microsoft.EngagementFabric/preview/2018-09-01/examples/SKUsListExample.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "EDBF0095-A524-4A84-95FB-F72DA41AA6A1", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.EngagementFabric/Accounts", + "name": "B1", + "tier": "Basic", + "locations": [ + "Central US", + "North Europe", + "West Europe" + ], + "locationInfo": [ + { + "location": "Central US" + }, + { + "location": "North Europe" + }, + { + "location": "West Europe" + } + ], + "restrictions": [] + }, + { + "resourceType": "Microsoft.EngagementFabric/Accounts", + "name": "S1", + "tier": "Standard", + "locations": [ + "Central US", + "North Europe", + "West Europe" + ], + "locationInfo": [ + { + "location": "Central US" + }, + { + "location": "North Europe" + }, + { + "location": "West Europe" + } + ], + "restrictions": [] + }, + { + "resourceType": "Microsoft.EngagementFabric/Accounts", + "name": "P1", + "tier": "Premium", + "locations": [ + "Central US", + "North Europe", + "West Europe" + ], + "locationInfo": [ + { + "location": "Central US" + }, + { + "location": "North Europe" + }, + { + "location": "West Europe" + } + ], + "restrictions": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/readme.go.md b/specification/engagementfabric/resource-manager/readme.go.md new file mode 100644 index 000000000000..6f865d9c85aa --- /dev/null +++ b/specification/engagementfabric/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: engagementfabric + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09-preview +``` + +### Tag: package-2018-09-preview and go + +These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/readme.md b/specification/engagementfabric/resource-manager/readme.md new file mode 100644 index 000000000000..2d491db5a1ce --- /dev/null +++ b/specification/engagementfabric/resource-manager/readme.md @@ -0,0 +1,124 @@ +# EngagementFabric + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Engagement Fabric. + + + +--- +## Getting Started +To build the SDK for Azure Engagement Fabric, 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 Engagement Fabric API. + +``` yaml +openapi-type: arm +tag: package-2018-09-preview +``` + + +### Tag: package-2018-09-preview + +These settings apply only when `--tag=package-2018-09-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-09-preview' +input-file: +- Microsoft.EngagementFabric/preview/2018-09-01/EngagementFabric.json +``` + + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_engagement_fabric'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.EngagementFabric + output-folder: $(csharp-sdks-folder)/EngagementFabric/Management.EngagementFabric/Generated + clear-output-folder: true +``` + + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.engagementfabric + package-name: azure-mgmt-engagementfabric + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-engagementfabric/azure/mgmt/engagementfabric +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-engagementfabric +``` + + +## Go + +See configuration in [readme.go.md](./readme.go.md) + + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.engagementfabric +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-engagementfabric +``` \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/readme.nodejs.md b/specification/engagementfabric/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..07412c03c3e4 --- /dev/null +++ b/specification/engagementfabric/resource-manager/readme.nodejs.md @@ -0,0 +1,15 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-engagementfabric + package-version: 1.0.0-preview + output-folder: $(node-sdks-folder)/lib/services/engagementFabricManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/readme.ruby.md b/specification/engagementfabric/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..c95bcf0ca4d3 --- /dev/null +++ b/specification/engagementfabric/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_engagementfabric +package-version: "0.16.1" +azure-arm: true +``` + +### Tag: package-2018-09-preview and ruby + +These settings apply only when `--tag=package-2018-09-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-09-preview' && $(ruby) +namespace: "Azure::EngagementFabric::Mgmt::V2018_09_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_engagementfabric/lib +``` \ No newline at end of file diff --git a/specification/engagementfabric/resource-manager/readme.typescript.md b/specification/engagementfabric/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..d0aac6a76647 --- /dev/null +++ b/specification/engagementfabric/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-engagementfabric" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-engagementfabric" + payload-flattening-threshold: 1 + generate-metadata: true +``` From d8a6649b0becb3af50c79da9d4c3b7218dd641e5 Mon Sep 17 00:00:00 2001 From: Anand <44665487+bingisbestest@users.noreply.github.com> Date: Tue, 20 Nov 2018 00:01:14 +0530 Subject: [PATCH 152/464] Adding API For QnAMaker v4.0 (#4377) * adding v4 * Addressing comments * Use Endpoint Template * Switch to parameter * Formatting * linter method issue * examples ALTS * example keys * ops example * Add kb example * Adding Create Kb Example * Download KB Example * Fix Namespaces * model validation errors * change to octet stream * add consume/produces * remove response body * fix set alt example * Update Operation Ids * Fix case of description * Enums as strings * Adding md files for other langs * Update Ruby readme * remove x-enumNames --- .../data-plane/QnAMaker/readme.go.md | 26 + .../data-plane/QnAMaker/readme.md | 99 ++ .../data-plane/QnAMaker/readme.nodejs.md | 14 + .../data-plane/QnAMaker/readme.ruby.md | 26 + .../data-plane/QnAMaker/readme.typescript.md | 12 + .../QnAMaker/stable/v4.0/QnAMaker.json | 1261 +++++++++++++++++ .../v4.0/examples/SuccessfulCreateKb.json | 57 + .../stable/v4.0/examples/SuccessfulDelKb.json | 13 + .../v4.0/examples/SuccessfulDownloadKb.json | 374 +++++ .../v4.0/examples/SuccessfulGetAlts.json | 34 + .../v4.0/examples/SuccessfulGetEpKeys.json | 18 + .../stable/v4.0/examples/SuccessfulGetKb.json | 30 + .../v4.0/examples/SuccessfulGetOps.json | 21 + .../v4.0/examples/SuccessfulKbsResponse.json | 33 + .../stable/v4.0/examples/SuccessfulPubKb.json | 12 + .../stable/v4.0/examples/SuccessfulRepKb.json | 30 + .../v4.0/examples/SuccessfulSetAlts.json | 33 + .../v4.0/examples/SuccessfulSetEpKeys.json | 19 + .../stable/v4.0/examples/SuccessfulUpdKb.json | 103 ++ 19 files changed, 2215 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.go.md create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.md create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDelKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDownloadKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetAlts.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetEpKeys.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetOps.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulKbsResponse.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulPubKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetAlts.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpKeys.json create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md new file mode 100644 index 000000000000..412a87aa9eac --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: qnamaker + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_4_0 +``` + +### Tag: release_4_0 and go + +These settings apply only when `--tag=release_4_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_4_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v4.0/$(namespace) +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.md new file mode 100644 index 000000000000..aac4f3cd0d86 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.md @@ -0,0 +1,99 @@ +# Cognitive Services QnAMaker SDK + +> see https://aka.ms/autorest + +Configuration for generating QnAMaker SDK. + +The current release is `release_4_0`. + +``` yaml + +tag: release_4_0 +add-credentials: true +openapi-type: data-plane +``` +# Releases + +### Release 4.0 +These settings apply only when `--tag=release_4_0` is specified on the command line. + +``` yaml $(tag) == 'release_4_0' +input-file: stable/v4.0/QnAMaker.json +``` + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_qnamaker'] +``` + + +## CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Knowledge/QnAMaker/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.knowledge.qnamaker + package-name: azure-cognitiveservices-knowledge-qnamaker + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-qnamaker/azure/cognitiveservices/knowledge/qnamaker +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-knowledge-qnamaker +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.knowledge.qnamaker + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/knowledge/qnamaker + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md new file mode 100644 index 000000000000..c5b34edc925f --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-cognitiveservices-qnamaker + output-folder: $(node-sdks-folder)/lib/services/cognitiveServices/qnamaker + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md new file mode 100644 index 000000000000..235b78174402 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_cognitiveservices_qnamaker +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: release_4_0 +``` + +### Tag: release_4_0 and ruby + +These settings apply only when `--tag=release_4_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_4_0' && $(ruby) +namespace: "Azure::CognitiveServices::QnAMaker::V4" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_qnamaker/lib +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md new file mode 100644 index 000000000000..5639b97a3794 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-qnamaker" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-qnamaker" + azure-arm: false + generate-metadata: true +``` diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json new file mode 100644 index 000000000000..e64b89fcfb7e --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -0,0 +1,1261 @@ +{ + "swagger": "2.0", + "info": { + "version": "4.0", + "title": "QnAMaker Client", + "description": "An API for QnAMaker Service" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/qnamaker/v4.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "paths": { + "/endpointkeys": { + "get": { + "summary": "Gets endpoint keys for an endpoint", + "operationId": "Endpoint_GetKeys", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Response with endpoint info in it.", + "schema": { + "$ref": "#/definitions/EndpointKeysDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetEpKeys.json" + } + } + } + }, + "/endpointkeys/{keyType}": { + "patch": { + "tags": [ + "EndpointKeys" + ], + "summary": "Re-generates an endpoint key.", + "operationId": "Endpoint_RefreshKeys", + "parameters": [ + { + "$ref": "#/parameters/KeyType" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the endpoint keys generated.", + "schema": { + "$ref": "#/definitions/EndpointKeysDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetEpKeys.json" + } + } + } + }, + "/alterations": { + "get": { + "tags": [ + "Alterations" + ], + "summary": "Download alterations from runtime.", + "operationId": "Alterations_Get", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Alterations data.", + "schema": { + "$ref": "#/definitions/WordAlterationsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetAlts.json" + } + } + }, + "put": { + "tags": [ + "Alterations" + ], + "summary": "Replace alterations data.", + "operationId": "Alterations_Replace", + "parameters": [ + { + "$ref": "#/parameters/WordAlterations" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No Content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulSetAlts.json" + } + } + } + }, + "/knowledgebases": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Gets all knowledgebases for a user.", + "operationId": "Knowledgebase_ListAll", + "parameters": [], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Collection of knowlegebases.", + "schema": { + "$ref": "#/definitions/KnowledgebasesDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulKbsResponse.json" + } + } + } + }, + "/operations/{operationId}": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Gets details of a specific long running operation.", + "operationId": "Operations_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/OperationId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the long running operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true, + "headers": { + "RetryAfter": { + "type": "integer", + "description": "Indicates how long the client should wait before sending a follow up request. The header will be present only if the operation is running or has not started yet." + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetOps.json" + } + } + } + }, + "/knowledgebases/{kbId}": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Gets details of a specific knowledgebase.", + "operationId": "Knowledgebase_GetDetails", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Details of the knowledgebase.", + "schema": { + "$ref": "#/definitions/KnowledgebaseDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulGetKb.json" + } + } + }, + "delete": { + "tags": [ + "Knowledgebases" + ], + "summary": "Deletes the knowledgebase and all its data.", + "operationId": "Knowledgebase_Delete", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulDelKb.json" + } + } + }, + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "Publishes all changes in test index of a knowledgebase to its prod index.", + "operationId": "Knowledgebase_Publish", + "parameters": [ + { + "$ref": "#/parameters/KbId" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulPubKb.json" + } + } + }, + "put": { + "tags": [ + "Knowledgebases" + ], + "summary": "Replace knowledgebase contents.", + "operationId": "Knowledgebase_Replace", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/ReplaceKb" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "HTTP 204 No content." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulRepKb.json" + } + } + }, + "patch": { + "tags": [ + "Knowledgebases" + ], + "summary": "Asynchronous operation to modify a knowledgebase.", + "operationId": "Knowledgebase_Update", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/UpdateKb" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "Details of the asynchronous operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true, + "headers": { + "Location": { + "type": "string", + "description": "Relative URI to the target location of the asynchronous operation. Client should poll this resource to get status of the operation." + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulUpdKb.json" + } + } + } + }, + "/knowledgebases/create": { + "post": { + "tags": [ + "Knowledgebases" + ], + "summary": "Asynchronous operation to create a new knowledgebase.", + "operationId": "Knowledgebase_Create", + "parameters": [ + { + "$ref": "#/parameters/CreateKbPayload" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "Details of the asynchronous operation.", + "schema": { + "$ref": "#/definitions/Operation" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulCreateKb.json" + } + } + } + }, + "/knowledgebases/{kbId}/{environment}/qna": { + "get": { + "tags": [ + "Knowledgebases" + ], + "summary": "Download the knowledgebase.", + "operationId": "Knowledgebase_Download", + "parameters": [ + { + "$ref": "#/parameters/KbId" + }, + { + "$ref": "#/parameters/Environment" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Collection of all Q-A in the knowledgebase.", + "schema": { + "$ref": "#/definitions/QnADocumentsDTO" + }, + "x-nullable": true + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/SuccessfulDownloadKb.json" + } + } + } + } + }, + "definitions": { + "UpdateKbOperationDTO": { + "type": "object", + "description": "Contains list of QnAs to be updated", + "additionalProperties": false, + "properties": { + "add": { + "description": "An instance of CreateKbInputDTO for add operation", + "allOf": [ + { + "$ref": "#/definitions/CreateKbInputDTO" + } + ] + }, + "delete": { + "description": "An instance of DeleteKbContentsDTO for delete Operation", + "allOf": [ + { + "$ref": "#/definitions/DeleteKbContentsDTO" + } + ] + }, + "update": { + "description": "An instance of UpdateKbContentsDTO for Update Operation", + "allOf": [ + { + "$ref": "#/definitions/UpdateKbContentsDTO" + } + ] + } + } + }, + "UpdateKbContentsDTO": { + "type": "object", + "description": "PATCH body schema for Update operation in Update Kb", + "additionalProperties": false, + "properties": { + "name": { + "type": "string", + "description": "Friendly name for the knowledgebase." + }, + "qnaList": { + "type": "array", + "description": "List of Q-A (UpdateQnaDTO) to be added to the knowledgebase.", + "items": { + "$ref": "#/definitions/UpdateQnaDTO" + } + }, + "urls": { + "type": "array", + "description": "List of existing URLs to be refreshed. The content will be extracted again and re-indexed.", + "maxLength": 10, + "items": { + "type": "string" + } + } + } + }, + "UpdateQnaDTO": { + "type": "object", + "description": "PATCH Body schema for Update Qna List", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Unique id for the Q-A", + "format": "int32", + "maximum": 2147483647, + "minimum": 0 + }, + "answer": { + "type": "string", + "description": "Answer text" + }, + "source": { + "type": "string", + "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs", + "maxLength": 300 + }, + "questions": { + "description": "List of questions associated with the answer.", + "allOf": [ + { + "$ref": "#/definitions/UpdateQuestionsDTO" + } + ] + }, + "metadata": { + "description": "List of metadata associated with the answer to be updated", + "allOf": [ + { + "$ref": "#/definitions/UpdateMetadataDTO" + } + ] + } + } + }, + "UpdateQuestionsDTO": { + "type": "object", + "description": "PATCH Body schema for Update Kb which contains list of questions to be added and deleted", + "additionalProperties": false, + "properties": { + "add": { + "type": "array", + "description": "List of questions to be added", + "maxLength": 100, + "items": { + "type": "string" + } + }, + "delete": { + "type": "array", + "description": "List of questions to be deleted.", + "maxLength": 100, + "items": { + "type": "string" + } + } + } + }, + "UpdateMetadataDTO": { + "type": "object", + "description": "PATCH Body schema to represent list of Metadata to be updated", + "additionalProperties": false, + "properties": { + "delete": { + "type": "array", + "description": "List of Metadata associated with answer to be deleted", + "maxLength": 100, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + }, + "add": { + "type": "array", + "description": "List of Metadat associated with answer to be added", + "maxLength": 100, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + } + } + }, + "DeleteKbContentsDTO": { + "type": "object", + "description": "PATCH body schema of Delete Operation in UpdateKb", + "additionalProperties": false, + "properties": { + "ids": { + "type": "array", + "description": "List of Qna Ids to be deleted", + "items": { + "type": "integer", + "format": "int32" + } + }, + "sources": { + "type": "array", + "description": "List of sources to be deleted from knowledgebase.", + "maxLength": 300, + "minLength": 1, + "items": { + "type": "string" + } + } + } + }, + "CreateKbInputDTO": { + "type": "object", + "description": "Input to create KB.", + "additionalProperties": false, + "properties": { + "qnaList": { + "type": "array", + "description": "List of QNA to be added to the index. Ids are generated by the service and should be omitted.", + "items": { + "$ref": "#/definitions/QnADTO" + } + }, + "urls": { + "type": "array", + "description": "List of URLs to be added to knowledgebase.", + "maxLength": 10, + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "description": "List of files to be added to knowledgebase.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/FileDTO" + } + } + } + }, + "KnowledgebaseEnvironment": { + "type": "string", + "description": "Enumeration of knowledgebase environments.", + "x-ms-enum": { + "name": "KnowledgebaseEnvironmentType", + "modelAsString": true + }, + "enum": [ + "Prod", + "Test" + ] + }, + "QnADocumentsDTO": { + "type": "object", + "description": "List of QnADTO", + "additionalProperties": false, + "properties": { + "qnaDocuments": { + "type": "array", + "description": "List of answers.", + "items": { + "$ref": "#/definitions/QnADTO" + } + } + } + }, + "CreateKbDTO": { + "type": "object", + "description": "Post body schema for CreateKb operation.", + "additionalProperties": false, + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Friendly name for the knowledgebase.", + "maxLength": 100, + "minLength": 1 + }, + "qnaList": { + "type": "array", + "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.", + "maxLength": 1000, + "items": { + "$ref": "#/definitions/QnADTO" + } + }, + "urls": { + "type": "array", + "description": "List of URLs to be used for extracting Q-A.", + "maxLength": 10, + "items": { + "type": "string" + } + }, + "files": { + "type": "array", + "description": "List of files from which to Extract Q-A.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/FileDTO" + } + } + } + }, + "FileDTO": { + "type": "object", + "description": "DTO to hold details of uploaded files.", + "additionalProperties": false, + "required": [ + "fileName", + "fileUri" + ], + "properties": { + "fileName": { + "type": "string", + "description": "File name. Supported file types are \".tsv\", \".pdf\", \".txt\", \".docx\", \".xlsx\".", + "maxLength": 200, + "minLength": 1 + }, + "fileUri": { + "type": "string", + "description": "Public URI of the file." + } + } + }, + "ReplaceKbDTO": { + "type": "object", + "description": "Post body schema for Replace KB operation.", + "additionalProperties": false, + "required": [ + "qnAList" + ], + "properties": { + "qnAList": { + "type": "array", + "description": "List of Q-A (QnADTO) to be added to the knowledgebase. Q-A Ids are assigned by the service and should be omitted.", + "items": { + "$ref": "#/definitions/QnADTO" + } + } + } + }, + "QnADTO": { + "type": "object", + "description": "Q-A object.", + "additionalProperties": false, + "required": [ + "answer", + "questions" + ], + "properties": { + "id": { + "type": "integer", + "description": "Unique id for the Q-A.", + "format": "int32" + }, + "answer": { + "type": "string", + "description": "Answer text", + "maxLength": 25000, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Source from which Q-A was indexed. eg. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs", + "maxLength": 300 + }, + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "maxLength": 100, + "minLength": 1, + "items": { + "type": "string" + } + }, + "metadata": { + "type": "array", + "description": "List of metadata associated with the answer.", + "maxLength": 10, + "items": { + "$ref": "#/definitions/MetadataDTO" + } + } + } + }, + "MetadataDTO": { + "type": "object", + "description": "Name - value pair of metadata.", + "additionalProperties": false, + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Metadata name.", + "maxLength": 100, + "minLength": 1 + }, + "value": { + "type": "string", + "description": "Metadata value.", + "maxLength": 500, + "minLength": 1 + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "properties": { + "error": { + "description": "The error object.", + "allOf": [ + { + "$ref": "#/definitions/Error" + } + ] + } + } + }, + "Error": { + "type": "object", + "description": "The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "required": [ + "code" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innerError": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "ErrorCode": { + "type": "string", + "description": "Human readable error code.", + "x-ms-enum": { + "name": "ErrorCodeType", + "modelAsString": true + }, + "enum": [ + "BadArgument", + "Forbidden", + "NotFound", + "KbNotFound", + "Unauthorized", + "Unspecified", + "EndpointKeysError", + "QuotaExceeded", + "QnaRuntimeError", + "SKULimitExceeded", + "OperationNotFound", + "ServiceError", + "ValidationFailure", + "ExtractionFailure" + ] + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "properties": { + "code": { + "type": "string", + "description": "A more specific error code than was provided by the containing error." + }, + "innerError": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "Operation": { + "type": "object", + "description": "Record to track long running operation.", + "additionalProperties": false, + "properties": { + "operationState": { + "description": "Operation state.", + "$ref": "#/definitions/OperationState" + }, + "createdTimestamp": { + "type": "string", + "description": "Timestamp when the operation was created." + }, + "lastActionTimestamp": { + "type": "string", + "description": "Timestamp when the current state was entered." + }, + "resourceLocation": { + "type": "string", + "description": "Relative URI to the target resource location for completed resources." + }, + "userId": { + "type": "string", + "description": "User Id" + }, + "operationId": { + "type": "string", + "description": "Operation Id." + }, + "errorResponse": { + "description": "Error details in case of failures.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "OperationState": { + "type": "string", + "description": "Enumeration of operation states.", + "x-ms-enum": { + "name": "OperationStateType", + "modelAsString": true + }, + "enum": [ + "Failed", + "NotStarted", + "Running", + "Succeeded" + ] + }, + "KnowledgebasesDTO": { + "type": "object", + "description": "Collection of knowledgebases owned by a user.", + "additionalProperties": false, + "properties": { + "knowledgebases": { + "type": "array", + "description": "Collection of knowledgebase records.", + "items": { + "$ref": "#/definitions/KnowledgebaseDTO" + } + } + } + }, + "KnowledgebaseDTO": { + "type": "object", + "description": "Response schema for CreateKb operation.", + "additionalProperties": false, + "properties": { + "id": { + "type": "string", + "description": "Unique id that identifies a knowledgebase." + }, + "hostName": { + "type": "string", + "description": "URL host name at which the knowledgebase is hosted." + }, + "lastAccessedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last accessed (UTC)." + }, + "lastChangedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last modified (UTC)." + }, + "lastPublishedTimestamp": { + "type": "string", + "description": "Time stamp at which the knowledgebase was last published (UTC)." + }, + "name": { + "type": "string", + "description": "Friendly name of the knowledgebase." + }, + "userId": { + "type": "string", + "description": "User who created / owns the knowledgebase." + }, + "urls": { + "type": "array", + "description": "URL sources from which Q-A were extracted and added to the knowledgebase.", + "items": { + "type": "string" + } + }, + "sources": { + "type": "array", + "description": "Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.", + "items": { + "type": "string" + } + } + } + }, + "WordAlterationsDTO": { + "type": "object", + "description": "Collection of word alterations.", + "additionalProperties": false, + "required": [ + "wordAlterations" + ], + "properties": { + "wordAlterations": { + "type": "array", + "description": "Collection of word alterations.", + "maxLength": 10000, + "items": { + "$ref": "#/definitions/AlterationsDTO" + } + } + } + }, + "AlterationsDTO": { + "type": "object", + "description": "Collection of words that are synonyms.", + "additionalProperties": false, + "required": [ + "alterations" + ], + "properties": { + "alterations": { + "type": "array", + "description": "Words that are synonymous with each other.", + "maxLength": 20, + "minLength": 1, + "items": { + "type": "string" + } + } + } + }, + "EndpointKeysDTO": { + "type": "object", + "description": "Schema for EndpointKeys generate/refresh operations.", + "additionalProperties": false, + "properties": { + "primaryEndpointKey": { + "type": "string", + "description": "Primary Access Key." + }, + "secondaryEndpointKey": { + "type": "string", + "description": "Secondary Access Key." + }, + "installedVersion": { + "type": "string", + "description": "Current version of runtime." + }, + "lastStableVersion": { + "type": "string", + "description": "Latest version of runtime." + } + } + } + }, + "parameters": { + "Environment": { + "type": "string", + "name": "environment", + "in": "path", + "required": true, + "x-schema": { + "$ref": "#/definitions/KnowledgebaseEnvironment" + }, + "x-nullable": false, + "description": "Specifies whether environment is Test or Prod.", + "x-ms-enum": { + "name": "EnvironmentType", + "modelAsString": true + }, + "enum": [ + "Prod", + "Test" + ], + "x-ms-parameter-location": "method" + }, + "CreateKbPayload": { + "name": "createKbPayload", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateKbDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "UpdateKb": { + "name": "updateKb", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateKbOperationDTO" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "ReplaceKb": { + "name": "replaceKb", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReplaceKbDTO" + }, + "x-nullable": true, + "description": "An instance of ReplaceKbDTO which contains list of qnas to be uploaded", + "x-ms-parameter-location": "method" + }, + "KbId": { + "type": "string", + "name": "kbId", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Knowledgebase id.", + "x-ms-parameter-location": "method" + }, + "OperationId": { + "type": "string", + "name": "operationId", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Operation id.", + "x-ms-parameter-location": "method" + }, + "WordAlterations": { + "name": "wordAlterations", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/WordAlterationsDTO" + }, + "x-nullable": true, + "description": "New alterations data.", + "x-ms-parameter-location": "method" + }, + "KeyType": { + "type": "string", + "name": "keyType", + "in": "path", + "required": true, + "x-nullable": false, + "description": "Type of Key", + "x-ms-parameter-location": "method" + }, + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json new file mode 100644 index 000000000000..968922045d74 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulCreateKb.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "createKbPayload": { + "name": "QnA Maker FAQ", + "qnaList": [ + { + "id": 0, + "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle", + "source": "Custom Editorial", + "questions": [ + "How can I change the default message from QnA Maker?" + ], + "metadata": [] + }, + { + "id": 0, + "answer": "You can use our REST apis to manage your KB. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa", + "source": "Custom Editorial", + "questions": [ + "How do I programmatically update my KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ] + } + ], + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ], + "files": [ + { + "fileName": "SurfaceManual.pdf", + "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf" + } + ] + } + }, + "responses": { + "202": { + "headers": {}, + "body": { + "operationState": "NotStarted", + "createdTimestamp": "2018-03-19T07:38:46Z", + "lastActionTimestamp": "2018-03-19T07:39:29Z", + "userId": "86bb8390-56c0-42c2-9f81-3de161981191", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDelKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDelKb.json new file mode 100644 index 000000000000..35391cbe6f62 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDelKb.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDownloadKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDownloadKb.json new file mode 100644 index 000000000000..ac17a06b040c --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulDownloadKb.json @@ -0,0 +1,374 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "environment": "Test" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "qnaDocuments": [ + { + "id": 1, + "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle", + "source": "Custom Editorial", + "questions": [ + "How can I change the default message from QnA Maker?" + ], + "metadata": [] + }, + { + "id": 2, + "answer": "You can use our REST apis to manage your KB. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa", + "source": "Custom Editorial", + "questions": [ + "How do I programmatically update my KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ] + }, + { + "id": 3, + "answer": "QnA Maker provides an FAQ data source that you can query from your bot or application. Although developers will find this useful, content owners will especially benefit from this tool. QnA Maker is a completely no-code way of managing the content that powers your bot or application.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Who is the target audience for the QnA Maker tool?" + ], + "metadata": [] + }, + { + "id": 4, + "answer": "

You can sign in with your Microsoft account

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How do I sign in to the QnA Maker portal?" + ], + "metadata": [] + }, + { + "id": 5, + "answer": "

Yes, currently the QnA Maker tool is free to use. However, usage is metered for each account. For more information, see Authentication and subscription keys

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Is the QnA Maker Service free?" + ], + "metadata": [] + }, + { + "id": 6, + "answer": "It’s possible that the tool can't auto-extract some question-and-answer (QnA) content from valid FAQ URLs. In such cases, you can paste the QnA content in a .txt file and see if the tool can ingest it. Alternately, you can editorially add content to your knowledge base.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "My URLs have valid FAQ content, but the tool cannot extract them. Why not?" + ], + "metadata": [] + }, + { + "id": 7, + "answer": "

The tool supports the following file formats for ingestion:

  • .tsv: QnA contained in the format Question(tab)Answer.
  • .txt, .docx, .pdf: QnA contained as regular FAQ content--that is, a sequence of questions and answers.
", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "What format does the tool expect for the file content?" + ], + "metadata": [] + }, + { + "id": 8, + "answer": "

No, you don’t. However, QnA Maker is offered as one of several templates in Azure Bot Service. Bot Service enables rapid intelligent bot development through Microsoft Bot Framework, and it runs in a serverless environment.

Bots scale based on demand. You pay for only the resources that you consume.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Do I need to use Bot Framework in order to use QnA Maker?" + ], + "metadata": [] + }, + { + "id": 9, + "answer": "

QnAMaker provides a REST endpoint that you can call from any bot code. However, if you'd like a quick way to set up a QnAMaker bot, you can use the Azure Bot Service. Follow the instructions here and choose the \"Question and Answer\" bot template. Once the bot is created, you will need to do the following steps to complete setup.

  1. In Azure portal, open the newly created Web App Bot resource.
  2. Click on \"Application Settings\" and in the App Settings list, add QnASubscriptionKey and QnAKnowledgebaseId. The corresponding values can be obtained from the KB Settings page in http://qnamaker.ai.
  3. The QnAMaker-enabled Azure bot service app is now ready to use. To try it out click on \"Test in Web Chat\" to chat with your QnA bot.
", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How can I create a bot with QnAMaker?" + ], + "metadata": [] + }, + { + "id": 10, + "answer": "

Follow these steps to embed the QnA Maker service as a web-chat control in your website:

  1. Create your knowledge base from the QnA Maker webpage.
  2. Create your bot as shown in Create a bot with the Azure Bot Service.
  3. Look for the Question and Answer bot template.
  4. Enable the bot on the Web Chat channel. Get the embed keys.
  5. Embed the web chat as shown in Connect a bot to Web Chat.
", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How do I embed the QnA Maker service in my website?" + ], + "metadata": [] + }, + { + "id": 11, + "answer": "Currently, the QnA Maker tool handles semi-structured FAQ content and certain types of product manuals. Eventually, the vision is to be able to answer questions from unstructured content as well.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "What is the roadmap of QnA Maker?" + ], + "metadata": [] + }, + { + "id": 12, + "answer": "Currently, the limit is a 20-MB knowledge base.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How large a knowledge base can I create?" + ], + "metadata": [] + }, + { + "id": 13, + "answer": "Every edit operation, whether in a table update, test, or settings, needs to be saved before it can be published. Be sure to select the Save and retrain button after every edit operation.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "The updates that I made to my knowledge base are not reflected on publish. Why not?" + ], + "metadata": [] + }, + { + "id": 14, + "answer": "The upload feature expects the file to be formatted as tab-separated columns of question, answer, and source.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Why can’t I replace my knowledge base with the upload feature?" + ], + "metadata": [] + }, + { + "id": 15, + "answer": "You should refresh your subscription keys if you suspect that they have been compromised. Any requests with your subscription key will count toward your quota.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "When should I refresh my subscription keys?" + ], + "metadata": [] + }, + { + "id": 16, + "answer": "The QnA Maker tool stores all knowledge base content in Azure Storage. You need a combination of knowledge base ID and subscription key to access the knowledge base. The tool doesn't use knowledge base content for any other purpose.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How safe is the data in my knowledge base?" + ], + "metadata": [] + }, + { + "id": 17, + "answer": "

The knowledge base supports Markdown. However, the auto-extraction from URLs has limited HTML-to-Markdown conversion capability. If you want to use full-fledged Markdown, you can modify your content directly in the table, or upload a knowledge base with the rich content.

Multimedia, such as images and videos, is not supported at this time.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Does the knowledge base support rich data or multimedia?" + ], + "metadata": [] + }, + { + "id": 18, + "answer": "

The QnA Maker tool ingests and matches data in UTF-16 encoding. Any language should work as is. But, we have extensively tested the relevance of the service for English only.

If you have content from multiple languages, be sure to create a separate service for each language.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Does QnA Maker support non-English languages?" + ], + "metadata": [] + }, + { + "id": 19, + "answer": "The chat logs are tab-separated files, with the query and the frequency as the columns. Frequency is the number of times that the same query was seen. The file is sorted in descending order of frequency. Select questions from the downloaded file that you want to test, and then upload it to see what responses the system returned for them.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "What is the format of the downloaded chat logs?" + ], + "metadata": [] + }, + { + "id": 20, + "answer": "

The new service doesn't include the test URL. The reason is that all calls are metered, as part of Cognitive Services. Because the test URL exposed the subscription key and the knowledge base ID, it was a security risk.

However, it's still easy to share your knowledge base and use it in chats. Check out the Azure Bot Service template for the Question and Answer bot. You can create the Question and Answer bot in Skype in a few clicks, and then share it with anyone.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Where is the test web-chat URL from the old portal? How do I share my knowledge base with others now?" + ], + "metadata": [] + }, + { + "id": 21, + "answer": "

Current transaction limits are 10 calls per minute and 10,000 calls per month. If you require higher limits, a free premium tier is available with limits of 1,000 calls per minute and 500,000 calls per month. To sign up for this option, fill in the request form. Note that these tiers are subject to change when the tool goes to general availability.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How can I increase the transaction limits?" + ], + "metadata": [] + }, + { + "id": 22, + "answer": "

If QnA Maker doesn't match any of the questions, it shows a default \"Sorry, no match found\" message. You can change this default message in the code-behind by using the QnAMakerDialog object. For more information, see Create a bot using the Question and Answer template.

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How can I change the default message when no good match is found?" + ], + "metadata": [] + }, + { + "id": 23, + "answer": "The tool parses only public URLs and does not support authenticated data sources at this time. Alternately, you can download the file and use the file-upload option to extract questions and answers.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "Why is my SharePoint link not getting extracted?" + ], + "metadata": [] + }, + { + "id": 24, + "answer": "

There is no direct integration of LUIS with QnA Maker. But, in your bot code, you can use LUIS and QnA Maker together. View a sample bot

", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How can I integrate LUIS with QnA Maker?" + ], + "metadata": [] + }, + { + "id": 25, + "answer": "QnAMaker is currently in free Preview and does not have support SLAs. If you want to report an issue or provide feedback, you do so on UserVoice through the \"Feedback\" button in the top navigation bar.", + "source": "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "questions": [ + "How can I report issues or contact support for QnAMaker?" + ], + "metadata": [] + }, + { + "id": 26, + "answer": "

While the Conversation User Interface (CUI) is upon us, at this point few developers have the expertise and tools needed to create new conversational experiences or enable existing applications and services with a conversational interface their users can enjoy. We have created the Bot Framework to make it easier for developers to build and connect great bots to users, wherever they converse, including on Microsoft's premier channels.

Channels

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "Why did Microsoft develop the Bot Framework?" + ], + "metadata": [] + }, + { + "id": 27, + "answer": "

We plan on making continuous improvements to the Bot Framework, including additional channels, but cannot provide a schedule at this time.If you would like a specific channel added to the framework, let us know.

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "When will you add more conversation experiences to the Bot Framework?" + ], + "metadata": [] + }, + { + "id": 28, + "answer": "

We have not provided a general mechanism for developers to add new channels to Bot Framework, but you can connect your bot to your app via the Direct Line API. If you are a developer of a communication channel and would like to work with us to enable your channel in the Bot Framework we’d love to hear from you.

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "I have a communication channel I’d like to be configurable with Bot Framework. Can I work with Microsoft to do that?" + ], + "metadata": [] + }, + { + "id": 29, + "answer": "

The Bot Framework is designed to build, connect, and deploy high quality, responsive, performant and scalable bots for Skype and many other channels. The SDK can be used to create text/sms, image, button and card-capable bots (which constitute the majority of bot interactions today across conversation experiences) as well as bot interactions which are Skype-specific such as rich audio and video experiences.

If you already have a great bot and would like to reach the Skype audience, your bot can easily be connected to Skype (or any supported channel) via the Bot Builder for REST API (provided it has an internet-accessible REST endpoint).

Security and Privacy

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "If I want to create a bot for Skype, what tools and services should I use?" + ], + "metadata": [] + }, + { + "id": 30, + "answer": "

Each bot is its own service, and developers of these services are required to provide Terms of Service and Privacy Statements per their Developer Code of Conduct. You can access this information from the bot’s card in the Bot Directory.

to provide the I/O service, the Bot Framework transmits your message and message content (including your ID), from the chat service you used to the bot.

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "Do the bots registered with the Bot Framework collect personal information? If yes, how can I be sure the data is safe and secure? What about privacy?" + ], + "metadata": [] + }, + { + "id": 31, + "answer": "Users have a way to report a misbehaving bot via the bot’s contact card in the directory. Developers must abide by Microsoft terms of service to participate in the service.", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "How do you ban or remove bots from the service?" + ], + "metadata": [] + }, + { + "id": 32, + "answer": "

You'll need to whitelist the following URLs in your corporate firewall:

  • login.botframework.com (Bot authentication)
  • login.microsoftonline.com (Bot authentication)
  • westus.api.cognitive.microsoft.com (for Luis.ai NLP integration)
  • state.botframework.com (Bot state storage for prototyping)
  • cortanabfchanneleastus.azurewebsites.net (Cortana channel)
  • cortanabfchannelwestus.azurewebsites.net (Cortana Channel)
  • *.botFramework.com (channels)

Rate limiting

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "Which specific URLs do I need to whitelist in my corporate firewall to access bot services?" + ], + "metadata": [] + }, + { + "id": 33, + "answer": "The Bot Framework service must protect itself and its customers against abusive call patterns (e.g., denial of service attack), so that no single bot can adversely affect the performance of other bots. To achieve this kind of protection, we’ve added rate limits (also known as throttling) to all endpoints. By enforcing a rate limit, we can restrict the frequency with which a bot can make a specific call. For example: with rate limiting enabled, if a bot wanted to post a large number of activities, it would have to space them out over a time period. Please note that the purpose of rate-limiting is not to cap the total volume for a bot. It is designed to prevent abuse of the conversational infrastructure that does not follow human conversation patterns.", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "What is rate limiting?" + ], + "metadata": [] + }, + { + "id": 34, + "answer": "It is unlikely you’ll experience rate limiting, even at high volume. Most rate limiting would only occur due to bulk sending of activities (from a bot or from a client), extreme load testing, or a bug. When a request is throttled, an HTTP 429 (Too Many Requests) response is returned along with a Retry-After header indicating the amount of time (in seconds) to wait before retrying the request would succeed. You can collect this information by enabling analytics for your bot via Azure Application Insights. Or, you can add code in your bot to log messages. ", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "How will I know if I’m impacted?" + ], + "metadata": [] + }, + { + "id": 35, + "answer": "

It can happen if:

  • a bot sends messages too frequently
  • a client of a bot sends messages too frequently
  • Direct Line clients request a new Web Socket too frequently
", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "How does rate limiting occur?" + ], + "metadata": [] + }, + { + "id": 36, + "answer": "

We’re continuously tuning the rate limits to make them as lenient as possible while at the same time protecting our service and our users. Because thresholds will occasionally change, we aren’t publishing the numbers at this time. If you are impacted by rate limiting, feel free to reach out to us at bf-reports@microsoft.com.

Related Services

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "What are the rate limits?" + ], + "metadata": [] + }, + { + "id": 37, + "answer": "

Both the Bot Framework and Cognitive Services are new capabilities introduced at Microsoft Build 2016 that will also be integrated into Cortana Intelligence Suite at GA. Both these services are built from years of research and use in popular Microsoft products. These capabilities combined with ‘Cortana Intelligence’ enable every organization to take advantage of the power of data, the cloud and intelligence to build their own intelligent systems that unlock new opportunities, increase their speed of business and lead the industries in which they serve their customers.

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "How does the Bot Framework relate to Cognitive Services?" + ], + "metadata": [] + }, + { + "id": 38, + "answer": "

Cortana Intelligence is a fully managed Big Data, Advanced Analytics and Intelligence suite that transforms your data into intelligent action.It is a comprehensive suite that brings together technologies founded upon years of research and innovation throughout Microsoft (spanning advanced analytics, machine learning, big data storage and processing in the cloud) and:

  • Allows you to collect, manage and store all your data that can seamlessly and cost effectively grow over time in a scalable and secure way.
  • Provides easy and actionable analytics powered by the cloud that allow you to predict, prescribe and automate decision making for the most demanding problems.
  • Enables intelligent systems through cognitive services and agents that allow you to see, hear, interpret and understand the world around you in more contextual and natural ways.

With Cortana Intelligence, we hope to help our enterprise customers unlock new opportunities, increase their speed of business and be leaders in their industries.

", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "What is Cortana Intelligence?" + ], + "metadata": [] + }, + { + "id": 39, + "answer": "

Direct Line is a REST API that allows you to add your bot into your service, mobile app, or webpage.

You can write a client for the Direct Line API in any language. Simply code to the Direct Line protocol, generate a secret in the Direct Line configuration page, and talk to your bot from wherever your code lives.

Direct Line is suitable for:

  • Mobile apps on iOS, Android, and Windows Phone, and others
  • Desktop applications on Windows, OSX, and more
  • Webpages where you need more customization than the embeddable Web Chat channel offers
  • Service-to-service applications
", + "source": "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq", + "questions": [ + "What is the Direct Line channel?" + ], + "metadata": [] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetAlts.json new file mode 100644 index 000000000000..d8ac5cf786a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetAlts.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetEpKeys.json new file mode 100644 index 000000000000..2b7f17e3d84f --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetEpKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530", + "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063", + "installedVersion": "4.0.5", + "lastStableVersion": "4.0.6" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetKb.json new file mode 100644 index 000000000000..03ffcaa9d7a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetKb.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "hostName": "https://myqnamakerbot.azurewebsites.net", + "lastAccessedTimestamp": "2018-03-16T10:59:46Z", + "lastChangedTimestamp": "2018-03-16T10:58:10Z", + "lastPublishedTimestamp": "2018-03-16T10:59:56Z", + "name": "My QnA Maker Bot", + "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1", + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ], + "sources": [ + "Custom Editorial", + "SurfaceManual.pdf" + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetOps.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetOps.json new file mode 100644 index 000000000000..1769fd26215e --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulGetOps.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "operationState": "Succeeded", + "createdTimestamp": "2018-03-19T07:38:46Z", + "lastActionTimestamp": "2018-03-19T07:39:29Z", + "resourceLocation": "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "userId": "86bb8390-56c0-42c2-9f81-3de161981191", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulKbsResponse.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulKbsResponse.json new file mode 100644 index 000000000000..a2442b4c773a --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulKbsResponse.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "knowledgebases": [ + { + "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "hostName": "https://myqnamakerbot.azurewebsites.net", + "lastAccessedTimestamp": "2018-03-16T10:59:46Z", + "lastChangedTimestamp": "2018-03-16T10:58:10Z", + "lastPublishedTimestamp": "2018-03-16T10:59:56Z", + "name": "My QnA Maker Bot", + "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1", + "urls": [ + "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ], + "sources": [ + "Custom Editorial", + "SurfaceManual.pdf" + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulPubKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulPubKb.json new file mode 100644 index 000000000000..3bb3df661bf1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulPubKb.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff" + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json new file mode 100644 index 000000000000..ae1d74cf245e --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "replaceKb": { + "qnAList": [ + { + "id": 0, + "answer": "string", + "source": "string", + "questions": [ + "string" + ], + "metadata": [ + { + "name": "string", + "value": "string" + } + ] + } + ] + } + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetAlts.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetAlts.json new file mode 100644 index 000000000000..2c3387e88fc6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetAlts.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "wordAlterations": { + "wordAlterations": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + }, + { + "alterations": [ + "webchat", + "web chat" + ] + } + ] + } + }, + "responses": { + "204": { + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpKeys.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpKeys.json new file mode 100644 index 000000000000..a2fcd4e250f0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulSetEpKeys.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "keyType": "PrimaryKey" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "primaryEndpointKey": "73e88a14-694a-44d5-883b-184a68aa8530", + "secondaryEndpointKey": "b2c98c16-ca31-4294-8626-6c57454a5063", + "installedVersion": "4.0.5", + "lastStableVersion": "4.0.6" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json new file mode 100644 index 000000000000..7217c27d2591 --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulUpdKb.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "kbId": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff", + "updateKb": { + "add": { + "qnaList": [ + { + "id": 0, + "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle", + "source": "Custom Editorial", + "questions": [ + "How can I change the default message from QnA Maker?" + ], + "metadata": [] + }, + { + "id": 0, + "answer": "You can use our REST apis to manage your KB. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa", + "source": "Custom Editorial", + "questions": [ + "How do I programmatically update my KB?" + ], + "metadata": [ + { + "name": "category", + "value": "api" + } + ] + } + ], + "urls": [ + "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/FAQ" + ], + "files": [ + { + "fileName": "SurfaceManual.pdf", + "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf" + } + ] + }, + "delete": { + "ids": [ + 4, + 13, + 35 + ], + "sources": [ + "Custom Editorial" + ] + }, + "update": { + "name": "QnA Maker + Emotion API FAQ Bot", + "qnaList": [ + { + "id": 30, + "answer": "Yes, you can use our REST APIs to manage a KB. Please check our documentation for details.", + "source": "Custom Q&A", + "questions": { + "add": [ + "can I programmatically manage a KB?" + ], + "delete": [ + "How do I programmatically update my KB?" + ] + }, + "metadata": { + "delete": [ + { + "name": "category", + "value": "api" + } + ], + "add": [ + { + "name": "category", + "value": "programmatic" + } + ] + } + } + ], + "urls": [ + "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" + ] + } + } + }, + "responses": { + "202": { + "headers": {}, + "body": { + "operationState": "NotStarted", + "createdTimestamp": "2018-03-19T07:38:46Z", + "lastActionTimestamp": "2018-03-19T07:39:29Z", + "userId": "86bb8390-56c0-42c2-9f81-3de161981191", + "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1" + } + } + } +} \ No newline at end of file From a4ac96db3fcfa17bd2c5becae8aa339b9ce46081 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Mon, 19 Nov 2018 13:31:57 -0800 Subject: [PATCH 153/464] fix Go SDK codegen for engagementfabric (#4498) --- specification/engagementfabric/resource-manager/readme.go.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/engagementfabric/resource-manager/readme.go.md b/specification/engagementfabric/resource-manager/readme.go.md index 6f865d9c85aa..c7fb7ff921f9 100644 --- a/specification/engagementfabric/resource-manager/readme.go.md +++ b/specification/engagementfabric/resource-manager/readme.go.md @@ -22,5 +22,5 @@ These settings apply only when `--tag=package-2018-09-preview --go` is specified Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-preview/$(namespace) -``` \ No newline at end of file +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-01/$(namespace) +``` From bc4f7d59c098363a3d0574396ae5edd6aa64149a Mon Sep 17 00:00:00 2001 From: mjfrb <30875918+mjfrb@users.noreply.github.com> Date: Tue, 20 Nov 2018 08:04:31 -0800 Subject: [PATCH 154/464] Master (#4450) * fix readme.md to include 2016/06/01 with 2018/03/01 always * add 2018-11-01-preview * pr feedbac * add cost center * pr feedback * pr feedback --- .../examples/createSubscription.json | 32 ++ .../examples/getOperations.json | 21 ++ .../examples/getSubscriptionOperation.json | 19 + .../2018-11-01-preview/subscriptions.json | 330 ++++++++++++++++++ .../subscription/resource-manager/readme.md | 14 +- 5 files changed, 415 insertions(+), 1 deletion(-) create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/createSubscription.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getOperations.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getSubscriptionOperation.json create mode 100644 specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/createSubscription.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/createSubscription.json new file mode 100644 index 000000000000..d93c7f851a1b --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/createSubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "billingAccountName": "12a6eed9-5d39-4103-a5db-2db1db0a8c67", + "invoiceSectionName": "b859d705-1ed7-4769-9d4b-19238e9e8ac2_10_31", + "api-version": "2018-11-01-preview", + "body": { + "displayName": "Test Ea Azure Sub", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/12a6eed9-5d39-4103-a5db-2db1db0a8c67/billingProfiles/dbcb81c8-cda9-4b01-b9fc-831e6a2e152e", + "skuId": "0001", + "costCenter": "myCostCenter123", + "owner": { + "objectId": "973034ff-acb7-409c-b731-e789672c7b31" + }, + "additionalParameters": { + } + } + }, + "responses": { + "202": { + "headers": { + "Location": + "/providers/Microsoft.Subscription/subscriptionOperations/aeb76128-ebde-4f5a-a9ed-e7bbf2dbc994?api-version=2018-11-01-preview", + "Retry-After": 8 + } + }, + "200": { + "body": { + "subscriptionLink": "/subscriptions/d0d6ee57-6530-4fca-93a6-b755a070be35" + } + } + } +} \ No newline at end of file diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getOperations.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getOperations.json new file mode 100644 index 000000000000..e0713487bc1d --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getOperations.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2018-11-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Subscription/createSubscription/action", + "display": { + "provider": "Microsoft Subscription", + "resource": "Resources", + "operation": "Create an Azure subscription" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getSubscriptionOperation.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getSubscriptionOperation.json new file mode 100644 index 000000000000..a78d675da35b --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/examples/getSubscriptionOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "operationId": "e4b8d068-f574-462a-a76f-6fa0afc613c9", + "api-version": "2018-11-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "/providers/Microsoft.Subscription/subscriptionOperations/e4b8d068-f574-462a-a76f-6fa0afc613c9?api-version=2018-11-01-preview", + "Retry-After": 8 + } + }, + "200": { + "body": { + "subscriptionLink": "/subscriptions/4df8d5c2-1b7e-4dd5-bc61-640704bde633" + } + } + } +} \ No newline at end of file diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json new file mode 100644 index 000000000000..befc022f5aac --- /dev/null +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json @@ -0,0 +1,330 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-01-preview", + "title": "SubscriptionClient", + "description": "Subscription client provides an interface to create and manage Azure subscriptions programmatically." + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Subscription/operations": { + "get": { + "description": "Lists all of the available Microsoft.Subscription API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "getOperations": { + "$ref": "./examples/getOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Subscription/subscriptionOperations/{operationId}": { + "get": { + "description": "Get the status of the pending Microsoft.Subscription API operations.", + "operationId": "SubscriptionOperation_Get", + "x-ms-examples": { + "getPendingSubscriptionOperations": { + "$ref": "./examples/getSubscriptionOperation.json" + } + }, + "responses": { + "202": { + "description": "Accepted. Subscription update is in progress.", + "headers": { + "Location": { + "description": "The URL where the status of the asynchronous operation can be checked.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "integer" + } + } + }, + "200": { + "description": "Successful completion of the asynchronous operation", + "schema": { + "$ref": "#/definitions/SubscriptionCreationResult" + } + } + }, + "parameters": [ + { + "name": "operationId", + "in": "path", + "description": "The operation ID, which can be found from the Location field in the generate recommendation response header.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ] + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoiceSections/{invoiceSectionName}/providers/Microsoft.Subscription/createSubscription": { + "post": { + "description": "Creates an Azure subscription", + "operationId": "SubscriptionFactory_CreateSubscription", + "x-ms-examples": { + "createSubscription": { + "$ref": "./examples/createSubscription.json" + } + }, + "x-ms-long-running-operation": true, + "responses": { + "200": { + "description": "Normal response for a successful query. The response body will contain the data that matches the filters specified in the query parameters.", + "schema": { + "$ref": "#/definitions/SubscriptionCreationResult" + } + }, + "202": { + "description": "Accepted. Subscription creation is in progress.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "parameters": [ + { + "name": "billingAccountName", + "in": "path", + "description": "The name of the commerce root billing account.", + "required": true, + "type": "string" + }, + { + "name": "invoiceSectionName", + "in": "path", + "description": "The name of the invoice section.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "body", + "in": "body", + "description": "The subscription creation parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/SubscriptionCreationParameters" + } + } + ] + } + } + }, + "definitions": { + "SubscriptionCreationResult": { + "description": "The created subscription object.", + "properties": { + "subscriptionLink": { + "description": "The link to the new subscription.", + "type": "string" + } + } + }, + "SubscriptionCreationParameters": { + "description": "Subscription Creation Parameters required to create a new Azure subscription.", + "properties": { + "displayName": { + "description": "The display name of the subscription.", + "type": "string" + }, + "billingProfileId": { + "description": "The ARM id of the billing profile.", + "type": "string" + }, + "skuId": { + "description": "The commerce id of the sku.", + "type": "string" + }, + "costCenter": { + "description": "optional customer cost center", + "type": "string" + }, + "owner": { + "description": "rbac owner of the subscription", + "$ref": "#/definitions/AdPrincipal" + }, + "additionalParameters": { + "description": "Additional, untyped parameters to support custom subscription creation scenarios.", + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "AdPrincipal": { + "description": "Active Directory Principal for subscription creation delegated permission", + "properties": { + "objectId": { + "description": "Object id of the Principal", + "type": "string" + } + }, + "required": [ + "objectId" + ] + }, + "SubscriptionOperationListResult": { + "description": "A list of pending subscription operations.", + "properties": { + "value": { + "description": "A list of pending SubscriptionOperations", + "type": "array", + "items": { + "$ref": "#/definitions/SubscriptionOperation" + } + } + } + }, + "SubscriptionOperation": { + "description": "status of the subscription POST operation.", + "properties": { + "id": { + "type": "string", + "description": "The operation Id.", + "readOnly": true + }, + "status": { + "description": "Status of the pending subscription", + "type": "string" + }, + "statusDetail": { + "description": "Status Detail of the pending subscription", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of the request to list operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Subscription", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + } + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. Current version is 2015-06-01" + } + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/subscription/resource-manager/readme.md b/specification/subscription/resource-manager/readme.md index 74498b7f5e58..676edf37cb20 100644 --- a/specification/subscription/resource-manager/readme.md +++ b/specification/subscription/resource-manager/readme.md @@ -31,10 +31,22 @@ These are the global settings for the Subscription API. ``` yaml openapi-type: arm -tag: package-2018-03-preview +tag: package-2018-11-preview ``` +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.Subscription/preview/2018-11-01-preview/subscriptions.json +- Microsoft.Subscription/stable/2016-06-01/subscriptions.json +title: SubscriptionClient +description: The subscription client +``` + ### Tag: package-2018-03-preview These settings apply only when `--tag=package-2018-03-preview` is specified on the command line. From 12957ef330d7137d15c8f603367c0fcef2d95416 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 20 Nov 2018 11:09:05 -0500 Subject: [PATCH 155/464] typo: cdn/resource-manager/Microsoft.Cdn/cdn.json (#4516) - Supplemnetal -> Supplemental - pictires -> pictures - exisitng -> existing - Double word "the" - acess -> access - adress -> address - reponse -> response --- .../Microsoft.Cdn/stable/2016-10-02/cdn.json | 16 ++++++++-------- .../Microsoft.Cdn/stable/2017-04-02/cdn.json | 18 +++++++++--------- .../Microsoft.Cdn/stable/2017-10-12/cdn.json | 18 +++++++++--------- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json index 269688cfbac5..afb9c55f38d1 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json @@ -307,7 +307,7 @@ "tags": [ "Profiles" ], - "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", "operationId": "Profiles_GenerateSsoUri", "parameters": [ { @@ -878,7 +878,7 @@ { "name": "contentFilePaths", "in": "body", - "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictires/city.png' which loads a single file ", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", "required": true, "schema": { "$ref": "#/definitions/LoadParameters" @@ -1244,7 +1244,7 @@ "tags": [ "CustomDomains" ], - "description": "Gets an exisitng custom domain within an endpoint.", + "description": "Gets an existing custom domain within an endpoint.", "operationId": "CustomDomains_Get", "parameters": [ { @@ -1728,7 +1728,7 @@ } }, "ProfileListResult": { - "description":"Result of the request to list profiles. It contains a list of profile objects and a URL link to get the the next set of results.", + "description":"Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -1846,7 +1846,7 @@ } }, "EndpointListResult": { - "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the the next set of results.", + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -1918,7 +1918,7 @@ "$ref": "#/definitions/OptimizationType" }, "geoFilters": { - "description": "List of rules defining user geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/", + "description": "List of rules defining user geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", "type": "array", "items": { "$ref": "#/definitions/GeoFilter" @@ -2492,7 +2492,7 @@ "type": "object", "properties": { "baseIpAddress": { - "description": "Ip adress itself.", + "description": "IP address itself.", "type": "string" }, "prefixLength": { @@ -2587,7 +2587,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json index 71937bcc8af3..ab181c0c2f75 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json @@ -337,7 +337,7 @@ "tags": [ "Profiles" ], - "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", "operationId": "Profiles_GenerateSsoUri", "x-ms-examples": { "Profiles_GenerateSsoUri": { @@ -983,7 +983,7 @@ { "name": "contentFilePaths", "in": "body", - "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictires/city.png' which loads a single file ", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", "required": true, "schema": { "$ref": "#/definitions/LoadParameters" @@ -1382,7 +1382,7 @@ "tags": [ "CustomDomains" ], - "description": "Gets an exisitng custom domain within an endpoint.", + "description": "Gets an existing custom domain within an endpoint.", "operationId": "CustomDomains_Get", "x-ms-examples": { "CustomDomains_Get": { @@ -1956,7 +1956,7 @@ } }, "ProfileListResult": { - "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the the next set of results.", + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2074,7 +2074,7 @@ } }, "EndpointListResult": { - "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the the next set of results.", + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2116,7 +2116,7 @@ "type": "string" }, "originPath": { - "description": "A directory path on the origin that CDN can use to retreive content from, e.g. contoso.cloudapp.net/originpath.", + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", "type": "string" }, "contentTypesToCompress": { @@ -2151,7 +2151,7 @@ "type": "string" }, "geoFilters": { - "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/", + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", "type": "array", "items": { "$ref": "#/definitions/GeoFilter" @@ -2799,7 +2799,7 @@ "type": "object", "properties": { "baseIpAddress": { - "description": "Ip adress itself.", + "description": "IP address itself.", "type": "string" }, "prefixLength": { @@ -2917,7 +2917,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json index 2ed3b6583119..79ba38c81747 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json @@ -337,7 +337,7 @@ "tags": [ "Profiles" ], - "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemnetal portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", + "description": "Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.", "operationId": "Profiles_GenerateSsoUri", "x-ms-examples": { "Profiles_GenerateSsoUri": { @@ -983,7 +983,7 @@ { "name": "contentFilePaths", "in": "body", - "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictires/city.png' which loads a single file ", + "description": "The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png' which loads a single file ", "required": true, "schema": { "$ref": "#/definitions/LoadParameters" @@ -1382,7 +1382,7 @@ "tags": [ "CustomDomains" ], - "description": "Gets an exisitng custom domain within an endpoint.", + "description": "Gets an existing custom domain within an endpoint.", "operationId": "CustomDomains_Get", "x-ms-examples": { "CustomDomains_Get": { @@ -2001,7 +2001,7 @@ } }, "ProfileListResult": { - "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the the next set of results.", + "description": "Result of the request to list profiles. It contains a list of profile objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2119,7 +2119,7 @@ } }, "EndpointListResult": { - "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the the next set of results.", + "description": "Result of the request to list endpoints. It contains a list of endpoint objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2161,7 +2161,7 @@ "type": "string" }, "originPath": { - "description": "A directory path on the origin that CDN can use to retreive content from, e.g. contoso.cloudapp.net/originpath.", + "description": "A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.", "type": "string" }, "contentTypesToCompress": { @@ -2196,7 +2196,7 @@ "type": "string" }, "geoFilters": { - "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an acess rule to a specified path or content, e.g. block APAC for path /pictures/", + "description": "List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/", "type": "array", "items": { "$ref": "#/definitions/GeoFilter" @@ -2421,7 +2421,7 @@ ] }, "cacheDuration": { - "description": "The duration for which the the content needs to be cached. Allowed format is [d.]hh:mm:ss", + "description": "The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss", "type": "string", "x-nullable": true } @@ -3186,7 +3186,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { From be5640e4aa4ef293659d08a6d28a624e69a41fb2 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 20 Nov 2018 09:24:23 -0800 Subject: [PATCH 156/464] add azure-kusto to Go SDK (#4523) --- .../azure-kusto/resource-manager/readme.go.md | 26 +++++++++++++++++++ .../azure-kusto/resource-manager/readme.md | 1 + 2 files changed, 27 insertions(+) create mode 100644 specification/azure-kusto/resource-manager/readme.go.md diff --git a/specification/azure-kusto/resource-manager/readme.go.md b/specification/azure-kusto/resource-manager/readme.go.md new file mode 100644 index 000000000000..b0bb13f333c9 --- /dev/null +++ b/specification/azure-kusto/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: kusto + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-09-07-preview +``` + +### Tag: package-2018-09-07-preview and go + +These settings apply only when `--tag=package-2018-09-07-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-09-07-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-09-07-preview/$(namespace) +``` diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index c52c08776f31..4ef174cc472c 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -82,6 +82,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + - repo: azure-sdk-for-go ``` ## C# From bd55850b1bd307a3ef18ba5a99d1793edfdf3426 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 20 Nov 2018 16:14:49 -0500 Subject: [PATCH 157/464] typo: cosmos-db/resource-manager/Microsoft.DocumentDB/cosmos-db.json (#4513) - defintions -> definitions - parition -> partition --- .../Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json index 192858572183..8a26a888c30a 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json @@ -1264,7 +1264,7 @@ "x-ms-examples": { "CosmosDBDatabaseGetMetricDefinitions": { "$ref": "./examples/CosmosDBDatabaseGetMetricDefinitions.json" } }, - "description": "Retrieves metric defintions for the given database.", + "description": "Retrieves metric definitions for the given database.", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" @@ -1301,7 +1301,7 @@ "x-ms-examples": { "CosmosDBCollectionGetMetricDefinitions": { "$ref": "./examples/CosmosDBCollectionGetMetricDefinitions.json" } }, - "description": "Retrieves metric defintions for the given collection.", + "description": "Retrieves metric definitions for the given collection.", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" @@ -2009,7 +2009,7 @@ "partitionId": { "readOnly": true, "type": "string", - "description": "The parition id (GUID identifier) of the usages." + "description": "The partition id (GUID identifier) of the usages." }, "partitionKeyRangeId": { "readOnly": true, @@ -2326,7 +2326,7 @@ "partitionId": { "readOnly": true, "type": "string", - "description": "The parition id (GUID identifier) of the metric values." + "description": "The partition id (GUID identifier) of the metric values." }, "partitionKeyRangeId": { "readOnly": true, From 1be46f70b38e01df4389b5ea801dbfa1be67e00d Mon Sep 17 00:00:00 2001 From: grlin <42353527+grlin@users.noreply.github.com> Date: Tue, 20 Nov 2018 13:18:42 -0800 Subject: [PATCH 158/464] Grlin/adding principal typeto ra (#4525) * adding principal type to putRA * updating version to 2018-09-01-preview * base commit, version 2018-01-01-preview * adding principal type + updating version number * refactoring swagger to separate out API calls * adding PrincipalType * removing incorrect 2018-09-01 json file * adding PrincipalType to RoleAssignmentPropertieswithScope * refactoring Go out of readme --- .../authorization-RoleAssignmentsCalls.json | 56 +++++++++++++------ .../examples/DeleteRoleAssignmentById.json | 1 + .../examples/DeleteRoleAssignmentByName.json | 3 +- .../examples/GetAllRoleAssignments.json | 3 +- .../examples/GetRoleAssignmentById.json | 1 + .../examples/GetRoleAssignmentByName.json | 3 +- .../examples/GetRoleAssignmentByScope.json | 1 + .../GetRoleAssignmentsForResource.json | 3 +- .../GetRoleAssignmentsForResourceGroup.json | 3 +- .../examples/PutRoleAssignment.json | 3 +- .../examples/PutRoleAssignmentById.json | 5 +- 11 files changed, 56 insertions(+), 26 deletions(-) diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json index 99a48ce7ba40..327f66b83e0e 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json @@ -492,24 +492,44 @@ "description": "Role Assignments filter" }, "RoleAssignmentPropertiesWithScope": { - "properties": { - "scope": { - "type": "string", - "description": "The role assignment scope." - }, - "roleDefinitionId": { - "type": "string", - "description": "The role definition ID." - }, - "principalId": { - "type": "string", - "description": "The principal ID." - }, - "canDelegate": { - "type": "boolean", - "description": "The Delegation flag for the roleassignment" - } - }, + "properties": { + "scope": { + "type": "string", + "description": "The role assignment scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "Unknown", + "DirectoryRoleTemplate", + "ForeignGroup", + "Application", + "MSI", + "DirectoryObjectOrGroup", + "Everyone" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the roleassignment" + } + }, "description": "Role assignment properties with scope." }, "RoleAssignment": { diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentById.json index 8728e7aa38b7..db2fb17446e7 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentById.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentById.json @@ -10,6 +10,7 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", "canDelegate":false }, diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentByName.json index ceee8a6e3216..d55443329e02 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentByName.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/DeleteRoleAssignmentByName.json @@ -10,8 +10,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetAllRoleAssignments.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetAllRoleAssignments.json index fb5d95543c36..df29cf356b4a 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetAllRoleAssignments.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetAllRoleAssignments.json @@ -11,8 +11,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentById.json index 25e9c928b072..76938ede963e 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentById.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentById.json @@ -9,6 +9,7 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", "canDelegate":false }, diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByName.json index 565c4321d019..236097f49d3f 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByName.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByName.json @@ -11,8 +11,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByScope.json index b37258d178bb..ec570a61ce58 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByScope.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentByScope.json @@ -11,6 +11,7 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", "canDelegate":false }, diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResource.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResource.json index 0464db8bac19..0fe2980d59dc 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResource.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResource.json @@ -16,8 +16,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResourceGroup.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResourceGroup.json index 5ef0fb9c83dd..20469c50be0c 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResourceGroup.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/GetRoleAssignmentsForResourceGroup.json @@ -12,8 +12,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignment.json index 59cdae83f7b3..fee81783787c 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignment.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignment.json @@ -18,8 +18,9 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", - "canDelegate":false + "canDelegate": false }, "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", "type": "Microsoft.Authorization/roleAssignments", diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json index ddbaaea7afdb..b54ec5fd81bf 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/examples/PutRoleAssignmentById.json @@ -6,8 +6,8 @@ "properties": { "roleDefinitionId": "/subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/roleDefinitions/de139f84-1756-47ae-9be6-808fbbe84772", "principalId": "d93a38bc-d029-4160-bfb0-fbda779ac214", - "principalType": "User", - "canDelegate":false + "principalType": "User", + "canDelegate": false } }, "api-version": "2018-09-01-preview" @@ -18,6 +18,7 @@ "properties": { "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", "principalId": "Pid", + "principalType": "Ptype", "scope": "/subscriptions/subId/resourcegroups/rgname", "canDelegate":false }, From c93ec80c0a369c6e5566da4d34c3d527f8327168 Mon Sep 17 00:00:00 2001 From: hvermis Date: Tue, 20 Nov 2018 13:25:45 -0800 Subject: [PATCH 159/464] [Datafactory]Adding get Dataplane access API (#3957) * Adding get Dataplane readonly token API * Updated the casing and the example * Updating dataplane access APIs * Updating examples --- .../stable/2018-06-01/datafactory.json | 93 +++++++++++++++++++ .../Factories_GetDataPlaneAccess.json | 37 ++++++++ 2 files changed, 130 insertions(+) create mode 100644 specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.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 ba0711ebb626..54f3381539eb 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 @@ -446,6 +446,57 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/getDataPlaneAccess": { + "post": { + "tags": [ + "factories" + ], + "operationId": "Factories_GetDataPlaneAccess", + "x-ms-examples": { + "Factories_GetDataPlaneAccess": { + "$ref": "./examples/Factories_GetDataPlaneAccess.json" + } + }, + "description": "Get Data Plane access.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "policy", + "description": "Data Plane user access policy definition.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UserAccessPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/AccessPolicyResponse" + } + }, + "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}/integrationRuntimes": { "get": { "tags": [ @@ -3541,6 +3592,48 @@ } } }, + "UserAccessPolicy": { + "description": "Get Data Plane read only token request definition.", + "properties": { + "permissions" : { + "description": "The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access.", + "type": "string" + }, + "accessResourcePath" : { + "description": "The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource.", + "type": "string" + }, + "profileName" : { + "description": "The name of the profile. Currently only the default is supported. The default value is DefaultProfile.", + "type": "string" + }, + "startTime": { + "description": "Start time for the token. If not specified the current time will be used.", + "type": "string" + }, + "expireTime": { + "description": "Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours.", + "type": "string" + } + } + }, + "AccessPolicyResponse": { + "description": "Get Data Plane read only token response definition.", + "properties": { + "policy" : { + "description": "The user access policy.", + "$ref": "#/definitions/UserAccessPolicy" + }, + "accessToken": { + "description": "Data Plane read only access token.", + "type": "string" + }, + "dataPlaneUrl": { + "description": "Data Plane service base URL.", + "type": "string" + } + } + }, "FactoryProperties": { "description": "Factory resource properties.", "properties": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json new file mode 100644 index 000000000000..4f1da8e9e906 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/Factories_GetDataPlaneAccess.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "policy": { + "permissions": "r", + "accessResourcePath": "", + "profileName": "DefaultProfile", + "startTime": "2018-11-10T02:46:20.2659347Z", + "expireTime": "2018-11-10T09:46:20.2659347Z" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Wed, 07 Nov 2018 03:41:57 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11996", + "x-ms-request-id": "82bc20d2-4bec-496d-a1c8-3f7746fed307", + "x-ms-correlation-request-id": "82bc20d2-4bec-496d-a1c8-3f7746fed307" + }, + "body": { + "policy": { + "permissions": "r", + "accessResourcePath": "", + "profileName": "DefaultProfile", + "startTime": "2018-11-10T02:46:20.2659347Z", + "expireTime": "2018-11-10T09:46:20.2659347Z" + }, + "dataPlaneUrl": "https://rpeastus.svc.datafactory.azure.com:4433", + "accessToken": "**********" + } + } + } +} \ No newline at end of file From 7019b7040355439b0d2ee808f6a64735434cdd34 Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Wed, 21 Nov 2018 06:08:19 +0800 Subject: [PATCH 160/464] Change the suppress type name (#4499) --- specification/resources/resource-manager/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 8f12f1646b4d..ac4f25f891ea 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -307,11 +307,11 @@ directive: from: resources.json where: $.definitions.TagValue.properties reason: TagValue is a top level property - - suppress: BodyTopLevelProperties + - suppress: RequiredPropertiesMissingInResourceModel from: resources.json where: $.definitions.TagValue reason: TagValue will be deprecated soon - - suppress: BodyTopLevelProperties + - suppress: RequiredPropertiesMissingInResourceModel from: resources.json where: $.definitions.TagDetails reason: TagDetails will be deprecated soon From 3fdbae8e264b6257e6fae48160e85aeafa389252 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 20 Nov 2018 18:30:09 -0500 Subject: [PATCH 161/464] typo: Fix apimanagement/resource-manager/Microsoft.ApiManagement/apimbackends.json (#4510) - parition -> partition - Reconect -> Reconnect --- .../preview/2018-06-01-preview/apimbackends.json | 4 ++-- .../stable/2017-03-01/apimbackends.json | 2 +- .../stable/2018-01-01/apimbackends.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json index 442b78e9219d..035ce4e7e2d8 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimbackends.json @@ -591,7 +591,7 @@ "type": "string" }, "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the parition.", + "description": "Maximum number of retries while attempting resolve the partition.", "format": "int32", "type": "integer" }, @@ -748,7 +748,7 @@ "after": { "type": "string", "format": "duration", - "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconect is PT2M." + "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." } }, "description": "Properties to control reconnect requests." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json index 499f708cade8..f36d7725f6db 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimbackends.json @@ -593,7 +593,7 @@ "type": "string" }, "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the parition.", + "description": "Maximum number of retries while attempting resolve the partition.", "format": "int32", "type": "integer" }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json index 10c59fd61c8e..12a0ea9ff041 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json @@ -591,7 +591,7 @@ "type": "string" }, "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the parition.", + "description": "Maximum number of retries while attempting resolve the partition.", "format": "int32", "type": "integer" }, From b431cf1c8519082253bc4c38e08171dbb9114900 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 20 Nov 2018 18:50:53 -0500 Subject: [PATCH 162/464] typo: Fix Microsoft.Web/CommonDefinitions.json (#4504) - Double word "to" - resourse -> resource - mimuntes -> minutes - specificed -> specified - successfull -> successful - crendentials -> credentials --- .../stable/2016-03-01/CommonDefinitions.json | 10 +++++----- .../stable/2018-02-01/CommonDefinitions.json | 8 ++++---- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json index 9f0bdfa0207f..950eb802a997 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json @@ -676,7 +676,7 @@ "type": "object", "properties": { "unit": { - "description": "Units of measurement for the quota resourse.", + "description": "Units of measurement for the quota resource.", "type": "string" }, "nextResetTime": { @@ -1372,12 +1372,12 @@ }, "changeStep": { "format": "double", - "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", + "description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", "type": "number" }, "changeIntervalInMinutes": { "format": "int32", - "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.", + "description": "Specifies interval in minutes to reevaluate ReroutePercentage.", "type": "integer" }, "minReroutePercentage": { @@ -2311,7 +2311,7 @@ } }, "SlotSwapStatus": { - "description": "The status of the last successfull slot swap operation.", + "description": "The status of the last successful slot swap operation.", "type": "object", "properties": { "timestampUtc": { @@ -2507,7 +2507,7 @@ } }, "User": { - "description": "User crendentials used for publishing activity.", + "description": "User credentials used for publishing activity.", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json index f69696c75dae..1cfb2195d44a 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json @@ -1567,12 +1567,12 @@ }, "changeStep": { "format": "double", - "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", + "description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.", "type": "number" }, "changeIntervalInMinutes": { "format": "int32", - "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.", + "description": "Specifies interval in minutes to reevaluate ReroutePercentage.", "type": "integer" }, "minReroutePercentage": { @@ -2554,7 +2554,7 @@ } }, "SlotSwapStatus": { - "description": "The status of the last successfull slot swap operation.", + "description": "The status of the last successful slot swap operation.", "type": "object", "properties": { "timestampUtc": { @@ -2722,7 +2722,7 @@ } }, "User": { - "description": "User crendentials used for publishing activity.", + "description": "User credentials used for publishing activity.", "type": "object", "allOf": [ { From b30a83d9d5aa3d4f5fa41181b267b6a76b4bbd66 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 20 Nov 2018 18:51:45 -0500 Subject: [PATCH 163/464] typo: iothub/resource-manager/Microsoft.Devices/iothub.json (#4512) - Double word "the" - parition -> partition --- .../Microsoft.Devices/stable/2016-02-03/iothub.json | 6 +++--- .../Microsoft.Devices/stable/2017-01-19/iothub.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2016-02-03/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2016-02-03/iothub.json index 845d81eecd3a..4f82bb6c68da 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2016-02-03/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2016-02-03/iothub.json @@ -392,7 +392,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1166,7 +1166,7 @@ }, "partitionCount": { "format": "int32", - "description": "The number of paritions 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.", + "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": { @@ -1194,7 +1194,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-01-19/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-01-19/iothub.json index 7135172257c0..2e01398dee2e 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-01-19/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-01-19/iothub.json @@ -381,7 +381,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1136,7 +1136,7 @@ }, "partitionCount": { "format": "int32", - "description": "The number of paritions 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.", + "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": { @@ -1164,7 +1164,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, From 7eac00e198e9d16c5f5d8c2fb8869fac81f5caa0 Mon Sep 17 00:00:00 2001 From: saran94 Date: Wed, 21 Nov 2018 07:15:53 +0530 Subject: [PATCH 164/464] DataBox : Swagger and example changes for next version of client DLL (#4393) * Managed disk updates * changes * changing examples for managed disk details * changing readme and dll version in examples --- .../stable/2018-01-01/databox.json | 137 +++++++++++++++--- .../examples/AvailableSkusPost.json | 2 +- .../examples/BookShipmentPickupPost.json | 2 +- .../2018-01-01/examples/JobsCancelPost.json | 6 +- .../2018-01-01/examples/JobsCreate.json | 16 +- .../2018-01-01/examples/JobsDelete.json | 6 +- .../stable/2018-01-01/examples/JobsGet.json | 10 +- .../stable/2018-01-01/examples/JobsGet1.json | 8 +- .../stable/2018-01-01/examples/JobsGet2.json | 16 +- .../stable/2018-01-01/examples/JobsGet3.json | 16 +- .../stable/2018-01-01/examples/JobsGet4.json | 16 +- .../stable/2018-01-01/examples/JobsGet5.json | 16 +- .../stable/2018-01-01/examples/JobsList.json | 2 +- .../examples/JobsListByResourceGroup.json | 8 +- .../examples/JobsListCredentials.json | 2 +- .../stable/2018-01-01/examples/JobsPatch.json | 10 +- .../2018-01-01/examples/OperationsGet.json | 2 +- .../examples/ValidateAddressPost.json | 2 +- .../databox/resource-manager/readme.md | 2 +- 19 files changed, 197 insertions(+), 82 deletions(-) diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json index e36656b72347..bdc93069e144 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json @@ -147,7 +147,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { "post": { "tags": [ @@ -305,7 +305,7 @@ }, "JobsGet5": { "$ref": "./examples/JobsGet5.json" - } + } } }, "put": { @@ -397,11 +397,11 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "JobsDelete": { - "$ref": "./examples/JobsDelete.json" - } + "JobsDelete": { + "$ref": "./examples/JobsDelete.json" } - }, + } + }, "patch": { "tags": [ "Jobs" @@ -455,11 +455,11 @@ } }, "x-ms-long-running-operation": true, - "x-ms-examples": { - "JobsPatch": { - "$ref": "./examples/JobsPatch.json" - } + "x-ms-examples": { + "JobsPatch": { + "$ref": "./examples/JobsPatch.json" } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp": { @@ -555,10 +555,10 @@ } }, "x-ms-examples": { - "JobsCancelPost": { - "$ref": "./examples/JobsCancelPost.json" - } + "JobsCancelPost": { + "$ref": "./examples/JobsCancelPost.json" } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials": { @@ -921,6 +921,18 @@ "description": "Total amount of data to be processed by the job.", "type": "integer", "readOnly": true + }, + "filesProcessed": { + "format": "int64", + "description": "Number of files processed by the job as of now.", + "type": "integer", + "readOnly": true + }, + "totalFilesToProcess": { + "format": "int64", + "description": "Total number of files to be processed by the job.", + "type": "integer", + "readOnly": true } } }, @@ -1307,17 +1319,90 @@ } }, "DestinationAccountDetails": { - "description": "Details for the destination account.", + "description": "Details of the destination of the data", "required": [ - "accountId" + "dataDestinationType" ], "type": "object", "properties": { + "dataDestinationType": { + "description": "Data Destination Type.", + "enum": [ + "UnknownType", + "StorageAccount", + "ManagedDisk" + ], + "type": "string", + "x-ms-enum": { + "name": "DataDestinationType", + "modelAsExtensible": true, + "values": [ + { + "value": "UnknownType", + "description": "Unknown type." + }, + { + "value": "StorageAccount", + "description": "Storage Accounts ." + }, + { + "value": "ManagedDisk", + "description": "Azure Managed disk storage." + } + ] + } + }, "accountId": { - "description": "Destination storage account id.", + "description": "Arm Id of the destination where the data has to be moved.", "type": "string" } - } + }, + "discriminator": "dataDestinationType" + }, + "DestinationManagedDiskDetails": { + "description": "Details for the destination compute disks.", + "required": [ + "resourceGroupId", + "stagingStorageAccountId", + "dataDestinationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DestinationAccountDetails" + } + ], + "properties": { + "resourceGroupId": { + "description": "Destination Resource Group Id where the Compute disks should be created.", + "type": "string" + }, + "stagingStorageAccountId": { + "description": "Arm Id of the storage account that can be used to copy the vhd for staging.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ManagedDisk" + }, + "DestinationStorageAccountDetails": { + "description": "Details for the destination storage account.", + "required": [ + "storageAccountId", + "dataDestinationType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DestinationAccountDetails" + } + ], + "properties": { + "storageAccountId": { + "description": "Destination Storage Account Arm Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "StorageAccount" }, "DestinationToServiceLocationMap": { "description": "Map of destination location to service location", @@ -2071,7 +2156,7 @@ } }, "x-ms-azure-resource": true - }, + }, "ShareCredentialDetails": { "description": "Credential details of the shares in account.", "type": "object", @@ -2088,7 +2173,8 @@ "HCS", "BlockBlob", "PageBlob", - "AzureFile" + "AzureFile", + "ManagedDisk" ], "type": "string", "readOnly": true, @@ -2115,6 +2201,10 @@ { "value": "AzureFile", "description": "Azure storage file format." + }, + { + "value": "ManagedDisk", + "description": "Azure Compute Disk." } ] } @@ -2411,7 +2501,8 @@ "Country", "Region", "Feature", - "OfferType" + "OfferType", + "NoSubscriptionInfo" ], "type": "string", "readOnly": true, @@ -2429,7 +2520,7 @@ }, { "value": "Region", - "description": "SKU is not available to push data to the requested storage account region." + "description": "SKU is not available to push data to the requested Azure region." }, { "value": "Feature", @@ -2438,6 +2529,10 @@ { "value": "OfferType", "description": "Subscription does not have required offer types for the SKU." + }, + { + "value": "NoSubscriptionInfo", + "description": "Subscription has not registered to Microsoft.DataBox and Service does not have the subscription notification." } ] } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/AvailableSkusPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/AvailableSkusPost.json index 3a73646a8423..edb90016b3de 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/AvailableSkusPost.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/AvailableSkusPost.json @@ -11,7 +11,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/BookShipmentPickupPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/BookShipmentPickupPost.json index d0cc988ee1e9..09ce8ab47d5a 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/BookShipmentPickupPost.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/BookShipmentPickupPost.json @@ -12,7 +12,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCancelPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCancelPost.json index 6c41a02d2b74..c71352be1d9e 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCancelPost.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCancelPost.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCreate.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCreate.json index 6ca49114f1d1..65eb998c1695 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCreate.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsCreate.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "x-ms-client-request-id": [ "ee686d79-42c2-4b01-9afe-5e99f4cabfee" @@ -12,7 +12,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" @@ -44,7 +44,11 @@ }, "destinationAccountDetails": [ { - "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + }, + { + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt" } ] } @@ -73,8 +77,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsDelete.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsDelete.json index 4176101c29be..8b481e5adb1b 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsDelete.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsDelete.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet.json index 9116e659a520..bef4a96185f2 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet.json @@ -1,12 +1,12 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -24,8 +24,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet1.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet1.json index 9116e659a520..c784056a566b 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet1.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet1.json @@ -2,11 +2,11 @@ "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -24,8 +24,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet2.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet2.json index b32c673e9395..d970464ffdbf 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet2.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet2.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -133,7 +133,11 @@ }, "destinationAccountDetails": [ { - "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + }, + { + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt" } ], "errorDetails": [], @@ -146,8 +150,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet3.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet3.json index 0fc5ff08cfdf..e2c23b5e3497 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet3.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet3.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -133,7 +133,11 @@ }, "destinationAccountDetails": [ { - "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + }, + { + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt" } ], "errorDetails": [], @@ -146,8 +150,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet4.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet4.json index 70ca00535aff..bf3086f81943 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet4.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet4.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -104,7 +104,11 @@ }, "destinationAccountDetails": [ { - "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + }, + { + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt" } ], "errorDetails": [], @@ -118,8 +122,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet5.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet5.json index 6261006dab2f..4f8570c50369 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet5.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsGet5.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -76,7 +76,11 @@ }, "destinationAccountDetails": [ { - "accountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + "storageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount" + }, + { + "stagingStorageAccountId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt/providers/Microsoft.Storage/storageAccounts/databoxbvttestaccount", + "resourceGroupId": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourcegroups/databoxbvt" } ], "errorDetails": [], @@ -91,8 +95,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsList.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsList.json index 3f683214b99d..b4e79f598e19 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsList.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsList.json @@ -11,7 +11,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListByResourceGroup.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListByResourceGroup.json index 6d811a3a2cb4..c72f92c28222 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListByResourceGroup.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListByResourceGroup.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", + "resourceGroupName": "SdkRg9836", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -12,7 +12,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { @@ -32,8 +32,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } ] diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListCredentials.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListCredentials.json index 4f2db17c7dda..3871bbbc49cf 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListCredentials.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsListCredentials.json @@ -12,7 +12,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsPatch.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsPatch.json index 4239ba14e7c0..c4bd40281503 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsPatch.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/JobsPatch.json @@ -1,8 +1,8 @@ { "parameters": { "subscriptionId": "fa68082f-8ff7-4a25-95c7-ce9da541242f", - "resourceGroupName": "SdkRg8120", - "jobName": "SdkJob7196", + "resourceGroupName": "SdkRg9836", + "jobName": "SdkJob8367", "api-version": "2018-01-01", "$expand": "details", "x-ms-client-request-id": [ @@ -13,7 +13,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" @@ -64,8 +64,8 @@ "sku": { "name": "DataBox" }, - "name": "SdkJob7196", - "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg8120/providers/Microsoft.DataBox/jobs/SdkJob7196", + "name": "SdkJob8367", + "id": "/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/SdkRg9836/providers/Microsoft.DataBox/jobs/SdkJob8367", "type": "Microsoft.DataBox/jobs" } } diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/OperationsGet.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/OperationsGet.json index 994dd06680ba..9d38e7506c0b 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/OperationsGet.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/OperationsGet.json @@ -9,7 +9,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ] }, "responses": { diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/ValidateAddressPost.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/ValidateAddressPost.json index 4471fd16f463..864fd09dd723 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/ValidateAddressPost.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/examples/ValidateAddressPost.json @@ -11,7 +11,7 @@ ], "User-Agent": [ "FxVersion/4.6.26614.01", - "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.0.0" + "Microsoft.Azure.Management.DataBox.DataBoxManagementClient/1.1.0" ], "Content-Type": [ "application/json; charset=utf-8" diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index d9c4c20dc66e..aee1a57f46a0 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -53,8 +53,8 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-go - - repo: azure-sdk-for-ruby - repo: azure-sdk-for-java + - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_databox'] ``` From 8d968c2ce57a5c3647f2859f06d0ecab6bedac81 Mon Sep 17 00:00:00 2001 From: Daniel Qiu Date: Wed, 21 Nov 2018 11:31:02 -0800 Subject: [PATCH 165/464] Adds canFailover boolean flag under storage account's GeoReplicationStats properties (#4532) --- .../2018-07-01/examples/StorageAccountGetProperties.json | 3 ++- .../Microsoft.Storage/stable/2018-07-01/storage.json | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json index 4f5742ea9e54..5a90b4563f5e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/StorageAccountGetProperties.json @@ -16,7 +16,8 @@ "properties": { "geoReplicationStats": { "status": "Live", - "lastSyncTime": "2018-10-30T00:25:34Z" + "lastSyncTime": "2018-10-30T00:25:34Z", + "canFailover": true }, "isHnsEnabled": true, "azureFilesAadIntegration": true, diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json index 6840123bcb4e..9f1270cce17a 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json @@ -1335,6 +1335,11 @@ "type": "string", "format": "date-time", "description": "All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap." + }, + "canFailover": { + "readOnly": true, + "type": "boolean", + "description": "A boolean flag which indicates whether or not account failover is supported for the account." } }, "description": "Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account." From 3043da4eb3277f4a3aee1afe141bd1b626ec0ce3 Mon Sep 17 00:00:00 2001 From: SamhitaK6 <44000399+SamhitaK6@users.noreply.github.com> Date: Wed, 21 Nov 2018 12:10:15 -0800 Subject: [PATCH 166/464] [Microsoft.Billing]: Updating swagger with rename changes required. (#4495) * Microsoft.Billing: Gtm ImportRequest swagger * Taking CR comments. * Taking CR comments. * [Microsoft.Billing]: Updating swagger with rename changes required. --- .../preview/2018-08-01-preview/billing.json | 1381 +++++++++++++++++ .../examples/AcceptTransfer.json | 55 + .../examples/BillingPeriodsGet.json | 24 + .../examples/BillingPeriodsList.json | 27 + .../examples/CancelTransfer.json | 29 + .../examples/DeclineTransfer.json | 29 + .../examples/EnrollmentAccountsGet.json | 18 + .../examples/EnrollmentAccountsList.json | 29 + .../examples/GetRecipientTransfer.json | 41 + .../examples/GetTransfer.json | 40 + .../examples/InitiateTransfer.json | 34 + .../examples/InvoicesExpand.json | 34 + .../examples/InvoicesGet.json | 28 + .../examples/InvoicesGetLatest.json | 27 + .../examples/InvoicesList.json | 27 + .../examples/ListRecipientTransfers.json | 44 + .../examples/ListTransfers.json | 43 + 17 files changed, 1910 insertions(+) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json new file mode 100644 index 000000000000..069933f95a46 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -0,0 +1,1381 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-08-01-preview", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/enrollmentAccounts": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsList": { + "$ref": "./examples/EnrollmentAccountsList.json" + } + }, + "operationId": "EnrollmentAccounts_List", + "description": "Lists the enrollment accounts the caller has access to.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{name}": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsGet": { + "$ref": "./examples/EnrollmentAccountsGet.json" + } + }, + "operationId": "EnrollmentAccounts_Get", + "description": "Gets a enrollment account by name.", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Enrollment Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_List", + "description": "Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "externalDocs": { + "url": "https://go.microsoft.com/fwlink/?linkid=844490" + }, + "x-ms-examples": { + "BillingPeriodsList": { + "$ref": "./examples/BillingPeriodsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N billing periods.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriodsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_Get", + "description": "Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "BillingPeriodsGet": { + "$ref": "./examples/BillingPeriodsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "billingPeriodName", + "description": "The name of a BillingPeriod resource.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_List", + "description": "Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "externalDocs": { + "url": "https://go.microsoft.com/fwlink/?linkid=842057" + }, + "x-ms-examples": { + "InvoicesList": { + "$ref": "./examples/InvoicesList.json" + }, + "InvoicesExpand": { + "$ref": "./examples/InvoicesExpand.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N invoices.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_Get", + "description": "Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "InvoicesGet": { + "$ref": "./examples/InvoicesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "invoiceName", + "description": "The name of an invoice resource.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_GetLatest", + "description": "Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "InvoicesGetLatest": { + "$ref": "./examples/InvoicesGetLatest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available billing REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/initiateTransfer": { + "post": { + "description": "Initiates the request to transfer the GTM or legacy subscriptions or RIs to GTM.", + "operationId": "Transfer_Initiate", + "x-ms-examples": { + "InitiateTransfer": { + "$ref": "./examples/InitiateTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BillingAccountIdParameter" + }, + { + "$ref": "#/parameters/InvoiceSectionIdParameter" + }, + { + "$ref": "#/parameters/InitiateTransferRequestParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Initiated transfer details.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers/{transferId}": { + "get": { + "description": "Gets the transfer details for given transfer Id.", + "operationId": "Transfer_Get", + "x-ms-examples": { + "TransferGet": { + "$ref": "./examples/GetTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BillingAccountIdParameter" + }, + { + "$ref": "#/parameters/InvoiceSectionIdParameter" + }, + { + "$ref": "#/parameters/TransferIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of transfer.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Cancels the transfer for given transfer Id.", + "operationId": "Transfer_Cancel", + "x-ms-examples": { + "TransferCancel": { + "$ref": "./examples/CancelTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BillingAccountIdParameter" + }, + { + "$ref": "#/parameters/InvoiceSectionIdParameter" + }, + { + "$ref": "#/parameters/TransferIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of canceled transfer.", + "schema": { + "$ref": "#/definitions/TransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers": { + "get": { + "description": "Lists all transfer's details initiated from given invoice section.", + "operationId": "Transfers_List", + "x-ms-examples": { + "TransfersList": { + "$ref": "./examples/ListTransfers.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BillingAccountIdParameter" + }, + { + "$ref": "#/parameters/InvoiceSectionIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "List of transfers initiated from this invoice section.", + "schema": { + "$ref": "#/definitions/TransferDetailsListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferId}/acceptTransfer": { + "post": { + "summary": "Accepts the transfer with given transfer Id.", + "operationId": "Transfer_Accept", + "x-ms-examples": { + "AcceptTransfer": { + "$ref": "./examples/AcceptTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/TransferIdParameter" + }, + { + "$ref": "#/parameters/AcceptTransferRequestParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the accepted transfer.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferId}/declineTransfer": { + "post": { + "summary": "Declines the transfer with given transfer Id.", + "operationId": "Transfer_Decline", + "x-ms-examples": { + "DeclineTransfer": { + "$ref": "./examples/DeclineTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/TransferIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the declined transfer.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers/{transferId}/": { + "get": { + "summary": "Gets the transfer with given transfer Id.", + "operationId": "RecipientTransfer_Get", + "x-ms-examples": { + "RecipientTransferGet": { + "$ref": "./examples/GetRecipientTransfer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/TransferIdParameter" + } + ], + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "Details of the transfers with given Id.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/transfers": { + "get": { + "summary": "Lists the transfers received by caller.", + "operationId": "RecipientTransfer_List", + "x-ms-examples": { + "RecipientTransfersList": { + "$ref": "./examples/ListRecipientTransfers.json" + } + }, + "tags": [ + "AIPController" + ], + "responses": { + "200": { + "description": "List of transfers received by caller.", + "schema": { + "$ref": "#/definitions/RecipientTransferDetailsListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "EnrollmentAccount": { + "description": "An enrollment account resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An enrollment account.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnrollmentAccountProperties" + } + } + }, + "EnrollmentAccountListResult": { + "description": "Result of listing enrollment accounts.", + "properties": { + "value": { + "description": "The list of enrollment accounts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EnrollmentAccountProperties": { + "description": "The properties of the enrollment account.", + "properties": { + "principalName": { + "description": "The account owner's principal name.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriod": { + "description": "A billing period resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A billing period.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingPeriodProperties" + } + } + }, + "BillingPeriodsListResult": { + "description": "Result of listing billing periods. It contains a list of available billing periods in reverse chronological order.", + "properties": { + "value": { + "description": "The list of billing periods.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriodProperties": { + "description": "The properties of the billing period.", + "properties": { + "billingPeriodStartDate": { + "description": "The start of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "billingPeriodEndDate": { + "description": "The end of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "invoiceIds": { + "description": "Array of invoice ids that associated with.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "DownloadUrl": { + "description": "A secure URL that can be used to download a PDF invoice until the URL expires.", + "properties": { + "expiryTime": { + "description": "The time in UTC at which this download URL will expire.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "url": { + "description": "The URL to the PDF file.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Invoice": { + "description": "An invoice resource can be used download a PDF version of an invoice.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An invoice.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InvoiceProperties" + } + } + }, + "InvoicesListResult": { + "description": "Result of listing invoices. It contains a list of available invoices in reverse chronological order.", + "properties": { + "value": { + "description": "The list of invoices.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Invoice" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceProperties": { + "description": "The properties of the invoice.", + "properties": { + "downloadUrl": { + "description": "A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached.", + "$ref": "#/definitions/DownloadUrl" + }, + "invoicePeriodStartDate": { + "description": "The start of the date range covered by the invoice.", + "type": "string", + "format": "date", + "readOnly": true + }, + "invoicePeriodEndDate": { + "description": "The end of the date range covered by the invoice.", + "type": "string", + "format": "date", + "readOnly": true + }, + "billingPeriodIds": { + "description": "Array of billing perdiod ids that the invoice is attributed to.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "Operation": { + "description": "A Billing REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Billing.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Invoice, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "Result listing billing operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of billing operations supported by the Microsoft.Billing resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "x-ms-azure-resource": true + }, + "InitiateTransferRequest": { + "type": "object", + "description": "Request parameters to initiate transfer.", + "properties": { + "properties": { + "description": "Request parameters to initiate transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitiateTransferProperties" + } + } + }, + "InitiateTransferProperties": { + "type": "object", + "description": "Request parameters to initiate transfer.", + "properties": { + "billingProfileId": { + "type": "string", + "description": "Target Usage context for devTest subscriptions." + }, + "recipientEmailId": { + "type": "string", + "description": "Email Id of recipient for transfer." + } + } + }, + "AcceptTransferRequest": { + "type": "object", + "description": "Request parameters to accept transfer.", + "properties": { + "properties": { + "description": "Request parameters to accept transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AcceptTransferProperties" + } + } + }, + "AcceptTransferProperties": { + "type": "object", + "description": "Request parameters to accept transfer.", + "properties": { + "productDetails": { + "description": "Request parameters to accept transfer.", + "type": "array", + "items": { + "$ref": "#/definitions/ProductDetails" + } + } + } + }, + "ProductDetails": { + "type": "object", + "description": "Details of the product to be transferred.", + "properties": { + "productType": { + "description": "Type of the prouct to be transferred.", + "$ref": "#/definitions/ProductType" + }, + "productId": { + "type": "string", + "description": "Id of product to be transferred." + } + } + }, + "ProductType": { + "type": "string", + "description": "Type of the product to be transferred.", + "enum": [ + "AzureSubscription", + "AzureReservation" + ], + "x-ms-enum": { + "name": "productType", + "modelAsString": true + } + }, + "TransferDetails": { + "type": "object", + "description": "Details of the transfer.", + "properties": { + "properties": { + "description": "Details of the transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TransferProperties" + } + } + }, + "RecipientTransferDetails": { + "type": "object", + "description": "Details of the transfer.", + "properties": { + "properties": { + "description": "Details of the transfer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RecipientTransferProperties" + } + } + }, + "DetailedTransferStatus": { + "type": "object", + "description": "Detailed transfer status.", + "properties": { + "productType": { + "type": "string", + "$ref": "#/definitions/ProductType", + "readOnly": true, + "description": "Type of product being transferred." + }, + "productId": { + "type": "string", + "readOnly": true, + "description": "Id of product being transferred." + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/ProductTransferStatus", + "readOnly": true, + "description": "Transfer status." + }, + "errorDetails": { + "description": "Error details for transfer execution.", + "$ref": "#/definitions/Error" + } + } + }, + "Error": { + "description": "Error details for transfer execution.", + "properties": { + "errorCode": { + "type": "string", + "readOnly": true, + "description": "Error code." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "Error message." + } + } + }, + "EligibleProductType": { + "type": "string", + "description": "Type of the products that can be transferred.", + "enum": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "x-ms-enum": { + "name": "eligibleProductType", + "modelAsString": true + } + }, + "TransferProperties": { + "description": "Transfer details", + "type": "object", + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Transfer creation time.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transfer expiration time." + }, + "invoiceSectionId": { + "type": "string", + "description": "Target invoice setion Id.", + "readOnly": true + }, + "billingAccountId": { + "type": "string", + "description": "Target billing account Id.", + "readOnly": true + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of recipient of transfer." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of initiator of transfer." + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "Email Id who user canceled the transfer." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transfer last modification time." + }, + "detailedTransferStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed transfer status.", + "items": { + "$ref": "#/definitions/DetailedTransferStatus" + } + } + } + }, + "RecipientTransferProperties": { + "description": "Transfer Details.", + "type": "object", + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "description": "Transfer creation time.", + "readOnly": true + }, + "expirationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transfer expiration time." + }, + "allowedProductType": { + "type": "array", + "readOnly": true, + "description": "Type of subscriptions that can be transferred.", + "items": { + "$ref": "#/definitions/EligibleProductType" + } + }, + "transferStatus": { + "type": "string", + "$ref": "#/definitions/TransferStatus", + "description": "Overall transfer status.", + "readOnly": true + }, + "recipientEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of recipient of transfer." + }, + "initiatorEmailId": { + "type": "string", + "readOnly": true, + "description": "Email Id of initiator of transfer." + }, + "canceledBy": { + "type": "string", + "readOnly": true, + "description": "Email Id who user canceled the transfer." + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Transfer last modification time." + }, + "detailedTransferStatus": { + "type": "array", + "readOnly": true, + "description": "Detailed transfer status.", + "items": { + "$ref": "#/definitions/DetailedTransferStatus" + } + } + } + }, + "TransferStatus": { + "type": "string", + "description": "Possible transfer status.", + "enum": [ + "Pending", + "InProgress", + "Completed", + "CompletedWithErrors", + "Failed", + "Canceled", + "Declined" + ], + "x-ms-enum": { + "name": "transferStatus", + "modelAsString": true + } + }, + "ProductTransferStatus": { + "type": "string", + "description": "Possible transfer status.", + "enum": [ + "NotStarted", + "InProgress", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "productTransferStatus", + "modelAsString": true + } + }, + "RecipientTransferDetailsListResult": { + "description": "Result of listing details of the transfer received by caller.", + "properties": { + "value": { + "description": "The list of transfers received by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RecipientTransferDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "TransferDetailsListResult": { + "description": "Result of listing details of the transfer initiated by caller.", + "properties": { + "value": { + "description": "The list of transfers initiated by caller.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TransferDetails" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "BillingAccountIdParameter": { + "name": "billingAccountId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Billing account Id." + }, + "InvoiceSectionIdParameter": { + "name": "invoiceSectionId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Invoice section Id." + }, + "TransferIdParameter": { + "name": "transferId", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "description": "Transfer Id." + }, + "InitiateTransferRequestParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Initiate transfer parameters.", + "schema": { + "$ref": "#/definitions/InitiateTransferRequest" + } + }, + "AcceptTransferRequestParameter": { + "name": "body", + "x-ms-parameter-location": "method", + "in": "body", + "required": true, + "description": "Accept transfer parameters.", + "schema": { + "$ref": "#/definitions/AcceptTransferRequest" + } + } + }, + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json new file mode 100644 index 000000000000..c7de2db09d4e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "transferId": "transferId", + "body": { + "properties": { + "value": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId" + } + ] + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json new file mode 100644 index 000000000000..7bd4d0157469 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "billingPeriodName": "201702-1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "name": "201702-1", + "type": "Microsoft.Billing/billingPeriods", + "properties": { + "billingPeriodStartDate": "2017-01-01", + "billingPeriodEndDate": "2017-02-01", + "invoiceIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json new file mode 100644 index 000000000000..1c79897ad719 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "name": "201702-1", + "type": "Microsoft.Billing/billingPeriods", + "properties": { + "billingPeriodStartDate": "2017-01-01", + "billingPeriodEndDate": "2017-02-01", + "invoiceIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json new file mode 100644 index 000000000000..35e4c74bc9d2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "invoiceSectionId": "invoiceSectionId", + "transferId": "transferId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "invoiceSectionId": "invoiceSectionId", + "billingAccountId": "billingAccountId", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "canceledBy": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json new file mode 100644 index 000000000000..664f9e7aec38 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "transferId": "transferId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "transferStatus": "Declined", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json new file mode 100644 index 000000000000..3d7117536c2d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "kathy@contoso.com" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json new file mode 100644 index 000000000000..56cd2ddd35b9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "kathy@contoso.com" + } + }, + { + "id": "/providers/Microsoft.Billing/enrollmentAccounts/edd24053-07cd-4ed4-aa5b-326160a6680d", + "name": "edd24053-07cd-4ed4-aa5b-326160a6680d", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "principalName": "dan@contoso.com" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json new file mode 100644 index 000000000000..26c89a52c1e1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "transferId": "transferId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json new file mode 100644 index 000000000000..c31bc82a761a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "invoiceSectionId": "invoiceSectionId", + "transferId": "transferId" + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "invoiceSectionId": "invoiceSectionId", + "billingAccountId": "billingAccountId", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "transferStatus": "InProgress" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json new file mode 100644 index 000000000000..f8e0699f82d1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "invoiceSectionId": "invoiceSectionId", + "body": { + "properties": { + "billingProfileId": "billingProfileId", + "recipientEmailId": "user@contoso.com" + + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "invoiceSectionId": "invoiceSectionId", + "billingAccountId": "billingAccountId", + "transferStatus": "Pending", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:40:01 PM" + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json new file mode 100644 index 000000000000..03fdb36b8f91 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "$top": 1, + "$filter": "invoicePeriodStartDate le 2017-02-01", + "$expand": "downloadUrl" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json new file mode 100644 index 000000000000..f8e64db95d4f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid", + "invoiceName": "2017-02-05-123456789" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json new file mode 100644 index 000000000000..c6ab612cee50 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ], + "downloadUrl": { + "expiryTime": "2017-02-13T20:46:30Z", + "url": "https://microsoft.com" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json new file mode 100644 index 000000000000..0d02496eef91 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", + "name": "2017-02-05-123456789", + "type": "Microsoft.Billing/invoices", + "properties": { + "invoicePeriodStartDate": "2017-01-01", + "invoicePeriodEndDate": "2017-02-01", + "billingPeriodIds": [ + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", + "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json new file mode 100644 index 000000000000..b0f3ab3baba4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview" + }, + + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "allowedSubscriptionType": [ + "DevTestAzureSubscription", + "StandardAzureSubscription", + "AzureReservation" + ], + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "transferStatus": "InProgress" + }, + { + "productType": "ReservedInstance", + "productId": "reservedInstanceId", + "transferStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json new file mode 100644 index 000000000000..7fa4f88a1dc1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "billingAccountId", + "invoiceSectionId": "invoiceSectionId" + }, + + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", + "type": "Microsoft.Billing/transfers", + "name": "transferId", + "properties": { + "creationTime": "10/10/2018 9:40:01 PM", + "expirationTime": "11/5/2018 4:47:08 AM", + "invoiceSectionId": "invoiceSectionId", + "billingAccountId": "billingAccountId", + "transferStatus": "InProgress", + "recipientEmailId": "user@contoso.com", + "initiatorEmailId": "user@contoso.com", + "lastModifiedTime": "10/10/2018 9:45:01 PM", + "detailedTransferStatus": [ + { + "productType": "AzureSubscription", + "productId": "subscriptionId", + "transferStatus": "InProgress" + }, + { + "productType": "AzureReservation", + "productId": "reservedInstanceId", + "transferStatus": "InProgress" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file From 6501ef5baea5337952d72e083f52f300e5177c18 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 21 Nov 2018 15:43:29 -0500 Subject: [PATCH 167/464] typo: web/resource-manager/Microsoft.Web/AppServiceEnvironments (#4527) - enviroment -> environment --- .../Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json | 2 +- .../Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json index 6311b8eb9e0a..3c9a7ad63d24 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServiceEnvironments.json @@ -1885,7 +1885,7 @@ } }, "AppServiceEnvironmentPatchResource": { - "description": "ARM resource for a app service enviroment.", + "description": "ARM resource for a app service environment.", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json index eaf143205bc7..8748d4d25ae9 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServiceEnvironments.json @@ -2132,7 +2132,7 @@ } }, "AppServiceEnvironmentPatchResource": { - "description": "ARM resource for a app service enviroment.", + "description": "ARM resource for a app service environment.", "type": "object", "allOf": [ { From 826a6cb90ce1972d5a142b4a5cf79e101e57b27c Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 21 Nov 2018 15:45:21 -0500 Subject: [PATCH 168/464] typo: Fix customer-insights/resource-manager/Microsoft.CustomerInsights/customer-insights (#4517) - interation -> interaction - retreive -> retrieve - exisiting -> existing - refered -> referred - assiciated -> associated - monified -> modified - mangement -> management - ingored -> ignored - c onnector -> connector - singnas -> singnals --- .../stable/2017-01-01/customer-insights.json | 30 ++++++++--------- .../stable/2017-04-26/customer-insights.json | 32 +++++++++---------- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json b/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json index 5329c7ccd0eb..22675f81ce9d 100644 --- a/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json +++ b/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-01-01/customer-insights.json @@ -690,13 +690,13 @@ ], "responses": { "200": { - "description": "OK. Successfully created the interation.", + "description": "OK. Successfully created the interaction.", "schema": { "$ref": "#/definitions/InteractionResourceFormat" } }, "202": { - "description": "Accepted. The create interation operation is accepted." + "description": "Accepted. The create interaction operation is accepted." } }, "x-ms-long-running-operation": true @@ -2413,7 +2413,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level views." + "description": "The user ID. Use * to retrieve hub level views." } ], "responses": { @@ -2440,7 +2440,7 @@ "$ref": "./examples/ViewsCreateOrUpdate.json" } }, - "description": "Creates a view or updates an exisiting view in the hub.", + "description": "Creates a view or updates an existing view in the hub.", "parameters": [ { "name": "resourceGroupName", @@ -2534,7 +2534,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level view." + "description": "The user ID. Use * to retrieve hub level view." } ], "responses": { @@ -2590,7 +2590,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level view." + "description": "The user ID. Use * to retrieve hub level view." } ], "responses": { @@ -3316,7 +3316,7 @@ "properties": { "apiEntitySetName": { "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." + "description": "The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object." }, "entityType": { "type": "string", @@ -3446,7 +3446,7 @@ }, "isRequired": { "type": "boolean", - "description": "Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field." + "description": "Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field." }, "propertyId": { "type": "string", @@ -3495,11 +3495,11 @@ }, "primaryKey": { "type": "string", - "description": "Primary key assiciated with the policy." + "description": "Primary key associated with the policy." }, "secondaryKey": { "type": "string", - "description": "Secondary key assiciated with the policy." + "description": "Secondary key associated with the policy." } }, "description": "The authorization policy." @@ -3675,7 +3675,7 @@ "type": "string", "readOnly": true, "format": "date-time", - "description": "The last monified time." + "description": "The last modified time." }, "state": { "type": "string", @@ -3729,7 +3729,7 @@ "description": "The error limit allowed while importing data." } }, - "description": "The error mangement." + "description": "The error management." }, "ConnectorMappingFormat": { "required": [ @@ -3917,7 +3917,7 @@ "type": "string", "readOnly": true, "format": "date-time", - "description": "The last monified time." + "description": "The last modified time." }, "entityType": { "type": "string", @@ -4446,7 +4446,7 @@ }, "referenceOnly": { "type": "boolean", - "description": "Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." + "description": "Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." }, "operationType": { "type": "string", @@ -5060,7 +5060,7 @@ "description": "The response of list connector operation." }, "ConnectorMappingResourceFormat": { - "description": "The c onnector mapping resource format.", + "description": "The connector mapping resource format.", "properties": { "properties": { "x-ms-client-flatten": true, diff --git a/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json b/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json index 2f83f86f71e1..3c0353f8a491 100644 --- a/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json +++ b/specification/customer-insights/resource-manager/Microsoft.CustomerInsights/stable/2017-04-26/customer-insights.json @@ -688,13 +688,13 @@ ], "responses": { "200": { - "description": "OK. Successfully created the interation.", + "description": "OK. Successfully created the interaction.", "schema": { "$ref": "#/definitions/InteractionResourceFormat" } }, "202": { - "description": "Accepted. The create interation operation is accepted." + "description": "Accepted. The create interaction operation is accepted." } }, "x-ms-long-running-operation": true @@ -2411,7 +2411,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level views." + "description": "The user ID. Use * to retrieve hub level views." } ], "responses": { @@ -2438,7 +2438,7 @@ "$ref": "./examples/ViewsCreateOrUpdate.json" } }, - "description": "Creates a view or updates an exisiting view in the hub.", + "description": "Creates a view or updates an existing view in the hub.", "parameters": [ { "name": "resourceGroupName", @@ -2532,7 +2532,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level view." + "description": "The user ID. Use * to retrieve hub level view." } ], "responses": { @@ -2588,7 +2588,7 @@ "in": "query", "required": true, "type": "string", - "description": "The user ID. Use * to retreive hub level view." + "description": "The user ID. Use * to retrieve hub level view." } ], "responses": { @@ -3685,7 +3685,7 @@ "properties": { "apiEntitySetName": { "type": "string", - "description": "The api entity set name. This becomes the odata entity set name for the entity Type being refered in this object." + "description": "The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object." }, "entityType": { "type": "string", @@ -3815,7 +3815,7 @@ }, "isRequired": { "type": "boolean", - "description": "Whether property value is required on instances, IsRequired field only for Intercation. Profile Instance will not check for required field." + "description": "Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field." }, "propertyId": { "type": "string", @@ -3864,11 +3864,11 @@ }, "primaryKey": { "type": "string", - "description": "Primary key assiciated with the policy." + "description": "Primary key associated with the policy." }, "secondaryKey": { "type": "string", - "description": "Secondary key assiciated with the policy." + "description": "Secondary key associated with the policy." } }, "description": "The authorization policy." @@ -4044,7 +4044,7 @@ "type": "string", "readOnly": true, "format": "date-time", - "description": "The last monified time." + "description": "The last modified time." }, "state": { "type": "string", @@ -4098,7 +4098,7 @@ "description": "The error limit allowed while importing data." } }, - "description": "The error mangement." + "description": "The error management." }, "ConnectorMappingFormat": { "required": [ @@ -4286,7 +4286,7 @@ "type": "string", "readOnly": true, "format": "date-time", - "description": "The last monified time." + "description": "The last modified time." }, "entityType": { "type": "string", @@ -4845,7 +4845,7 @@ }, "referenceOnly": { "type": "boolean", - "description": "Indicating whether the link is reference only link. This flag is ingored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." + "description": "Indicating whether the link is reference only link. This flag is ignored if the Mappings are defined. If the mappings are not defined and it is set to true, links processing will not create or update profiles." }, "operationType": { "type": "string", @@ -5472,7 +5472,7 @@ "description": "The response of list connector operation." }, "ConnectorMappingResourceFormat": { - "description": "The c onnector mapping resource format.", + "description": "The connector mapping resource format.", "properties": { "properties": { "x-ms-client-flatten": true, @@ -6412,7 +6412,7 @@ "signalsUsed": { "type": "integer", "readOnly": true, - "description": "The singnas used." + "description": "The signals used." }, "modelVersion": { "type": "string", From 8e0b3c41b7281f5b67b66b08b1ee4e9e8ccbd61e Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Wed, 21 Nov 2018 12:52:12 -0800 Subject: [PATCH 169/464] Change default generation to TextAnalytics 2.1 (#4533) --- .../cognitiveservices/data-plane/TextAnalytics/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 13bb690d2276..3a4d6c8d4cac 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -118,7 +118,7 @@ The current release is `release_2_0`. A preview release `release_2_1` is also available. ``` yaml -tag: release_2_0 +tag: release_2_1 add-credentials: true ``` From 5a020ecd8472dc4eceb717c078642b52f9325407 Mon Sep 17 00:00:00 2001 From: Leonard Francis Date: Wed, 21 Nov 2018 21:22:04 +0000 Subject: [PATCH 170/464] NFSAAS-1505 minor update and validation fixes (#4520) --- .../examples/MountTargets_Delete.json | 15 ------- .../preview/2017-08-15/netapp.json | 45 ++++++++----------- 2 files changed, 18 insertions(+), 42 deletions(-) delete mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Delete.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Delete.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Delete.json deleted file mode 100644 index 5ba8004905e4..000000000000 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Delete.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "subscriptionId": "subscriptionId", - "resourceGroup": "resourceGroup", - "accountName": "accountName", - "poolName": "poolName", - "volumeName": "volumeName", - "mountTargetName": "mountTargetName", - "api-version": "2017-08-15" - }, - "responses": { - "204": {}, - "202": {} - } -} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json index 103a2b754cf7..e7392ca8f979 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json @@ -49,6 +49,9 @@ "$ref": "#/parameters/ApiVersionParameter" } ], + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", @@ -83,6 +86,9 @@ "NetApp Accounts" ], "operationId": "Accounts_List", + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", @@ -272,6 +278,9 @@ "Capacity Pools" ], "operationId": "Pools_List", + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", @@ -467,6 +476,9 @@ "Volumes" ], "operationId": "Volumes_List", + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", @@ -668,6 +680,9 @@ ], "operationId": "MountTargets_List", "description": "List mount targets", + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", @@ -738,33 +753,6 @@ "$ref": "examples/MountTargets_Get.json" } } - }, - "delete": { - "tags": [ - "MountTargets" - ], - "operationId": "MountTargets_Delete", - "description": "Delete mount target", - "responses": { - "202": { - "description": "Accepted -- Create or update request accepted; operation will complete asynchronously" - }, - "204": { - "description": "NoContent -- Resource does not exist." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "MountTargets_Delete": { - "$ref": "examples/MountTargets_Delete.json" - } - } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}/snapshots": { @@ -794,6 +782,9 @@ ], "operationId": "Snapshots_List", "description": "List snapshots", + "x-ms-pageable": { + "nextLinkName": null + }, "responses": { "200": { "description": "OK", From 31e8c909c0751e57f63940d4c60bf87b529bbf74 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 21 Nov 2018 18:59:57 -0500 Subject: [PATCH 171/464] typo: policyinsights/resource-manager/Microsoft.PolicyInsights/policyEvents (#4535) - seperated -> separated --- .../preview/2017-08-09-preview/policyEvents.json | 2 +- .../preview/2017-08-09-preview/policyStates.json | 2 +- .../preview/2017-10-17-preview/policyEvents.json | 2 +- .../preview/2017-10-17-preview/policyStates.json | 2 +- .../preview/2017-12-12-preview/policyEvents.json | 2 +- .../preview/2017-12-12-preview/policyStates.json | 2 +- .../stable/2018-04-04/policyEvents.json | 2 +- .../stable/2018-04-04/policyStates.json | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyEvents.json index 47397a564335..2b1dcc6b3740 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyEvents.json @@ -387,7 +387,7 @@ "$ref": "#/definitions/Column" }, "ManagementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "$ref": "#/definitions/Column" }, "PolicyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyStates.json index ca2fcb4d4d97..5703f2a417e1 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-08-09-preview/policyStates.json @@ -415,7 +415,7 @@ "$ref": "#/definitions/Column" }, "ManagementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "$ref": "#/definitions/Column" }, "PolicyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyEvents.json index 445cea0a6181..4fd235df9bbe 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyEvents.json @@ -428,7 +428,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyStates.json index cc16f8d0feda..a9510214bb1a 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-10-17-preview/policyStates.json @@ -456,7 +456,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyEvents.json index 410b9616fc2d..c2a35fee0074 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyEvents.json @@ -675,7 +675,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyStates.json index e1bfb3e4db29..82c78fd4803d 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2017-12-12-preview/policyStates.json @@ -1104,7 +1104,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json index f342135a435c..b694c4943495 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyEvents.json @@ -675,7 +675,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json index 4c5f4344afc1..0dd9bbf3332b 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2018-04-04/policyStates.json @@ -1104,7 +1104,7 @@ "type": "string" }, "managementGroupIds": { - "description": "Comma seperated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", + "description": "Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under.", "type": "string" }, "policyDefinitionReferenceId": { From a2e9ef85c6debd001897ed1652b8c8fcd4f55ff1 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 23 Nov 2018 07:37:43 -0500 Subject: [PATCH 172/464] typo: azsadmin/resource-manager/storage/Microsoft.Storage.Admin/acquisitions (#4544) - acquistions -> acquisitions - Double word "the" --- .../preview/2016-05-01/acquisitions.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json index 450e958a171b..8aaa8b45b58b 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json @@ -19,7 +19,7 @@ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/acquisitions": { "get": { "x-ms-examples": { - "Returns a list of page BLOB acquistions.": { + "Returns a list of page BLOB acquisitions.": { "$ref": "./examples/Acquisitions/List.json" } }, @@ -27,7 +27,7 @@ "Acquisitions" ], "operationId": "Acquisitions_List", - "description": "Returns a list of BLOB acquistions.", + "description": "Returns a list of BLOB acquisitions.", "parameters": [ { "$ref": "storage.json#/parameters/SubscriptionIdParameter" @@ -107,7 +107,7 @@ "readOnly": true }, "container": { - "description": "The container associated with the the page BLOB.", + "description": "The container associated with the page BLOB.", "type": "string", "readOnly": true }, From ef39ef9f4a6663e4348d41e0d53ac5d05cef786b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 24 Nov 2018 13:34:17 -0500 Subject: [PATCH 173/464] typo: batchai/resource-manager/Microsoft.BatchAI/BatchAI (#4546) - abouth -> about - everytime -> every time - choosen -> chosen - succesfully -> successfully - downloand -> download - parmeter -> parameter - respnose -> response - instumentation -> instrumentation - concatinate -> concatenate - unmouted -> unmounted - mouted -> mounted --- .../preview/2017-09-01-preview/BatchAI.json | 16 ++++++------- .../stable/2018-03-01/BatchAI.json | 24 +++++++++---------- .../stable/2018-05-01/BatchAI.json | 12 +++++----- 3 files changed, 26 insertions(+), 26 deletions(-) diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json index e83b90775a23..e8c17995178c 100644 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/preview/2017-09-01-preview/BatchAI.json @@ -236,7 +236,7 @@ ], "responses": { "200": { - "description": "The operation was successful. The response contains information abouth the cluster.", + "description": "The operation was successful. The response contains information about the cluster.", "schema": { "$ref": "#/definitions/Cluster" } @@ -1518,7 +1518,7 @@ "NodeSetup": { "properties": { "setupTask": { - "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs everytime a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", + "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", "$ref": "#/definitions/SetupTask" }, "mountVolumes": { @@ -1608,7 +1608,7 @@ "vmPriority": { "type": "string", "title": "dedicated or lowpriority.", - "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted.", + "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.", "default": "dedicated", "enum": [ "dedicated", @@ -1997,7 +1997,7 @@ "executionState": { "type": "string", "title": "The current state of the job.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", + "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", "enum": [ "queued", "running", @@ -2148,7 +2148,7 @@ }, "downloadUrl": { "type": "string", - "title": "file downloand url, example: https://mystg.blob.core.windows.net/mycontainer/myModel_1.dnn", + "title": "file download url, example: https://mystg.blob.core.windows.net/mycontainer/myModel_1.dnn", "description": "This will be returned only if the model has been archived. During job run, this won't be returned and customers can use SSH tunneling to download. Users can use Get Remote Login Information API to get the IP address and port information of all the compute nodes running the job." }, "properties": { @@ -2740,7 +2740,7 @@ "parameterServerCount": { "type": "integer", "format": "int32", - "title": "The number of parmeter server tasks.", + "title": "The number of parameter server tasks.", "description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training." } }, @@ -2929,7 +2929,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "An OData $select clause. Used to select the properties to be returned in the GET respnose.", + "description": "An OData $select clause. Used to select the properties to be returned in the GET response.", "x-ms-parameter-grouping": { "postfix": "Options" } @@ -2940,7 +2940,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "An OData $filter clause.. Used to filter results that are returned in the GET respnose.", + "description": "An OData $filter clause. Used to filter results that are returned in the GET response.", "x-ms-parameter-grouping": { "postfix": "Options" } diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json index 84836c0b7c61..d345634f139e 100644 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-03-01/BatchAI.json @@ -277,7 +277,7 @@ ], "responses": { "200": { - "description": "The operation was successful. The response contains information abouth the cluster.", + "description": "The operation was successful. The response contains information about the cluster.", "schema": { "$ref": "#/definitions/Cluster" } @@ -1656,7 +1656,7 @@ }, "instrumentationKeySecretReference": { "title": "Specifies a KeyVault Secret containing Azure Application Insights instrumentation key.", - "description": "Specifies KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instumentationKey or instrumentationKeySecretReference must be specified.", + "description": "Specifies KeyVault Store and Secret which contains Azure Application Insights instrumentation key. One of instrumentationKey or instrumentationKeySecretReference must be specified.", "$ref": "#/definitions/KeyVaultSecretReference" } }, @@ -1668,7 +1668,7 @@ "NodeSetup": { "properties": { "setupTask": { - "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs everytime a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", + "title": "Specifies a setup task which can be used to customize the compute nodes of the cluster. The NodeSetup task runs every time a VM is rebooted. For that reason the task code needs to be idempotent. Generally it is used to either download static data that is required for all jobs that run on the cluster VMs or to download/install software.", "$ref": "#/definitions/SetupTask" }, "mountVolumes": { @@ -1717,7 +1717,7 @@ "stdOutErrPathSuffix": { "type": "string", "title": "A path segment appended by Batch AI to stdOutErrPathPrefix to form a path where stdout and stderr of the setup task will be uploaded.", - "description": "Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. You can concatinate stdOutErrPathPrefix and stdOutErrPathSuffix to get the full path to the output directory.", + "description": "Batch AI creates the setup task output directories under an unique path to avoid conflicts between different clusters. You can concatenate stdOutErrPathPrefix and stdOutErrPathSuffix to get the full path to the output directory.", "readOnly": true } }, @@ -1778,7 +1778,7 @@ "vmPriority": { "type": "string", "title": "dedicated or lowpriority.", - "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is choosen. This is best suited if the workload is checkpointing and can be restarted.", + "description": "The default value is dedicated. The node can get preempted while the task is running if lowpriority is chosen. This is best suited if the workload is checkpointing and can be restarted.", "default": "dedicated", "enum": [ "dedicated", @@ -1930,7 +1930,7 @@ }, "mountVolumes": { "title": "Information on mount volumes to be used by the job.", - "description": "These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", "$ref": "#/definitions/MountVolumes" }, "nodeCount": { @@ -2074,7 +2074,7 @@ }, "mountVolumes": { "title": "Information on mount volumes to be used by the job.", - "description": "These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "description": "These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", "$ref": "#/definitions/MountVolumes" }, "jobOutputDirectoryPathSegment": { @@ -2206,7 +2206,7 @@ "executionState": { "type": "string", "title": "The current state of the job.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", + "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", "enum": [ "queued", "running", @@ -2742,7 +2742,7 @@ "relativeMountPath": { "type": "string", "title": "Specifies the relative path on the compute node where the File Server will be mounted.", - "description": "Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mouted under $AZ_BATCHAI_JOB_MOUNT_ROOT." + "description": "Note that all cluster level file servers will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and job level file servers will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." }, "mountOptions": { "type": "string", @@ -3005,7 +3005,7 @@ "parameterServerCount": { "type": "integer", "format": "int32", - "title": "The number of parmeter server tasks.", + "title": "The number of parameter server tasks.", "description": "If specified, the value must be less than or equal to nodeCount. If not specified, the default value is equal to 1 for distributed TensorFlow training (This property is not applicable for single machine training). This property can be specified only for distributed TensorFlow training." } }, @@ -3193,7 +3193,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "An OData $select clause. Used to select the properties to be returned in the GET respnose.", + "description": "An OData $select clause. Used to select the properties to be returned in the GET response.", "x-ms-parameter-grouping": { "postfix": "Options" } @@ -3204,7 +3204,7 @@ "required": false, "type": "string", "x-ms-parameter-location": "method", - "description": "An OData $filter clause.. Used to filter results that are returned in the GET respnose.", + "description": "An OData $filter clause. Used to filter results that are returned in the GET response.", "x-ms-parameter-grouping": { "postfix": "Options" } diff --git a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json index 1d9b509e78b9..413ea519953c 100644 --- a/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json +++ b/specification/batchai/resource-manager/Microsoft.BatchAI/stable/2018-05-01/BatchAI.json @@ -1606,7 +1606,7 @@ "properties": { "sourceVault": { "title": "Key Vault resource identifier.", - "description": "Fully qualified resource indentifier of the Key Vault.", + "description": "Fully qualified resource identifier of the Key Vault.", "$ref": "#/definitions/ResourceId" }, "secretUrl": { @@ -2297,7 +2297,7 @@ }, "mountVolumes": { "title": "Mount volumes.", - "description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmouted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "description": "Information on mount volumes to be used by the job. These volumes will be mounted before the job execution and will be unmounted after the job completion. The volumes will be mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", "$ref": "#/definitions/MountVolumes" }, "nodeCount": { @@ -2452,7 +2452,7 @@ }, "mountVolumes": { "title": "Mount volumes.", - "description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmouted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", + "description": "Collection of mount volumes available to the job during execution. These volumes are mounted before the job execution and unmounted after the job completion. The volumes are mounted at location specified by $AZ_BATCHAI_JOB_MOUNT_ROOT environment variable.", "$ref": "#/definitions/MountVolumes" }, "nodeCount": { @@ -2602,7 +2602,7 @@ "readOnly": true, "type": "string", "title": "Execution state.", - "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running succesfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", + "description": "The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.", "enum": [ "queued", "running", @@ -3041,7 +3041,7 @@ "id": { "type": "string", "title": "ID.", - "description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_ environment variale to find the directory path, where is the value of id attribute." + "description": "The ID of the output directory. The job can use AZ_BATCHAI_OUTPUT_ environment variable to find the directory path, where is the value of id attribute." }, "pathPrefix": { "type": "string", @@ -3196,7 +3196,7 @@ "description": "The relative path on the compute node where the unmanaged file system will be mounted. Note that all cluster level unmanaged file systems will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level unmanaged file systems will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT." } }, - "description": "Unmananged file system mounting configuration.", + "description": "Unmanaged file system mounting configuration.", "required": [ "mountCommand", "relativeMountPath" From 1a729b5cee60f3749f24270df8adc031ab548d23 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 24 Nov 2018 13:35:01 -0500 Subject: [PATCH 174/464] typo: datalake-store/data-plane/Microsoft.DataLakeStore/filesystem (#4537) - seperated -> separated - lexographical -> lexicographical - contet -> content --- .../preview/2015-10-01-preview/filesystem.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json index e0588df749be..6b63469b2d24 100644 --- a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json +++ b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/preview/2015-10-01-preview/filesystem.json @@ -304,7 +304,7 @@ "type": "string" }, "collectionFormat": "csv", - "description": "A list of comma seperated Data Lake Store paths (starting with '/') of the files to concatenate, in the order in which they should be concatenated." + "description": "A list of comma separated Data Lake Store paths (starting with '/') of the files to concatenate, in the order in which they should be concatenated." }, { "name": "op", @@ -426,14 +426,14 @@ "in": "query", "required": false, "type": "string", - "description": "Gets or sets the item or lexographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional." + "description": "Gets or sets the item or lexicographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional." }, { "name": "listBefore", "in": "query", "required": false, "type": "string", - "description": "Gets or sets the item or lexographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional." + "description": "Gets or sets the item or lexicographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional." }, { "name": "op", @@ -1400,7 +1400,7 @@ "type": "integer", "readOnly": true, "format": "int64", - "description": "the number of bytes used by the contet." + "description": "the number of bytes used by the content." }, "spaceConsumed": { "type": "integer", From 1cdd52a6f7e00275ad359346669ce692a7ccef49 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 24 Nov 2018 13:36:00 -0500 Subject: [PATCH 175/464] typo: servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric (#4528) - specificed -> specified - sucessful -> successful - resturns -> returns - commited -> committed - Double word "maximum" - Double word "with" --- .../stable/6.2/servicefabric.json | 12 ++++++------ .../stable/6.3/servicefabric.json | 14 +++++++------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json index 3f5849cc896e..888add445d02 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -1319,7 +1319,7 @@ "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { "get": { "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", + "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.", "operationId": "GetServiceTypeInfoByName", "parameters": [ { @@ -5583,7 +5583,7 @@ ], "responses": { "201": { - "description": "A sucessful operation returns 201 status code and creates a new backup policy." + "description": "A successful operation returns 201 status code and creates a new backup policy." }, "default": { "description": "The detailed error response.", @@ -5795,7 +5795,7 @@ ], "responses": { "200": { - "description": "A sucessful operation resturns 200 status code and updates the backup policy description." + "description": "A successful operation returns 200 status code and updates the backup policy description." }, "default": { "description": "The detailed error response.", @@ -7159,7 +7159,7 @@ } }, "409": { - "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", + "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed.", "schema": { "$ref": "#/definitions/FailedPropertyBatchInfo" } @@ -13193,7 +13193,7 @@ }, "MaxPercentUnhealthyServices": { "type": "integer", - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", + "description": "The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", "default": 0 } } @@ -23507,7 +23507,7 @@ "values": [ { "value": "default", - "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." + "description": "This filter value will match all of the nodes excepts the ones with status as Unknown or Removed." }, { "value": "all", diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json index 1bc3931d0c02..5da051674d5e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json @@ -1338,7 +1338,7 @@ "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { "get": { "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", - "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specificed service type is not found in the cluster.", + "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.", "operationId": "GetServiceTypeInfoByName", "parameters": [ { @@ -5608,7 +5608,7 @@ ], "responses": { "201": { - "description": "A sucessful operation returns 201 status code and creates a new backup policy." + "description": "A successful operation returns 201 status code and creates a new backup policy." }, "default": { "description": "The detailed error response.", @@ -5820,7 +5820,7 @@ ], "responses": { "200": { - "description": "A sucessful operation resturns 200 status code and updates the backup policy description." + "description": "A sucsessful operation returns 200 status code and updates the backup policy description." }, "default": { "description": "The detailed error response.", @@ -7184,7 +7184,7 @@ } }, "409": { - "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were commited.", + "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed.", "schema": { "$ref": "#/definitions/FailedPropertyBatchInfo" } @@ -8064,7 +8064,7 @@ "$ref": "./examples/Resource/GetReplicas.json" } }, - "summary": "Gets replicas of a given service in an applciation resource.", + "summary": "Gets replicas of a given service in an application resource.", "description": "Gets the information about all replicas of a given service of an application. The information includes the runtime properties of the replica instance.", "parameters": [ { @@ -13600,7 +13600,7 @@ }, "MaxPercentUnhealthyServices": { "type": "integer", - "description": "The maximum maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", + "description": "The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", "default": 0 } } @@ -24711,7 +24711,7 @@ "values": [ { "value": "default", - "description": "This filter value will match all of the nodes excepts the ones with with status as Unknown or Removed." + "description": "This filter value will match all of the nodes excepts the ones with status as Unknown or Removed." }, { "value": "all", From 219ec787f3f1ba0931bc3f41fd1e658b9035d87a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 24 Nov 2018 13:37:19 -0500 Subject: [PATCH 176/464] typo: servicefabric/data-plane/Microsoft.ServiceFabric/CreateService-4 (#4514) - Parition -> Partition --- .../stable/6.2/examples/CreateService-4.json | 2 +- .../stable/6.3/examples/CreateService-4.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json index d72ec8f3b457..246bb902dbca 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/CreateService-4.json @@ -11,7 +11,7 @@ "ServiceTypeName": "StatefulBackendService", "InitializationData": [], "PartitionDescription": { - "PartitionScheme": "NamedParitionSchemeDescription", + "PartitionScheme": "NamedPartitionSchemeDescription", "Count" : 1, "Names" : ["0"] }, diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json index d72ec8f3b457..246bb902dbca 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/CreateService-4.json @@ -11,7 +11,7 @@ "ServiceTypeName": "StatefulBackendService", "InitializationData": [], "PartitionDescription": { - "PartitionScheme": "NamedParitionSchemeDescription", + "PartitionScheme": "NamedPartitionSchemeDescription", "Count" : 1, "Names" : ["0"] }, From c12a28d934a345ab8d4e8fa2b3344e6a0d8ae314 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 24 Nov 2018 13:39:13 -0500 Subject: [PATCH 177/464] typo: apimanagement/control-plane/Microsoft.ApiManagement/apimbackends.json (#4511) - parition -> partition --- .../preview/2017-03-01/apimbackends.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimbackends.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimbackends.json index 1e1cd26264b2..ca7ca760ef2d 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimbackends.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimbackends.json @@ -459,7 +459,7 @@ "type": "string" }, "maxPartitionResolutionRetries": { - "description": "Maximum number of retries while attempting resolve the parition.", + "description": "Maximum number of retries while attempting resolve the partition.", "format": "int32", "type": "integer" }, From 3c8a16b6194e9f9738abf69e3297d96ac6df0480 Mon Sep 17 00:00:00 2001 From: bashahee <32364196+bashahee@users.noreply.github.com> Date: Sat, 24 Nov 2018 20:53:14 +0200 Subject: [PATCH 178/464] Update sensitivityLabels.json (#4479) * Add sensitivityLabels.json to readme.md Removing duplication of sensitivityLabels.json files, and updating readme.md * Update sensitivityLabels.json * Update readme.md * Update readme.md --- .../2017-03-01-preview/sensitivityLabels.json | 10 +- .../ColumnSensitivityLabelCreateMax.json | 43 -- .../ColumnSensitivityLabelDelete.json | 17 - .../examples/ColumnSensitivityLabelGet.json | 26 - .../SensitivityLabelsListByDatabase.json | 35 -- ...LabelsListByDatabaseWithSourceCurrent.json | 36 -- ...lsListByDatabaseWithSourceRecommended.json | 36 -- .../2018-06-01-preview/sensitivityLabels.json | 566 ------------------ 8 files changed, 9 insertions(+), 760 deletions(-) delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelCreateMax.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelDelete.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelGet.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabase.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/sensitivityLabels.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json index 89df847f80f4..6ab44b268dbc 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json @@ -327,7 +327,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - Label ID must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - Information type ID must be a GUID\n\n * 400 LabelMissing - Label is missing\n\n * 400 InformationTypeMissing - Information Type is missing\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" }, "201": { "description": "Successfully created the sensitivity label.", @@ -425,9 +425,17 @@ "description": "The label name.", "type": "string" }, + "labelId": { + "description": "The label ID.", + "type": "string" + }, "informationType": { "description": "The information type.", "type": "string" + }, + "informationTypeId": { + "description": "The information type ID.", + "type": "string" } } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelCreateMax.json deleted file mode 100644 index fe6131a05b41..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelCreateMax.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "schemaName": "dbo", - "tableName": "myTable", - "columnName": "myColumn", - "sensitivityLabelSource": "current", - "api-version": "2017-03-01-preview", - "parameters": { - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelDelete.json deleted file mode 100644 index d696fb91ed5e..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelDelete.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "schemaName": "dbo", - "tableName": "myTable", - "columnName": "myColumn", - "sensitivityLabelSource": "current", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelGet.json deleted file mode 100644 index e3e5f81b1493..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ColumnSensitivityLabelGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "schemaName": "dbo", - "tableName": "myTable", - "columnName": "myColumn", - "sensitivityLabelSource": "current", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "PhoneNumber" - } - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabase.json deleted file mode 100644 index 33441c2f00c6..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabase.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json deleted file mode 100644 index 736a11cbc2b5..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "sensitivityLabelSource": "current", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn3/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn4/sensitivityLabels/current", - "name": "current", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json deleted file mode 100644 index 4f8dca7041d1..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "myRG", - "serverName": "myServer", - "databaseName": "myDatabase", - "sensitivityLabelSource": "recommended", - "api-version": "2017-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "Sensitive", - "informationType": "Financial" - } - }, - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/myRG/providers/Microsoft.Sql/servers/myServer/databases/myDatabase/schemas/dbo/tables/myTable/columns/myColumn2/sensitivityLabels/recommended", - "name": "recommended", - "type": "Microsoft.Sql/servers/databases/schemas/tables/columns/sensitivityLabels", - "properties": { - "labelName": "PII", - "informationType": "Email" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/sensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/sensitivityLabels.json deleted file mode 100644 index 70c05bb92c68..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/sensitivityLabels.json +++ /dev/null @@ -1,566 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-06-01-preview", - "title": "SqlManagementClient", - "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/currentSensitivityLabels": { - "get": { - "tags": [ - "SensitivityLabels" - ], - "description": "Gets the sensitivity labels of a given database", - "operationId": "SensitivityLabels_ListCurrentByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "An OData filter expression that filters elements in the collection.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the sensitivity labels.", - "schema": { - "$ref": "#/definitions/SensitivityLabelListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." - } - }, - "x-ms-odata": "#/definitions/SensitivityLabel", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the current sensitivity labels of a given database": { - "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceCurrent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/recommendedSensitivityLabels": { - "get": { - "tags": [ - "SensitivityLabels" - ], - "description": "Gets the sensitivity labels of a given database", - "operationId": "SensitivityLabels_ListRecommendedByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "An OData filter expression that filters elements in the collection.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the sensitivity labels.", - "schema": { - "$ref": "#/definitions/SensitivityLabelListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." - } - }, - "x-ms-odata": "#/definitions/SensitivityLabel", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the recommended sensitivity labels of a given database": { - "$ref": "./examples/SensitivityLabelsListByDatabaseWithSourceRecommended.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/sensitivityLabels": { - "get": { - "tags": [ - "SensitivityLabels" - ], - "description": "Gets the sensitivity labels of a given database", - "operationId": "SensitivityLabels_ListByDatabase", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "$filter", - "in": "query", - "description": "An OData filter expression that filters elements in the collection.", - "required": false, - "type": "string" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the sensitivity labels.", - "schema": { - "$ref": "#/definitions/SensitivityLabelListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." - } - }, - "x-ms-odata": "#/definitions/SensitivityLabel", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets the current and recommended sensitivity labels of a given database": { - "$ref": "./examples/SensitivityLabelsListByDatabase.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/sensitivityLabels/{sensitivityLabelSource}": { - "get": { - "tags": [ - "SensitivityLabels" - ], - "description": "Gets the sensitivity label of a given column", - "operationId": "SensitivityLabels_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "schemaName", - "in": "path", - "description": "The name of the schema.", - "required": true, - "type": "string" - }, - { - "name": "tableName", - "in": "path", - "description": "The name of the table.", - "required": true, - "type": "string" - }, - { - "name": "columnName", - "in": "path", - "description": "The name of the column.", - "required": true, - "type": "string" - }, - { - "name": "sensitivityLabelSource", - "in": "path", - "description": "The source of the sensitivity label.", - "required": true, - "type": "string", - "enum": [ - "current", - "recommended" - ], - "x-ms-enum": { - "name": "SensitivityLabelSource", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the sensitivity label.", - "schema": { - "$ref": "#/definitions/SensitivityLabel" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" - } - }, - "x-ms-examples": { - "Gets the sensitivity label of a given column": { - "$ref": "./examples/ColumnSensitivityLabelGet.json" - } - } - }, - "put": { - "tags": [ - "SensitivityLabels" - ], - "description": "Creates or updates the sensitivity label of a given column", - "operationId": "SensitivityLabels_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "schemaName", - "in": "path", - "description": "The name of the schema.", - "required": true, - "type": "string" - }, - { - "name": "tableName", - "in": "path", - "description": "The name of the table.", - "required": true, - "type": "string" - }, - { - "name": "columnName", - "in": "path", - "description": "The name of the column.", - "required": true, - "type": "string" - }, - { - "name": "sensitivityLabelSource", - "in": "path", - "description": "The source of the sensitivity label.", - "required": true, - "type": "string", - "enum": [ - "current" - ], - "x-ms-enum": { - "name": "WritableSensitivityLabelSource", - "modelAsString": false - } - }, - { - "name": "parameters", - "in": "body", - "description": "The column sensitivity label resource.", - "required": true, - "schema": { - "$ref": "#/definitions/SensitivityLabel" - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the sensitivity label.", - "schema": { - "$ref": "#/definitions/SensitivityLabel" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" - }, - "201": { - "description": "Successfully created the sensitivity label.", - "schema": { - "$ref": "#/definitions/SensitivityLabel" - } - } - }, - "x-ms-examples": { - "Updates the sensitivity label of a given column with all parameters": { - "$ref": "./examples/ColumnSensitivityLabelCreateMax.json" - } - } - }, - "delete": { - "tags": [ - "SensitivityLabels" - ], - "description": "Deletes the sensitivity label of a given column", - "operationId": "SensitivityLabels_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "schemaName", - "in": "path", - "description": "The name of the schema.", - "required": true, - "type": "string" - }, - { - "name": "tableName", - "in": "path", - "description": "The name of the table.", - "required": true, - "type": "string" - }, - { - "name": "columnName", - "in": "path", - "description": "The name of the column.", - "required": true, - "type": "string" - }, - { - "name": "sensitivityLabelSource", - "in": "path", - "description": "The source of the sensitivity label.", - "required": true, - "type": "string", - "enum": [ - "current" - ], - "x-ms-enum": { - "name": "WritableSensitivityLabelSource", - "modelAsString": false - } - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the sensitivity label." - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" - } - }, - "x-ms-examples": { - "Deletes the sensitivity label of a given column": { - "$ref": "./examples/ColumnSensitivityLabelDelete.json" - } - } - } - } - }, - "definitions": { - "SensitivityLabelProperties": { - "description": "Properties of a sensitivity label.", - "type": "object", - "properties": { - "labelName": { - "description": "The label name.", - "type": "string" - }, - "informationType": { - "description": "The information type.", - "type": "string" - } - } - }, - "SensitivityLabel": { - "description": "A sensitivity label.", - "type": "object", - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SensitivityLabelProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, - "SensitivityLabelListResult": { - "description": "A list of sensitivity labels.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SensitivityLabel" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "The subscription ID that identifies an Azure subscription.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "The API version to use for the request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "description": "The name of the server.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "ManagedInstanceNameParameter": { - "name": "managedInstanceName", - "in": "path", - "description": "The name of the managed instance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "description": "The name of the database.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "BlobAuditingPolicyNameParameter": { - "name": "blobAuditingPolicyName", - "in": "path", - "description": "The name of the blob auditing policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineInstanceNameParameter": { - "name": "sqlVirtualMachineInstanceName", - "in": "path", - "description": "The name of the SqlVirtualMachineInstance.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "SqlVirtualMachineContainerNameParameter": { - "name": "sqlVirtualMachineContainerName", - "in": "path", - "description": "The name of the SqlVirtualMachineContainer.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "VirtualClusterNameParameter": { - "name": "virtualClusterName", - "in": "path", - "description": "The name of the virtual cluster.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "description": "Azure Active Directory OAuth2 Flow", - "flow": "implicit", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - } -} \ No newline at end of file From bfa709160e0b75dbe4e76e2374ff36cee2b7d63a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 09:07:57 -0500 Subject: [PATCH 179/464] typo: applicationinsights/resource-manager/Microsoft.Insights/componentFeaturesAndPricing_API (#4552) - capabilites -> capabilities - volumne -> volume - applciation -> application - Insigths -> Insights - Double word "meter" - Desplay -> Display - vaule -> value --- .../componentFeaturesAndPricing_API.json | 18 +++++++++--------- .../componentFeaturesAndPricing_API.json | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json index 38513f197704..0469ae7301d3 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json @@ -142,7 +142,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/featurecapabilities": { "get": { - "description": "Returns feature capabilites of the application insights component.", + "description": "Returns feature capabilities of the application insights component.", "operationId": "ComponentFeatureCapabilities_Get", "parameters": [ { @@ -213,7 +213,7 @@ "description": "An Application Insights component billing features", "properties": { "DataVolumeCap": { - "description": "An Application Insights component daily data volumne cap", + "description": "An Application Insights component daily data volume cap", "$ref": "#/definitions/ApplicationInsightsComponentDataVolumeCap" }, "CurrentBillingFeatures": { @@ -227,7 +227,7 @@ }, "ApplicationInsightsComponentDataVolumeCap": { "type": "object", - "description": "An Application Insights component daily data volumne cap", + "description": "An Application Insights component daily data volume cap", "properties": { "Cap": { "type": "number", @@ -345,7 +345,7 @@ "TrackingType": { "type": "string", "readOnly": true, - "description": "The applciation insights component used tracking type." + "description": "The application insights component used tracking type." }, "DailyCap": { "type": "number", @@ -375,7 +375,7 @@ "$ref": "#/definitions/ApplicationInsightsComponentFeature" }, "readOnly": true, - "description": "A list of Application Insigths component feature." + "description": "A list of Application Insights component feature." } } }, @@ -396,7 +396,7 @@ "MeterRateFrequency":{ "type": "string", "readOnly": true, - "description": "The meter meter rate for the feature's meter." + "description": "The meter rate for the feature's meter." }, "ResouceId":{ "type": "string", @@ -415,12 +415,12 @@ "$ref": "#/definitions/ApplicationInsightsComponentFeatureCapability" }, "readOnly": true, - "description": "A list of Application Insigths component feature capability." + "description": "A list of Application Insights component feature capability." }, "Title": { "type": "string", "readOnly": true, - "description": "Desplay name of the feature." + "description": "Display name of the feature." }, "IsMainFeature": { "type": "boolean", @@ -451,7 +451,7 @@ "Value":{ "type": "string", "readOnly": true, - "description": "The vaule of the capability." + "description": "The value of the capability." }, "Unit":{ "type": "string", diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json b/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json index 12bbd1d7bf87..4ebbf3e83284 100644 --- a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json +++ b/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json @@ -188,7 +188,7 @@ }, "PricingPlanProperties": { "type": "object", - "description": "An Application Insights component daily data volumne cap", + "description": "An Application Insights component daily data volume cap", "properties": { "planType": { "type": "string", From 3f432a5b0af58d49759a20e2b2ef3ebb7ae691b5 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 11:20:35 -0500 Subject: [PATCH 180/464] typo: storage/resource-manager/Microsoft.Storage/blob (#4551) - extented -> extended --- .../Microsoft.Storage/preview/2018-03-01-preview/blob.json | 2 +- .../Microsoft.Storage/stable/2018-02-01/blob.json | 2 +- .../Microsoft.Storage/stable/2018-07-01/blob.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json index d8530e57e160..a60b0a7b8de0 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/blob.json @@ -572,7 +572,7 @@ "schema": { "$ref": "#/definitions/ImmutabilityPolicy" }, - "description": "The ImmutabilityPolicy Properties that will be extented for a blob container." + "description": "The ImmutabilityPolicy Properties that will be extended for a blob container." }, { "name": "If-Match", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json index d86326d7c69e..3fb66dadbdc7 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/blob.json @@ -572,7 +572,7 @@ "schema": { "$ref": "#/definitions/ImmutabilityPolicy" }, - "description": "The ImmutabilityPolicy Properties that will be extented for a blob container." + "description": "The ImmutabilityPolicy Properties that will be extended for a blob container." }, { "name": "If-Match", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json index 1881958020ee..ad6bdfecb437 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/blob.json @@ -657,7 +657,7 @@ "schema": { "$ref": "#/definitions/ImmutabilityPolicy" }, - "description": "The ImmutabilityPolicy Properties that will be extented for a blob container." + "description": "The ImmutabilityPolicy Properties that will be extended for a blob container." }, { "name": "If-Match", From 7feeea18147a67589fb765a45d46b821465ef4bd Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 12:17:54 -0500 Subject: [PATCH 181/464] typo: compute/quickstart-templates/swagger (#4557) - deploymentoutput -> deployment output - paramaters -> parameters --- arm-compute/quickstart-templates/swagger.json | 4 ++-- specification/compute/quickstart-templates/swagger.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/arm-compute/quickstart-templates/swagger.json b/arm-compute/quickstart-templates/swagger.json index d31427c555b3..a44fcedcd9f7 100644 --- a/arm-compute/quickstart-templates/swagger.json +++ b/arm-compute/quickstart-templates/swagger.json @@ -242,7 +242,7 @@ }, "outputs": { "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." + "description": "Gets or sets key/value pairs that represent deployment output." }, "providers": { "type": "array", @@ -344,7 +344,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "Provider": { "properties": { diff --git a/specification/compute/quickstart-templates/swagger.json b/specification/compute/quickstart-templates/swagger.json index d31427c555b3..a44fcedcd9f7 100644 --- a/specification/compute/quickstart-templates/swagger.json +++ b/specification/compute/quickstart-templates/swagger.json @@ -242,7 +242,7 @@ }, "outputs": { "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." + "description": "Gets or sets key/value pairs that represent deployment output." }, "providers": { "type": "array", @@ -344,7 +344,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "Provider": { "properties": { From b8978454dc79b7786111d4e58ab04f173fb913c1 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 12:18:27 -0500 Subject: [PATCH 182/464] typo: storage/resource-manager/Microsoft.Storage/storage (#4549) - possiblly -> possibly - availabity -> availability - vaules -> values - speicific -> specific - acount -> account - fecthing -> fetching - sku -> SKU - acls -> ACLs --- .../preview/2018-03-01-preview/storage.json | 10 +++---- .../stable/2016-01-01/storage.json | 2 +- .../stable/2016-05-01/storage.json | 8 +++--- .../stable/2016-12-01/storage.json | 8 +++--- .../stable/2017-06-01/storage.json | 12 ++++----- .../stable/2017-10-01/storage.json | 12 ++++----- .../stable/2018-02-01/storage.json | 10 +++---- .../stable/2018-07-01/storage.json | 26 +++++++++---------- 8 files changed, 44 insertions(+), 44 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json index ae5074c69117..3ce80811b1c1 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json @@ -826,7 +826,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name": { "type": "string", @@ -860,7 +860,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "SKUCapability": { "properties": { @@ -1615,7 +1615,7 @@ "properties": { "keyName": { "type": "string", - "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2." } }, "required": [ @@ -1995,14 +1995,14 @@ "required": [ "canonicalizedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json index 500465a299b3..ac6c9b6c3f51 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json @@ -403,7 +403,7 @@ ], "responses": { "200": { - "description": "OK -- current usage acount and limit retrieved and returned successfully.", + "description": "OK -- current usage account and limit retrieved and returned successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json index 388cf406fa9c..28e55b03abcc 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json @@ -374,7 +374,7 @@ ], "responses": { "200": { - "description": "OK -- current usage acount and limit retrieved and returned successfully.", + "description": "OK -- current usage account and limit retrieved and returned successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } @@ -493,7 +493,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "CheckNameAvailabilityResult": { "properties": { @@ -1258,14 +1258,14 @@ "canonicalizedResource", "signedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json index 4783bae5e841..5136a94d8d19 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json @@ -377,7 +377,7 @@ ], "responses": { "200": { - "description": "OK -- current usage acount and limit retrieved and returned successfully.", + "description": "OK -- current usage account and limit retrieved and returned successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } @@ -496,7 +496,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "CheckNameAvailabilityResult": { "properties": { @@ -1293,14 +1293,14 @@ "canonicalizedResource", "signedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json index 4aff811869b4..39f5e052379e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json @@ -466,7 +466,7 @@ ], "responses": { "200": { - "description": "OK -- current usage acount and limit retrieved and returned successfully.", + "description": "OK -- current usage account and limit retrieved and returned successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } @@ -697,7 +697,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name" : { "type" : "string", @@ -729,7 +729,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "SKUCapability": { "properties": { @@ -1455,7 +1455,7 @@ "properties": { "keyName": { "type": "string", - "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2." } }, "required": [ @@ -1855,14 +1855,14 @@ "canonicalizedResource", "signedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json index b6bd1c211298..31ea509e580e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json @@ -466,7 +466,7 @@ ], "responses": { "200": { - "description": "OK -- current usage acount and limit retrieved and returned successfully.", + "description": "OK -- current usage account and limit retrieved and returned successfully.", "schema": { "$ref": "#/definitions/UsageListResult" } @@ -697,7 +697,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name" : { "type" : "string", @@ -729,7 +729,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "SKUCapability": { "properties": { @@ -1458,7 +1458,7 @@ "properties": { "keyName": { "type": "string", - "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2." } }, "required": [ @@ -1871,14 +1871,14 @@ "canonicalizedResource", "signedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json index ee943493b118..2b659b3a8b04 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json @@ -758,7 +758,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name": { "type": "string", @@ -792,7 +792,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "SKUCapability": { "properties": { @@ -1547,7 +1547,7 @@ "properties": { "keyName": { "type": "string", - "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2." } }, "required": [ @@ -1927,14 +1927,14 @@ "required": [ "canonicalizedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json index 9f1270cce17a..d88fa4a18d29 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json @@ -226,7 +226,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties within account's properties. By default, data is not included when fecthing properties. Currently we only support geoReplicationStats.", + "description": "May be used to expand the properties within account's properties. By default, data is not included when fetching properties. Currently we only support geoReplicationStats.", "in": "query", "required": false, "type": "string", @@ -731,7 +731,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name": { "type": "string", @@ -765,14 +765,14 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "SKUCapability": { "properties": { "name": { "readOnly": true, "type": "string", - "description": "The name of capability, The capability information in the specified sku, including file encryption, network acls, change notification, etc." + "description": "The name of capability, The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." }, "value": { "readOnly": true, @@ -780,7 +780,7 @@ "description": "A string value to indicate states of given capability. Possibly 'true' or 'false'." } }, - "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + "description": "The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." }, "Restriction": { "properties": { @@ -857,7 +857,7 @@ "properties": { "name": { "type": "string", - "description": "Gets or sets the sku name. Required for account creation; optional for update. Note that in older versions, sku name was called accountType.", + "description": "Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.", "enum": [ "Standard_LRS", "Standard_GRS", @@ -874,7 +874,7 @@ "tier": { "readOnly": true, "type": "string", - "description": "Gets the sku tier. This is based on the SKU name.", + "description": "Gets the SKU tier. This is based on the SKU name.", "enum": [ "Standard", "Premium" @@ -919,7 +919,7 @@ "items": { "$ref": "#/definitions/SKUCapability" }, - "description": "The capability information in the specified sku, including file encryption, network acls, change notification, etc." + "description": "The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc." }, "restrictions": { "type": "array", @@ -1234,7 +1234,7 @@ "properties": { "sku": { "$ref": "#/definitions/Sku", - "description": "Required. Gets or sets the sku name." + "description": "Required. Gets or sets the SKU name." }, "kind": { "type": "string", @@ -1575,7 +1575,7 @@ "properties": { "keyName": { "type": "string", - "description": "The name of storage keys that want to be regenerated, possible vaules are key1, key2." + "description": "The name of storage keys that want to be regenerated, possible values are key1, key2." } }, "required": [ @@ -1627,7 +1627,7 @@ "properties": { "sku": { "$ref": "#/definitions/Sku", - "description": "Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those sku names be updated to any other value." + "description": "Gets or sets the SKU name. Note that the SKU name cannot be updated to Standard_ZRS, Premium_LRS or Premium_ZRS, nor can accounts of those SKU names be updated to any other value." }, "tags": { "type": "object", @@ -1961,14 +1961,14 @@ "required": [ "canonicalizedResource" ], - "description": "The parameters to list service SAS credentials of a speicific resource." + "description": "The parameters to list service SAS credentials of a specific resource." }, "ListServiceSasResponse": { "properties": { "serviceSasToken": { "readOnly": true, "type": "string", - "description": "List service SAS credentials of speicific resource." + "description": "List service SAS credentials of specific resource." } }, "description": "The List service SAS credentials operation response." From f39fa54bdea33d7f9930000faefc4a08b7a02120 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 12:18:51 -0500 Subject: [PATCH 183/464] typo: mediaservices/resource-manager/Microsoft.Media/Encoding (#4542) - Double word "will" - Double word "of" - audi -> audio - extraced -> extracted --- .../preview/2018-03-30-preview/Encoding.json | 4 ++-- .../preview/2018-06-01-preview/Encoding.json | 4 ++-- .../Microsoft.Media/stable/2018-07-01/Encoding.json | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json index 49043394a155..76c810446bcd 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/Encoding.json @@ -812,7 +812,7 @@ "values": [ { "value": "AdaptiveStreaming", - "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will have video and audio in separate MP4 files, which is optimal for adaptive streaming." }, { "value": "AACGoodQualityAudio", @@ -1090,7 +1090,7 @@ } }, "type": "object", - "description": "Describes a list of of inputs to a Job." + "description": "Describes a list of inputs to a Job." }, "JobInputAsset": { "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json index 5114222ff953..9b89b0e92ca5 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/Encoding.json @@ -813,7 +813,7 @@ "values": [ { "value": "AdaptiveStreaming", - "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will have video and audio in separate MP4 files, which is optimal for adaptive streaming." }, { "value": "AACGoodQualityAudio", @@ -1091,7 +1091,7 @@ } }, "type": "object", - "description": "Describes a list of of inputs to a Job." + "description": "Describes a list of inputs to a Job." }, "JobInputAsset": { "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json index 5a61e0b30833..125127424f5b 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json @@ -828,7 +828,7 @@ }, { "value": "AdaptiveStreaming", - "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will have video and audio in separate MP4 files, which is optimal for adaptive streaming." }, { "value": "AACGoodQualityAudio", @@ -921,7 +921,7 @@ ], "modelAsExtensible": true }, - "description": "The type of insights to be extracted. If not set then based on the content the type will selected. If the content is audi only then only audio insights are extraced and if it is video only." + "description": "The type of insights to be extracted. If not set then based on the content the type will selected. If the content is audio only then only audio insights are extracted and if it is video only." } }, "type": "object", @@ -1129,7 +1129,7 @@ } }, "type": "object", - "description": "Describes a list of of inputs to a Job." + "description": "Describes a list of inputs to a Job." }, "JobInputAsset": { "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", From 0220e884a8b9fafcacac5e0e0b0ae29009e6cb77 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 13:12:57 -0500 Subject: [PATCH 184/464] typo: datafactory/resource-manager/Microsoft.DataFactory/entityTypes/LinkedService (#4536) - retrive -> retrieve - seperate -> separate - Serivce- > Service --- .../entityTypes/LinkedService.json | 44 +++++++++---------- .../2018-06-01/entityTypes/LinkedService.json | 44 +++++++++---------- 2 files changed, 44 insertions(+), 44 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json index 6091ed7fddc6..6d251d9049a6 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/LinkedService.json @@ -1989,7 +1989,7 @@ "type": "object" }, "marketplaceID": { - "description": "The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", "type": "object" }, "sellerID": { @@ -2067,7 +2067,7 @@ }, "ConcurLinkedService": { "x-ms-discriminator-value": "Concur", - "description": "Concur Serivce linked service.", + "description": "Concur Service linked service.", "type": "object", "allOf": [ { @@ -2076,7 +2076,7 @@ ], "properties": { "typeProperties": { - "description": "Concur Serivce linked service properties.", + "description": "Concur Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" } @@ -2086,7 +2086,7 @@ ] }, "ConcurLinkedServiceTypeProperties": { - "description": "Concur Serivce linked service properties.", + "description": "Concur Service linked service properties.", "properties": { "clientId": { "description": "Application client_id supplied by Concur App Management.", @@ -2571,7 +2571,7 @@ }, "HubspotLinkedService": { "x-ms-discriminator-value": "Hubspot", - "description": "Hubspot Serivce linked service.", + "description": "Hubspot Service linked service.", "type": "object", "allOf": [ { @@ -2580,7 +2580,7 @@ ], "properties": { "typeProperties": { - "description": "Hubspot Serivce linked service properties.", + "description": "Hubspot Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" } @@ -2590,7 +2590,7 @@ ] }, "HubspotLinkedServiceTypeProperties": { - "description": "Hubspot Serivce linked service properties.", + "description": "Hubspot Service linked service properties.", "properties": { "clientId": { "description": "The client ID associated with your Hubspot application.", @@ -2713,7 +2713,7 @@ }, "JiraLinkedService": { "x-ms-discriminator-value": "Jira", - "description": "Jira Serivce linked service.", + "description": "Jira Service linked service.", "type": "object", "allOf": [ { @@ -2722,7 +2722,7 @@ ], "properties": { "typeProperties": { - "description": "Jira Serivce linked service properties.", + "description": "Jira Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JiraLinkedServiceTypeProperties" } @@ -2732,7 +2732,7 @@ ] }, "JiraLinkedServiceTypeProperties": { - "description": "Jira Serivce linked service properties.", + "description": "Jira Service linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", @@ -2916,7 +2916,7 @@ }, "PaypalLinkedService": { "x-ms-discriminator-value": "Paypal", - "description": "Paypal Serivce linked service.", + "description": "Paypal Service linked service.", "type": "object", "allOf": [ { @@ -2925,7 +2925,7 @@ ], "properties": { "typeProperties": { - "description": "Paypal Serivce linked service properties.", + "description": "Paypal Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" } @@ -2935,7 +2935,7 @@ ] }, "PaypalLinkedServiceTypeProperties": { - "description": "Paypal Serivce linked service properties.", + "description": "Paypal Service linked service properties.", "properties": { "host": { "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", @@ -3296,7 +3296,7 @@ }, "ShopifyLinkedService": { "x-ms-discriminator-value": "Shopify", - "description": "Shopify Serivce linked service.", + "description": "Shopify Service linked service.", "type": "object", "allOf": [ { @@ -3305,7 +3305,7 @@ ], "properties": { "typeProperties": { - "description": "Shopify Serivce linked service properties.", + "description": "Shopify Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" } @@ -3315,7 +3315,7 @@ ] }, "ShopifyLinkedServiceTypeProperties": { - "description": "Shopify Serivce linked service properties.", + "description": "Shopify Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", @@ -3462,7 +3462,7 @@ }, "SquareLinkedService": { "x-ms-discriminator-value": "Square", - "description": "Square Serivce linked service.", + "description": "Square Service linked service.", "type": "object", "allOf": [ { @@ -3471,7 +3471,7 @@ ], "properties": { "typeProperties": { - "description": "Square Serivce linked service properties.", + "description": "Square Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/SquareLinkedServiceTypeProperties" } @@ -3481,7 +3481,7 @@ ] }, "SquareLinkedServiceTypeProperties": { - "description": "Square Serivce linked service properties.", + "description": "Square Service linked service properties.", "properties": { "host": { "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", @@ -3524,7 +3524,7 @@ }, "XeroLinkedService": { "x-ms-discriminator-value": "Xero", - "description": "Xero Serivce linked service.", + "description": "Xero Service linked service.", "type": "object", "allOf": [ { @@ -3533,7 +3533,7 @@ ], "properties": { "typeProperties": { - "description": "Xero Serivce linked service properties.", + "description": "Xero Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/XeroLinkedServiceTypeProperties" } @@ -3543,7 +3543,7 @@ ] }, "XeroLinkedServiceTypeProperties": { - "description": "Xero Serivce linked service properties.", + "description": "Xero Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Xero server. (i.e. api.xero.com)", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 224334b3370e..d9995df91fee 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2106,7 +2106,7 @@ "type": "object" }, "marketplaceID": { - "description": "The Amazon Marketplace ID you want to retrieve data from. To retrive data from multiple Marketplace IDs, seperate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", + "description": "The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2)", "type": "object" }, "sellerID": { @@ -2188,7 +2188,7 @@ }, "ConcurLinkedService": { "x-ms-discriminator-value": "Concur", - "description": "Concur Serivce linked service.", + "description": "Concur Service linked service.", "type": "object", "allOf": [ { @@ -2197,7 +2197,7 @@ ], "properties": { "typeProperties": { - "description": "Concur Serivce linked service properties.", + "description": "Concur Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/ConcurLinkedServiceTypeProperties" } @@ -2207,7 +2207,7 @@ ] }, "ConcurLinkedServiceTypeProperties": { - "description": "Concur Serivce linked service properties.", + "description": "Concur Service linked service properties.", "properties": { "clientId": { "description": "Application client_id supplied by Concur App Management.", @@ -2704,7 +2704,7 @@ }, "HubspotLinkedService": { "x-ms-discriminator-value": "Hubspot", - "description": "Hubspot Serivce linked service.", + "description": "Hubspot Service linked service.", "type": "object", "allOf": [ { @@ -2713,7 +2713,7 @@ ], "properties": { "typeProperties": { - "description": "Hubspot Serivce linked service properties.", + "description": "Hubspot Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/HubspotLinkedServiceTypeProperties" } @@ -2723,7 +2723,7 @@ ] }, "HubspotLinkedServiceTypeProperties": { - "description": "Hubspot Serivce linked service properties.", + "description": "Hubspot Service linked service properties.", "properties": { "clientId": { "description": "The client ID associated with your Hubspot application.", @@ -2846,7 +2846,7 @@ }, "JiraLinkedService": { "x-ms-discriminator-value": "Jira", - "description": "Jira Serivce linked service.", + "description": "Jira Service linked service.", "type": "object", "allOf": [ { @@ -2855,7 +2855,7 @@ ], "properties": { "typeProperties": { - "description": "Jira Serivce linked service properties.", + "description": "Jira Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/JiraLinkedServiceTypeProperties" } @@ -2865,7 +2865,7 @@ ] }, "JiraLinkedServiceTypeProperties": { - "description": "Jira Serivce linked service properties.", + "description": "Jira Service linked service properties.", "properties": { "host": { "description": "The IP address or host name of the Jira service. (e.g. jira.example.com)", @@ -3053,7 +3053,7 @@ }, "PaypalLinkedService": { "x-ms-discriminator-value": "Paypal", - "description": "Paypal Serivce linked service.", + "description": "Paypal Service linked service.", "type": "object", "allOf": [ { @@ -3062,7 +3062,7 @@ ], "properties": { "typeProperties": { - "description": "Paypal Serivce linked service properties.", + "description": "Paypal Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/PaypalLinkedServiceTypeProperties" } @@ -3072,7 +3072,7 @@ ] }, "PaypalLinkedServiceTypeProperties": { - "description": "Paypal Serivce linked service properties.", + "description": "Paypal Service linked service properties.", "properties": { "host": { "description": "The URL of the PayPal instance. (i.e. api.sandbox.paypal.com)", @@ -3433,7 +3433,7 @@ }, "ShopifyLinkedService": { "x-ms-discriminator-value": "Shopify", - "description": "Shopify Serivce linked service.", + "description": "Shopify Service linked service.", "type": "object", "allOf": [ { @@ -3442,7 +3442,7 @@ ], "properties": { "typeProperties": { - "description": "Shopify Serivce linked service properties.", + "description": "Shopify Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/ShopifyLinkedServiceTypeProperties" } @@ -3452,7 +3452,7 @@ ] }, "ShopifyLinkedServiceTypeProperties": { - "description": "Shopify Serivce linked service properties.", + "description": "Shopify Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Shopify server. (i.e. mystore.myshopify.com)", @@ -3599,7 +3599,7 @@ }, "SquareLinkedService": { "x-ms-discriminator-value": "Square", - "description": "Square Serivce linked service.", + "description": "Square Service linked service.", "type": "object", "allOf": [ { @@ -3608,7 +3608,7 @@ ], "properties": { "typeProperties": { - "description": "Square Serivce linked service properties.", + "description": "Square Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/SquareLinkedServiceTypeProperties" } @@ -3618,7 +3618,7 @@ ] }, "SquareLinkedServiceTypeProperties": { - "description": "Square Serivce linked service properties.", + "description": "Square Service linked service properties.", "properties": { "host": { "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", @@ -3661,7 +3661,7 @@ }, "XeroLinkedService": { "x-ms-discriminator-value": "Xero", - "description": "Xero Serivce linked service.", + "description": "Xero Service linked service.", "type": "object", "allOf": [ { @@ -3670,7 +3670,7 @@ ], "properties": { "typeProperties": { - "description": "Xero Serivce linked service properties.", + "description": "Xero Service linked service properties.", "x-ms-client-flatten": true, "$ref": "#/definitions/XeroLinkedServiceTypeProperties" } @@ -3680,7 +3680,7 @@ ] }, "XeroLinkedServiceTypeProperties": { - "description": "Xero Serivce linked service properties.", + "description": "Xero Service linked service properties.", "properties": { "host": { "description": "The endpoint of the Xero server. (i.e. api.xero.com)", From 273e8adc23e7190173441ba028b287d00d281683 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 13:46:55 -0500 Subject: [PATCH 185/464] typo: eventhub/resource-manager/Microsoft.EventHub/EventHub (#4553) - successfuly -> successfully - vaule -> value - Autorization -> Authorization - Regenrate -> Regenerate - Messagning -> Messaging - envokes -> Invokes - neeeds -> needs - achive -> archive - anme -> name - Usermetadata -> User Metadata - reponse -> response - pairning -> pairing --- .../2018-01-01-preview/EventHub-preview.json | 10 ++--- .../stable/2014-09-01/EventHub.json | 6 +-- .../stable/2015-08-01/EventHub.json | 24 +++++----- ...=> EHEventHubAuthorizationRuleDelete.json} | 0 ...on => EHEventHubAuthorizationRuleGet.json} | 0 ...> EHEventHubAuthorizationRuleListAll.json} | 0 ...entHubAuthorizationRuleRegenerateKey.json} | 0 ...> EHNameSpaceAuthorizationRuleDelete.json} | 0 ...n => EHNameSpaceAuthorizationRuleGet.json} | 0 ... EHNameSpaceAuthorizationRuleListAll.json} | 0 ...eSpaceAuthorizationRuleRegenerateKey.json} | 0 .../stable/2017-04-01/EventHub.json | 44 +++++++++---------- ...=> EHEventHubAuthorizationRuleDelete.json} | 0 ...on => EHEventHubAuthorizationRuleGet.json} | 0 ...> EHEventHubAuthorizationRuleListAll.json} | 0 ...entHubAuthorizationRuleRegenerateKey.json} | 0 ...> EHNameSpaceAuthorizationRuleDelete.json} | 0 ...n => EHNameSpaceAuthorizationRuleGet.json} | 0 ... EHNameSpaceAuthorizationRuleListAll.json} | 0 ...eSpaceAuthorizationRuleRegenerateKey.json} | 0 ....json => EHNameSpaceGetMessagingPlan.json} | 0 ....json => EHAliasAuthorizationRuleGet.json} | 0 ...n => EHAliasAuthorizationRuleListAll.json} | 0 23 files changed, 42 insertions(+), 42 deletions(-) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHEventHubAutorizationRuleDelete.json => EHEventHubAuthorizationRuleDelete.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHEventHubAutorizationRuleGet.json => EHEventHubAuthorizationRuleGet.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHEventHubAutorizationRuleListAll.json => EHEventHubAuthorizationRuleListAll.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHEventHubAuthorizationRuleRegenrateKey.json => EHEventHubAuthorizationRuleRegenerateKey.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHNameSpaceAutorizationRuleDelete.json => EHNameSpaceAuthorizationRuleDelete.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHNameSpaceAutorizationRuleGet.json => EHNameSpaceAuthorizationRuleGet.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHNameSpaceAutorizationRuleListAll.json => EHNameSpaceAuthorizationRuleListAll.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/{EHNameSpaceAuthorizationRuleRegenrateKey.json => EHNameSpaceAuthorizationRuleRegenerateKey.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/{EHEventHubAutorizationRuleDelete.json => EHEventHubAuthorizationRuleDelete.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/{EHEventHubAutorizationRuleGet.json => EHEventHubAuthorizationRuleGet.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/{EHEventHubAutorizationRuleListAll.json => EHEventHubAuthorizationRuleListAll.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/{EHEventHubAuthorizationRuleRegenrateKey.json => EHEventHubAuthorizationRuleRegenerateKey.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/{EHNameSpaceAutorizationRuleDelete.json => EHNameSpaceAuthorizationRuleDelete.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/{EHNameSpaceAutorizationRuleGet.json => EHNameSpaceAuthorizationRuleGet.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/{EHNameSpaceAutorizationRuleListAll.json => EHNameSpaceAuthorizationRuleListAll.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/{EHNameSpaceAuthorizationRuleRegenrateKey.json => EHNameSpaceAuthorizationRuleRegenerateKey.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/{EHNameSpaceGetMessagningPlan.json => EHNameSpaceGetMessagingPlan.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/{EHAliasAutorizationRuleGet.json => EHAliasAuthorizationRuleGet.json} (100%) rename specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/{EHAliasAutorizationRuleListAll.json => EHAliasAuthorizationRuleListAll.json} (100%) diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json index 29eaa54e5fd3..f7f1fdfe35ea 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json @@ -410,7 +410,7 @@ } }, "200": { - "description": "Namespace successfuly created.", + "description": "Namespace successfully created.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -453,7 +453,7 @@ "description": "No content." }, "200": { - "description": "Namespace successfuly deleted." + "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." @@ -546,7 +546,7 @@ } }, "200": { - "description": "Namespace successfuly updated.", + "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -1158,7 +1158,7 @@ "type": "integer", "maximum": 20, "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" }, "kafkaEnabled": { "type": "boolean", @@ -1210,7 +1210,7 @@ "maximum": 20, "minimum": 0, "type": "integer", - "description": "The Event Hubs throughput units, vaule should be 0 to 20 throughput units." + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." } }, "required": [ diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json index 6d6936076925..dcc80378a9db 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2014-09-01/EventHub.json @@ -224,7 +224,7 @@ } }, "200": { - "description": "Namespace successfuly created.", + "description": "Namespace successfully created.", "schema": { "$ref": "#/definitions/NamespaceResource" } @@ -260,7 +260,7 @@ "description": "No content." }, "200": { - "description": "Namespace successfuly deleted." + "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." @@ -340,7 +340,7 @@ } }, "200": { - "description": "Namespace successfuly updated.", + "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/NamespaceResource" } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json index 36430aff1d23..c89708b4a04d 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/EventHub.json @@ -205,7 +205,7 @@ } }, "200": { - "description": "Namespace successfuly created.", + "description": "Namespace successfully created.", "schema": { "$ref": "#/definitions/NamespaceResource" } @@ -244,7 +244,7 @@ "description": "No content." }, "200": { - "description": "Namespace successfuly deleted." + "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." @@ -330,7 +330,7 @@ } }, "200": { - "description": "Namespace successfuly updated.", + "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/NamespaceResource" } @@ -348,7 +348,7 @@ ], "operationId": "Namespaces_ListAuthorizationRules", "x-ms-examples": { - "ListAuthorizationRules": { "$ref": "./examples/EHNameSpaceAutorizationRuleListAll.json" } + "ListAuthorizationRules": { "$ref": "./examples/EHNameSpaceAuthorizationRuleListAll.json" } }, "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ @@ -429,7 +429,7 @@ ], "operationId": "Namespaces_DeleteAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleDelete": { "$ref": "./examples/EHNameSpaceAutorizationRuleDelete.json" } + "NameSpaceAuthorizationRuleDelete": { "$ref": "./examples/EHNameSpaceAuthorizationRuleDelete.json" } }, "description": "Deletes an AuthorizationRule for a Namespace.", "parameters": [ @@ -464,7 +464,7 @@ ], "operationId": "Namespaces_GetAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleGet": { "$ref": "./examples/EHNameSpaceAutorizationRuleGet.json" } + "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/EHNameSpaceAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ @@ -538,7 +538,7 @@ ], "operationId": "Namespaces_RegenerateKeys", "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenrateKey": { "$ref": "./examples/EHNameSpaceAuthorizationRuleRegenrateKey.json" } + "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/EHNameSpaceAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", "parameters": [ @@ -749,7 +749,7 @@ ], "operationId": "EventHubs_ListAuthorizationRules", "x-ms-examples": { - "EventHubAutorizationRuleListAll": { "$ref": "./examples/EHEventHubAutorizationRuleListAll.json" } + "EventHubAuthorizationRuleListAll": { "$ref": "./examples/EHEventHubAuthorizationRuleListAll.json" } }, "description": "Gets the authorization rules for an Event Hub.", "parameters": [ @@ -839,7 +839,7 @@ ], "operationId": "EventHubs_GetAuthorizationRule", "x-ms-examples": { - "EventHubAutorizationRuleGet": { "$ref": "./examples/EHEventHubAutorizationRuleGet.json" } + "EventHubAuthorizationRuleGet": { "$ref": "./examples/EHEventHubAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for an Event Hub by rule name.", "externalDocs": { @@ -880,7 +880,7 @@ ], "operationId": "EventHubs_PosttAuthorizationRule", "x-ms-examples": { - "EventHubAutorizationRuleGet": { "$ref": "./examples/EHEventHubAutorizationRuleGet.json" } + "EventHubAuthorizationRuleGet": { "$ref": "./examples/EHEventHubAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for an Event Hub by rule name.", "externalDocs": { @@ -921,7 +921,7 @@ ], "operationId": "EventHubs_DeleteAuthorizationRule", "x-ms-examples": { - "EventHubAutorizationRuleDelete": { "$ref": "./examples/EHEventHubAutorizationRuleDelete.json" } + "EventHubAuthorizationRuleDelete": { "$ref": "./examples/EHEventHubAuthorizationRuleDelete.json" } }, "description": "Deletes an Event Hub AuthorizationRule.", "externalDocs": { @@ -1007,7 +1007,7 @@ ], "operationId": "EventHubs_RegenerateKeys", "x-ms-examples": { - "EventHubAuthorizationRuleRegenrateKey": { "$ref": "./examples/EHEventHubAuthorizationRuleRegenrateKey.json" } + "EventHubAuthorizationRuleRegenerateKey": { "$ref": "./examples/EHEventHubAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", "externalDocs": { diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleDelete.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleDelete.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleDelete.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleGet.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleGet.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleListAll.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAutorizationRuleListAll.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleListAll.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleRegenrateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleRegenrateKey.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHEventHubAuthorizationRuleRegenerateKey.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleDelete.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleDelete.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleDelete.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleGet.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleGet.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleListAll.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAutorizationRuleListAll.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleListAll.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleRegenrateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleRegenrateKey.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2015-08-01/examples/EHNameSpaceAuthorizationRuleRegenerateKey.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json index d70c4431e7ce..21af98876a91 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/EventHub.json @@ -232,7 +232,7 @@ } }, "200": { - "description": "Namespace successfuly created.", + "description": "Namespace successfully created.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -277,7 +277,7 @@ "description": "No content." }, "200": { - "description": "Namespace successfuly deleted." + "description": "Namespace successfully deleted." }, "202": { "description": "Namespace delete request accepted." @@ -375,7 +375,7 @@ } }, "200": { - "description": "Namespace successfuly updated.", + "description": "Namespace successfully updated.", "schema": { "$ref": "#/definitions/EHNamespace" } @@ -399,7 +399,7 @@ ], "operationId": "Namespaces_GetMessagingPlan", "x-ms-examples": { - "GetNamespaceMessagingPlan": { "$ref": "./examples/NameSpaces/EHNameSpaceGetMessagningPlan.json" } + "GetNamespaceMessagingPlan": { "$ref": "./examples/NameSpaces/EHNameSpaceGetMessagingPlan.json" } }, "description": "Gets messaging plan for specified namespace.", "parameters": [ @@ -439,7 +439,7 @@ ], "operationId": "Namespaces_ListAuthorizationRules", "x-ms-examples": { - "ListAuthorizationRules": { "$ref": "./examples/NameSpaces/EHNameSpaceAutorizationRuleListAll.json" } + "ListAuthorizationRules": { "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json" } }, "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ @@ -532,7 +532,7 @@ ], "operationId": "Namespaces_DeleteAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleDelete": { "$ref": "./examples/NameSpaces/EHNameSpaceAutorizationRuleDelete.json" } + "NameSpaceAuthorizationRuleDelete": { "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json" } }, "description": "Deletes an AuthorizationRule for a Namespace.", "parameters": [ @@ -573,7 +573,7 @@ ], "operationId": "Namespaces_GetAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleGet": { "$ref": "./examples/NameSpaces/EHNameSpaceAutorizationRuleGet.json" } + "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ @@ -659,7 +659,7 @@ ], "operationId": "Namespaces_RegenerateKeys", "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenrateKey": { "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenrateKey.json" } + "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the primary or secondary connection strings for the specified Namespace.", "parameters": [ @@ -979,7 +979,7 @@ "x-ms-examples": { "EHAliasFailOver": { "$ref": "./examples/disasterRecoveryConfigs/EHAliasFailOver.json" } }, - "description": "envokes GEO DR failover and reconfigure the alias to point to the secondary namespace", + "description": "Invokes GEO DR failover and reconfigure the alias to point to the secondary namespace", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -1017,7 +1017,7 @@ ], "operationId": "DisasterRecoveryConfigs_ListAuthorizationRules", "x-ms-examples": { - "ListAuthorizationRules": { "$ref": "./examples/disasterRecoveryConfigs/EHAliasAutorizationRuleListAll.json" } + "ListAuthorizationRules": { "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json" } }, "description": "Gets a list of authorization rules for a Namespace.", "parameters": [ @@ -1063,7 +1063,7 @@ ], "operationId": "DisasterRecoveryConfigs_GetAuthorizationRule", "x-ms-examples": { - "NameSpaceAutorizationRuleGet": { "$ref": "./examples/disasterRecoveryConfigs/EHAliasAutorizationRuleGet.json" } + "NameSpaceAuthorizationRuleGet": { "$ref": "./examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for a Namespace by rule name.", "parameters": [ @@ -1338,7 +1338,7 @@ ], "operationId": "EventHubs_ListAuthorizationRules", "x-ms-examples": { - "EventHubAutorizationRuleListAll": { "$ref": "./examples/EventHubs/EHEventHubAutorizationRuleListAll.json" } + "EventHubAuthorizationRuleListAll": { "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleListAll.json" } }, "description": "Gets the authorization rules for an Event Hub.", "parameters": [ @@ -1437,7 +1437,7 @@ ], "operationId": "EventHubs_GetAuthorizationRule", "x-ms-examples": { - "EventHubAutorizationRuleGet": { "$ref": "./examples/EventHubs/EHEventHubAutorizationRuleGet.json" } + "EventHubAuthorizationRuleGet": { "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleGet.json" } }, "description": "Gets an AuthorizationRule for an Event Hub by rule name.", "parameters": [ @@ -1481,7 +1481,7 @@ ], "operationId": "EventHubs_DeleteAuthorizationRule", "x-ms-examples": { - "EventHubAutorizationRuleDelete": { "$ref": "./examples/EventHubs/EHEventHubAutorizationRuleDelete.json" } + "EventHubAuthorizationRuleDelete": { "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleDelete.json" } }, "description": "Deletes an Event Hub AuthorizationRule.", "parameters": [ @@ -1573,7 +1573,7 @@ ], "operationId": "EventHubs_RegenerateKeys", "x-ms-examples": { - "EventHubAuthorizationRuleRegenrateKey": { "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleRegenrateKey.json" } + "EventHubAuthorizationRuleRegenerateKey": { "$ref": "./examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json" } }, "description": "Regenerates the ACS and SAS connection strings for the Event Hub.", "parameters": [ @@ -1971,7 +1971,7 @@ "type": "integer", "maximum": 20, "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, vaule should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" }, "kafkaEnabled": { "type": "boolean", @@ -2020,7 +2020,7 @@ "maximum": 20, "minimum": 0, "type": "integer", - "description": "The Event Hubs throughput units, vaule should be 0 to 20 throughput units." + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." } }, "required": [ @@ -2141,7 +2141,7 @@ "required": [ "keyType" ], - "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key neeeds to be reset." + "description": "Parameters supplied to the Regenerate Authorization Rule operation, specifies which key needs to be reset." }, "Eventhub": { "properties": { @@ -2276,7 +2276,7 @@ "description": "Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order" } }, - "description": "Properties describing the storage account, blob container and acrchive anme format for capture destination" + "description": "Properties describing the storage account, blob container and archive name format for capture destination" } }, "description": "Capture storage details for capture description" @@ -2316,7 +2316,7 @@ }, "userMetadata": { "type": "string", - "description": "Usermetadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." + "description": "User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be used to store descriptive data, such as list of teams and their contact information also user-defined configuration settings can be stored." } }, "description": "Single item in List or Get Consumer group operation" @@ -2441,7 +2441,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates EventHub service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { @@ -2475,7 +2475,7 @@ }, "partnerNamespace": { "type": "string", - "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairning" + "description": "ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing" }, "alternateName": { "type": "string", diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleDelete.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleDelete.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleDelete.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleGet.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleGet.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleListAll.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAutorizationRuleListAll.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleListAll.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleRegenrateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleRegenrateKey.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/EventHubs/EHEventHubAuthorizationRuleRegenerateKey.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleDelete.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleDelete.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleDelete.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleGet.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAutorizationRuleListAll.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleListAll.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenrateKey.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenrateKey.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceAuthorizationRuleRegenerateKey.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceGetMessagningPlan.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceGetMessagingPlan.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceGetMessagningPlan.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/NameSpaces/EHNameSpaceGetMessagingPlan.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAutorizationRuleGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAutorizationRuleGet.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAutorizationRuleListAll.json b/specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json similarity index 100% rename from specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAutorizationRuleListAll.json rename to specification/eventhub/resource-manager/Microsoft.EventHub/stable/2017-04-01/examples/disasterRecoveryConfigs/EHAliasAuthorizationRuleListAll.json From 29bdac8e74f5fae3ded0d4fb7b4a005b6e5ed707 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 14:10:29 -0500 Subject: [PATCH 186/464] typo: seperate -> separate (#4539) --- specification/servicefabricmesh/resource-manager/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/servicefabricmesh/resource-manager/readme.md b/specification/servicefabricmesh/resource-manager/readme.md index 93f5b287119a..83efdb69f4b5 100644 --- a/specification/servicefabricmesh/resource-manager/readme.md +++ b/specification/servicefabricmesh/resource-manager/readme.md @@ -32,7 +32,7 @@ tag: package-2018-09-01-preview directive: - suppress: RequiredPropertiesMissingInResourceModel - reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a seperate proxy resource. + reason: Service is a proxy resource that is managed (created and updated) by including it in the application resource. The name is required by RP to manage those resources. The name is readOnly in the default resource schema so it is not serialized on the wire by AutoRest generated libraries. This is a bug on our RP and should be fixed. The inlined objects should be part of the application properties and not a separate proxy resource. - suppress: EnumInsteadOfBoolean reason: The `readOnly` boolean schema is part of Azure Resource Manager common schema. - suppress: TrackedResourcePatchOperation From f1e5660556d6c4c215749dcc8125939c40332e20 Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Tue, 27 Nov 2018 03:11:05 +0800 Subject: [PATCH 187/464] Add type for DeploymentExtend and ResourceGroup (#4501) --- .../stable/2018-05-01/resources.json | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index aeffab711b42..13c788d880ff 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -2814,6 +2814,11 @@ "type": "string", "description": "The name of the deployment." }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the deployment." + }, "location": { "type": "string", "description": "the location of the deployment." @@ -3027,6 +3032,11 @@ "type": "string", "description": "The name of the resource group." }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource group." + }, "properties": { "$ref": "#/definitions/ResourceGroupProperties" }, From 683c0d950972aa4d4ec01893a419fe34232ca135 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 14:15:09 -0500 Subject: [PATCH 188/464] typo: mediaservices/resource-manager/Microsoft.Media/StreamingPoliciesAndStreamingLocators (#4543) - proprty -> property - Stremaing -> Streaming - sepearate -> separate - Acquistion -> Acquisition - speicified -> specified - Configuations -> Configuration - Doulbe word "of" - Doulbe word "the" --- .../StreamingPoliciesAndStreamingLocators.json | 18 +++++++++--------- .../StreamingPoliciesAndStreamingLocators.json | 8 ++++---- .../StreamingPoliciesAndStreamingLocators.json | 8 ++++---- 3 files changed, 17 insertions(+), 17 deletions(-) diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json index 384052416c3c..29e20f920731 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-03-30-preview/StreamingPoliciesAndStreamingLocators.json @@ -74,7 +74,7 @@ }, "value": { "type": "string", - "description": "Track proprty value" + "description": "Track property value" } }, "type": "object", @@ -101,7 +101,7 @@ "properties": { "label": { "type": "string", - "description": "Label can be used to specify Content Key when creating Stremaing Locator" + "description": "Label can be used to specify Content Key when creating Streaming Locator" }, "policyName": { "type": "string", @@ -115,7 +115,7 @@ "properties": { "label": { "type": "string", - "description": "Label can be used to specify Content Key when creating Stremaing Locator" + "description": "Label can be used to specify Content Key when creating Streaming Locator" }, "policyName": { "type": "string", @@ -143,7 +143,7 @@ "items": { "$ref": "#/definitions/StreamingPolicyContentKey" }, - "description": "Representing tracks needs sepearete content key" + "description": "Representing tracks needs separate content key" } }, "type": "object", @@ -279,7 +279,7 @@ }, "customLicenseAcquisitionUrlTemplate": { "type": "string", - "description": "LicenseAcquistionUrlTemplate is used to point to user speicified service to delivery content keys" + "description": "LicenseAcquisitionUrlTemplate is used to point to user specified service to delivery content keys" } }, "type": "object", @@ -362,7 +362,7 @@ }, "noEncryption": { "$ref": "#/definitions/NoEncryption", - "description": "Configuations of NoEncryption" + "description": "Configuration of NoEncryption" } }, "type": "object", @@ -445,7 +445,7 @@ }, "value": { "type": "string", - "description": "Value of of Content Key" + "description": "Value of Content Key" }, "policyName": { "type": "string", @@ -733,7 +733,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { @@ -959,7 +959,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json index 4dc3ca242d4a..1732f0fa3e65 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/preview/2018-06-01-preview/StreamingPoliciesAndStreamingLocators.json @@ -280,7 +280,7 @@ }, "customKeyAcquisitionUrlTemplate": { "type": "string", - "description": "KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys" + "description": "KeyAcquisitionUrlTemplate is used to point to user specified service to delivery content keys" } }, "type": "object", @@ -426,7 +426,7 @@ }, "value": { "type": "string", - "description": "Value of of Content Key" + "description": "Value of Content Key" }, "policyName": { "type": "string", @@ -753,7 +753,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { @@ -979,7 +979,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json index c827450bc364..12f4c598afa2 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json @@ -280,7 +280,7 @@ }, "customKeyAcquisitionUrlTemplate": { "type": "string", - "description": "KeyAcquistionUrlTemplate is used to point to user specified service to delivery content keys" + "description": "KeyAcquisitionUrlTemplate is used to point to user specified service to delivery content keys" } }, "type": "object", @@ -426,7 +426,7 @@ }, "value": { "type": "string", - "description": "Value of of Content Key" + "description": "Value of Content Key" }, "policyName": { "type": "string", @@ -754,7 +754,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { @@ -980,7 +980,7 @@ "in": "query", "required": false, "type": "string", - "description": "Specifies the the key by which the result collection should be ordered." + "description": "Specifies the key by which the result collection should be ordered." } ], "x-ms-pageable": { From b0478bcd1d3e010028ce5e74c24d2f66f898b21e Mon Sep 17 00:00:00 2001 From: Elia Grady Date: Mon, 26 Nov 2018 21:38:59 +0200 Subject: [PATCH 189/464] rename folder paths for autorest code generation (#4562) --- specification/security/resource-manager/readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index c7fe5ac06716..711c121ebab7 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -66,7 +66,7 @@ swagger-to-sdk: - repo: azure-sdk-for-node ``` -## C +## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -77,7 +77,7 @@ csharp: license-header: MICROSOFT_MIT_NO_VERSION namespace: Microsoft.Azure.Management.Security payload-flattening-threshold: 2 - output-folder: $(csharp-sdks-folder)/Security/Management.Security/Generated + output-folder: $(csharp-sdks-folder)/SecurityCenter/Management.SecurityCenter/Generated clear-output-folder: true ``` From 6f5325b77bf8036c1bf60d32fdefbcc952b79104 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 15:04:33 -0500 Subject: [PATCH 190/464] typo: applicationinsights data-lane and resource-manager (#4554) - metatadata -> metadata - assmebly -> assembly - doens't -> doesn't - reponse -> response - createion -> creation - Applciation -> Application - aditional -> additional - an workitem -> a work item - detaile d -> detailed - defintions -> definitions - definitioned -> definitions --- .../microsoft.insights/preview/2018-04-20/swagger.json | 4 ++-- .../data-plane/microsoft.insights/preview/v1/AppInsights.json | 4 ++-- .../preview/2018-06-17-preview/workbooks_API.json | 2 +- .../stable/2015-05-01/aiOperations_API.json | 2 +- .../stable/2015-05-01/componentApiKeys_API.json | 4 ++-- .../stable/2015-05-01/componentContinuousExport_API.json | 2 +- .../stable/2015-05-01/componentProactiveDetection_API.json | 2 +- .../stable/2015-05-01/componentWorkItemConfigs_API.json | 4 ++-- .../Microsoft.Insights/stable/2015-05-01/components_API.json | 2 +- .../Microsoft.Insights/stable/2015-05-01/webTests_API.json | 2 +- .../Microsoft.Insights/stable/2015-05-01/workbooks_API.json | 2 +- 11 files changed, 15 insertions(+), 15 deletions(-) diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json index 2532c71e063f..98a1f3882d54 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json @@ -204,7 +204,7 @@ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/metadata": { "get": { "operationId": "Metrics_GetMetadata", - "summary": "Retrieve metric metatadata", + "summary": "Retrieve metric metadata", "description": "Gets metadata describing the available metrics", "x-ms-examples": { "metricMetadata": { @@ -1534,7 +1534,7 @@ "type": "string" }, "outerAssembly": { - "description": "The outer assmebly of the exception", + "description": "The outer assembly of the exception", "type": "string" }, "outerMessage": { diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json index ad12ee07fa7f..64af9e8269d5 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json @@ -143,7 +143,7 @@ "/apps/{appId}/metrics/metadata": { "get": { "operationId": "Metrics_GetMetadata", - "summary": "Retrieve metric metatadata", + "summary": "Retrieve metric metadata", "description": "Gets metadata describing the available metrics", "x-ms-examples": { "metricMetadata": { @@ -1471,7 +1471,7 @@ "type": "string" }, "outerAssembly": { - "description": "The outer assmebly of the exception", + "description": "The outer assembly of the exception", "type": "string" }, "outerMessage": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json index 8767c21df81d..892b2703d813 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-06-17-preview/workbooks_API.json @@ -145,7 +145,7 @@ "description": "The workbook has been successfully deleted." }, "204": { - "description": "The resource doens't exist." + "description": "The resource doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json index 1cffd9d61bea..5e455777d7bd 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/aiOperations_API.json @@ -68,7 +68,7 @@ }, "definitions": { "ErrorResponse": { - "description": "Error reponse indicates Insights service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Insights service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json index 0987ca2e0d02..b170d7dc0239 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json @@ -183,7 +183,7 @@ }, "definitions": { "APIKeyRequest": { - "description": "An Application Insights component API Key createion request definition.", + "description": "An Application Insights component API Key creation request definition.", "type": "object", "properties": { "name": { @@ -228,7 +228,7 @@ "id": { "type": "string", "readOnly": true, - "description": "The unique ID of the API key inside an Applciation Insights component. It is auto generated when the API key is created." + "description": "The unique ID of the API key inside an Application Insights component. It is auto generated when the API key is created." }, "apiKey": { "type": "string", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json index fe843165704c..d81cfddbb501 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json @@ -278,7 +278,7 @@ "ExportId": { "type": "string", "readOnly": true, - "description": "The unique ID of the export configuration inside an Applciation Insights component. It is auto generated when the Continuous Export configuration is created." + "description": "The unique ID of the export configuration inside an Application Insights component. It is auto generated when the Continuous Export configuration is created." }, "InstrumentationKey": { "type": "string", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json index 2b83ff8dce73..b1edfef80cce 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json @@ -211,7 +211,7 @@ "HelpUrl": { "type": "string", "readOnly": false, - "description": "URL which displays aditional info about the proactive detection rule" + "description": "URL which displays additional info about the proactive detection rule" }, "IsHidden": { "type": "boolean", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json index 0b19c8af4472..51065656a688 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json @@ -151,7 +151,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/WorkItemConfigs/{workItemConfigId}": { "delete": { - "description": "Delete an workitem configuration of an Application Insights component.", + "description": "Delete a work item configuration of an Application Insights component.", "operationId": "WorkItemConfigurations_Delete", "parameters": [ { @@ -235,7 +235,7 @@ }, "ConnectorDataConfiguration": { "type": "string", - "description": "Serialized JSON object for detaile d properties" + "description": "Serialized JSON object for detailed properties" }, "ValidateOnly": { "type": "boolean", diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json index c550d1965d11..80e9024a2ad5 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json @@ -507,7 +507,7 @@ }, "nextLink": { "type": "string", - "description": "The URI to get the next set of Application Insights component defintions if too many components where returned in the result set." + "description": "The URI to get the next set of Application Insights component definitions if too many components where returned in the result set." } } }, diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json index 56a30eaf078e..eb880c0232ce 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/webTests_API.json @@ -216,7 +216,7 @@ }, "/subscriptions/{subscriptionId}/providers/Microsoft.Insights/webtests": { "get": { - "description": "Get all Application Insights web test alerts definitioned within a subscription.", + "description": "Get all Application Insights web test alerts definitions within a subscription.", "operationId": "WebTests_List", "parameters": [ { diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json index 60b4f9f28063..e472cd120d6e 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/workbooks_API.json @@ -142,7 +142,7 @@ "description": "The workbook has been successfully deleted." }, "204": { - "description": "The resource doens't exist." + "description": "The resource doesn't exist." }, "default": { "description": "Error response describing why the operation failed.", From 6c4d8654b92a01dbcbe5215bcb2c158e5ed58ff0 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 16:14:54 -0500 Subject: [PATCH 191/464] typo: alertsmanagement/resource-manager/Microsoft.AlertsManagement/AlertsManagement.json (#4515) - Succesfully -> Successfully - Defaut -> Default - seperated -> separated --- .../stable/2018-05-05/AlertsManagement.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json index b1669d0a2fe1..be39f0573a39 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json @@ -40,7 +40,7 @@ ], "responses": { "200": { - "description": "OK. Succesfully retrieved operations list.", + "description": "OK. Successfully retrieved operations list.", "schema": { "$ref": "#/definitions/operationsList" } @@ -119,7 +119,7 @@ ], "responses": { "200": { - "description": "OK. Succesfully listed alert objects.", + "description": "OK. Successfully listed alert objects.", "schema": { "$ref": "#/definitions/alertsList" } @@ -607,7 +607,7 @@ } }, "severity": { - "description": "Filter by severity. Defaut value is select all.", + "description": "Filter by severity. Default value is select all.", "name": "severity", "type": "string", "in": "query", @@ -850,7 +850,7 @@ ] }, "select": { - "description": "This filter allows to selection of the fields(comma seperated) which would be part of the the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section.", + "description": "This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section.", "name": "select", "type": "string", "in": "query", From d5028cbdb4b70e603d7ded73a15606bd5b000b8e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 16:24:09 -0500 Subject: [PATCH 192/464] typo: README.md (#4541) - Doulbe word "of" - MSFT -> Microsoft --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95373075cd54..786c0ad791d0 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,9 @@ This repository is the canonical source for REST API specifications for Microsoft Azure. ## Basics -If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. +If you're a spec author looking for information about all of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. -Latest improvement: MSFT employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapihub) - online experience for using our validation tools and finding your workflow. +Latest improvement: Microsoft employees can try out our new experience at [OpenAPI Hub](https://aka.ms/openapihub) - online experience for using our validation tools and finding your workflow. Please check the [announcements page](https://github.com/Azure/azure-rest-api-specs/wiki/Announcements) for any new updates since your last visit. From 4e2fcf47a1d7d2ccc70aa91d13e6930fba54038c Mon Sep 17 00:00:00 2001 From: Anand <44665487+bingisbestest@users.noreply.github.com> Date: Tue, 27 Nov 2018 02:55:27 +0530 Subject: [PATCH 193/464] Fix endpoint name clash (#4548) --- .../data-plane/QnAMaker/stable/v4.0/QnAMaker.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index e64b89fcfb7e..a2e196d6f592 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -30,7 +30,7 @@ "/endpointkeys": { "get": { "summary": "Gets endpoint keys for an endpoint", - "operationId": "Endpoint_GetKeys", + "operationId": "EndpointKeys_GetKeys", "parameters": [], "consumes": [ "application/json" @@ -66,7 +66,7 @@ "EndpointKeys" ], "summary": "Re-generates an endpoint key.", - "operationId": "Endpoint_RefreshKeys", + "operationId": "EndpointKeys_RefreshKeys", "parameters": [ { "$ref": "#/parameters/KeyType" From 939a337dcbba075c660211b19c361b674b23ba9a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 16:35:09 -0500 Subject: [PATCH 194/464] typo: profile (#4555) - avaialbility -> availability - Remove extra tailing comma - Trim whitespace - resource -> resource --- profile/2017-03-09-profile.json | 2 +- profile/2018-03-01-hybrid.json | 6 +++--- profile/readme.md | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/profile/2017-03-09-profile.json b/profile/2017-03-09-profile.json index 38a4ccf15854..4760b33fd04a 100644 --- a/profile/2017-03-09-profile.json +++ b/profile/2017-03-09-profile.json @@ -1,7 +1,7 @@ { "info":{ "name":"2017-03-09-profile", - "description":"Profile definition targeted for hybrid applications that could run on azure stack general avaialbility version and azure cloud" + "description":"Profile definition targeted for hybrid applications that could run on azure stack general availability version and azure cloud" }, "resource-manager": { "microsoft.authorization": { diff --git a/profile/2018-03-01-hybrid.json b/profile/2018-03-01-hybrid.json index 26a5d8156475..b67a13f39cf4 100644 --- a/profile/2018-03-01-hybrid.json +++ b/profile/2018-03-01-hybrid.json @@ -91,7 +91,7 @@ "subscriptions/resourceGroups/resources", "subscriptions/resources", "subscriptions/tagNames", - "subscriptions/tagNames/tagValues", + "subscriptions/tagNames/tagValues" ] }, "microsoft.storage": { @@ -102,7 +102,7 @@ "operations", "storageAccounts", "usages" - ] + ] }, "microsoft.web": { "2016-03-01":[ @@ -110,7 +110,7 @@ "deploymentLocations", "georegions", "operations", - "recommendations", + "recommendations", "runtimes", "validate" ], diff --git a/profile/readme.md b/profile/readme.md index 3eb0ddc690e4..b93c994e0fdf 100644 --- a/profile/readme.md +++ b/profile/readme.md @@ -1,16 +1,16 @@ -# API Profile +# API Profile ## Description The files in the folder describe the map of each resource provider's resource types and their supported api versions in the api profile. ## Basics -An API profile represents a map of resource provider namespaces and their API versions. It is a representation of an Azure Platform declaring a set of APIs to be supported across all our clouds.Instead of specifying individual api-versions for each resource type across each namespace, the developer can just align the application to a profile and the tools/SDKs will themselves select the right api-versions as directed by the profile. With API Profiles developers can specify a profile version that applies to an entire template and, at runtime, ARM will pick the right versions of the resources. This way, the customers don’t have to worry about which are the right resource versions to specific clouds. +An API profile represents a map of resource provider namespaces and their API versions. It is a representation of an Azure Platform declaring a set of APIs to be supported across all our clouds.Instead of specifying individual api-versions for each resource type across each namespace, the developer can just align the application to a profile and the tools/SDKs will themselves select the right api-versions as directed by the profile. With API Profiles developers can specify a profile version that applies to an entire template and, at runtime, ARM will pick the right versions of the resources. This way, the customers don’t have to worry about which are the right resource versions to specific clouds. https://docs.microsoft.com/en-us/azure/azure-stack/user/azure-stack-version-profiles ## File Structure -The profile is a one to one map. The api version specified is a single version for the resource type, although the reource type could support other older api versions as well. +The profile is a one to one map. The api version specified is a single version for the resource type, although the resource type could support other older api versions as well. 1. **Resource manager map**: The top level node `resource-manager` defines the map for the management plane of the resource provider and api version of the resource type @@ -30,7 +30,7 @@ The structure should appear like below: | | "name":"xxxx-xx-xx-profile", | | "description":"description of profile" \----}, -+---"resource-manager": { ++---"resource-manager": { | +---"rp-namespace1": { | | +---"api-version1":[ | | +---"resourcetype1", From 9f816020fd738dfbb99677e6f8d5de2a1940b3e8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 16:35:51 -0500 Subject: [PATCH 195/464] typo: CONTRIBUTING.md (#4540) - Double word "of" - sytactically -> syntactically - properities -> properties --- .github/CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 64dd616e7a22..1a36d0d17086 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -2,7 +2,7 @@ First, thank you for contributing to Azure specs repository! Swagger specs are the basis for generating Azure SDKs in multiple different languages, Azure CLIs for interacting with the services, and can provide documentation for these services. ## Basics -If you're a spec author looking for information about all of of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. +If you're a spec author looking for information about all of the repositories and steps in the pipeline, go to the [adx-documentation-pr](https://github.com/Azure/adx-documentation-pr) repository. Make sure to [join the Github Azure organization](http://aka.ms/azuregithub) to get access to that repo. ## Table of Contents [Before starting](#before-starting) @@ -86,7 +86,7 @@ Use the git tools you have available to you, such as amend, rebase, etc. ## Review process -We review spec PRs to maintain a high bar of quality for all products that will be generated from these specs (including SDKs in all languages, CLIs and documentation). It's critical that spec files are both sytactically and semantically correct, as well as conform to common patterns that make it possible to generate SDKs and CLIs that are usable for customers. Since specs are the base input for all of these products, the review process starts with PRs to this repository. Please refer to [Swagger Review Process](https://github.com/Azure/adx-documentation-pr/wiki/Swagger-Review-Process) for more details. +We review spec PRs to maintain a high bar of quality for all products that will be generated from these specs (including SDKs in all languages, CLIs and documentation). It's critical that spec files are both syntactically and semantically correct, as well as conform to common patterns that make it possible to generate SDKs and CLIs that are usable for customers. Since specs are the base input for all of these products, the review process starts with PRs to this repository. Please refer to [Swagger Review Process](https://github.com/Azure/adx-documentation-pr/wiki/Swagger-Review-Process) for more details. The expectation is that every spec in a PR will be correct JSON, syntactically correct, will semantically agree with the service it applies to, and will follow the recommended patterns. @@ -95,7 +95,7 @@ A spec file must be valid JSON, according to the [JSON specification](https://to #### Semantic correctness Your spec file must correctly represent your service. Even if a spec passes all of the rules listed above, it might not accurately describe the service that it is intended to describe. This could include -- Incorrect schemas for responses or requests (both missing and superfluous properities) +- Incorrect schemas for responses or requests (both missing and superfluous properties) - Missing operations - Missing parameters (especially required ones) - etc (this list is not comprehensive) From da93a8f5a90e63c882d176021d6b935671faf0ba Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 26 Nov 2018 16:37:37 -0500 Subject: [PATCH 196/464] typo: Documentation folder (#4556) - Add missing code fence languages - userid -> userId - defintion -> definition - definining -> defining - indcate -> indicate - exension -> extension - paramemter -> parameter - acronmys -> acronyms - referenes -> references - recommanded -> recommended - refere -> refer - exaclty -> exactly - erraneous -> erroneous - shema -> schema - flexibily -> flexibility - reponse -> response - atleast -> at least - availabilty -> availability - relvant -> relevant - Needlees -> Needless - throughly -> thoroughly - continously -> continuously - specfication -> specification - valueable -> valuable --- documentation/creating-swagger.md | 16 ++-- .../openapi-authoring-automated-guidelines.md | 80 +++++++++---------- .../swagger-authoring-descriptions.md | 4 +- documentation/swagger-checklist.md | 2 +- documentation/x-ms-examples.md | 4 +- 5 files changed, 53 insertions(+), 53 deletions(-) diff --git a/documentation/creating-swagger.md b/documentation/creating-swagger.md index 9117ddea7d80..e2bfa9687afa 100644 --- a/documentation/creating-swagger.md +++ b/documentation/creating-swagger.md @@ -59,7 +59,7 @@ The **title** field is used as the name of the generated client. } ``` -``` +```csharp var client = new MyClientName(); ``` Override the title client name by passing the `-ClientName` to AutoRest. @@ -224,7 +224,7 @@ are `in` the `path` must have a `true` value for the `required` field. In this e is populated with the value of userId provided in the client method. ```json5 "paths": { - "/users/{userid}": { + "/users/{userId}": { "get": { "operationId": "users_getById", "parameters": [ @@ -334,7 +334,7 @@ Each operation defines the possible responses by HTTP status code: Swagger allows for specifying a `default` response. AutoRest treats the `default` response as defining an error response status code unless `default` is the only status code defined. The reason for imposing this convention is to produce higher quality API signatures. The return type of the generated API is determined by finding a common -base type of the success responses. In practice, if the default is considered as a potential success defintion, +base type of the success responses. In practice, if the default is considered as a potential success definition, the common ancestor of success responses and error responses ends up being Object. ### Negative Responses @@ -372,7 +372,7 @@ You can describe all the [possible HTTP Response status codes](http://www.w3.org Exception will not be thrown.", }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" @@ -414,7 +414,7 @@ Please note, that the use of "x-ms-paths" should be minimized to the above scena The request body and response definitions become simple model types in the generated code. The models include basic validation methods, but are generally stateless serialization definitions. -### Understanding the importance of "type" keyword while definining model types. +### Understanding the importance of "type" keyword while defining model types. "Type-specific" keywords such as properties, items, minLength, etc. do not enforce a type on the schema. It works the other way around – when an instance is validated against a schema, these keywords only apply when the instance is of the corresponding type, otherwise they are ignored. Here's the relevant part of the [JSON Schema Validation](https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-4.1) spec: > 4.1. Keywords and instance primitive types @@ -674,8 +674,8 @@ as an enum. However, not all enumeration values should necessarily be represente considerations, such as how often expected values might change, since adding a new value to a C# enum is a breaking change requiring an updated API version. Additionally, there is some metadata that is required to create a useful C# enum, such as a descriptive name, which is not represented in swagger. For this reason, enums are not automatically turned into -enum types in C# - instead they are rendered in the documentation comments for the property or parameter to indcate allowed -values. To indicate that an enum will rarely change and that C# enum semantics are desired, use the `x-ms-enum` exension. +enum types in C# - instead they are rendered in the documentation comments for the property or parameter to indicate allowed +values. To indicate that an enum will rarely change and that C# enum semantics are desired, use the `x-ms-enum` extension. In C#, an enum type is generated and is declared as the type of the related request/response object. The enum is serialized as the string expected by the REST API. @@ -697,7 +697,7 @@ as the string expected by the REST API. ``` ### x-ms-enum extension structure -``` +```json5 { "x-ms-enum": { "name" : "Specify the name for the Enum." diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index e8798bb49a47..00eeb7d8bd99 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -136,7 +136,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an **Output Message**: API Version must be in the format: yyyy-MM-dd, optionally followed by -preview, -alpha, -beta, -rc, -privatepreview. -**Description**: The API Version paramemter MUST be in the Year-Month-Date format (i.e. 2016-07-04.) NOTE that this is the en-US ordering of month and date. +**Description**: The API Version parameter MUST be in the Year-Month-Date format (i.e. 2016-07-04.) NOTE that this is the en-US ordering of month and date. The date MAY optionally be followed by one of: * -preview - Indicates the API version is in (public) preview @@ -178,7 +178,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Description**: Property names must use lowerCamelCase style. If the property is a single word (ex: foo, bar, etc.) it will be all lowercase. -Two-letter acronmys (ex: ID, IO, IP, etc.) should be capitalized. +Two-letter acronyms (ex: ID, IO, IP, etc.) should be capitalized. Three-letter acronyms (ex: API, URL, etc.) should only have the first letter capitalized (ex: Api, Url, etc.) For more capitalization guidance, see: [https://msdn.microsoft.com/en-us/library/141e06ef(v=vs.71).aspx](https://msdn.microsoft.com/en-us/library/141e06ef(v=vs.71).aspx) @@ -344,7 +344,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the `location` property in the tracked resource's hierarchy has `x-ms-mutability` correctly set to `read` and `create`. For example: -``` +```json "location": { "type": "string", "description": "location of the resource", @@ -370,7 +370,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Impact on generated code**: Generated SDK code will expose the corresponding client name on property or model. **Examples**: -``` +```json ... "x-ms-client-name": "name" ... @@ -418,7 +418,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Good Examples**: Example with primitive type. -``` +```json "MyPrimitiveArray":{ "type": "array", "items": { @@ -427,7 +427,7 @@ Example with primitive type. } ``` Example with object reference type -``` +```json "MyComplexArray":{ "type": "array", "items": { @@ -454,7 +454,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Impact on generated code**: Generated SDK code will expose the corresponding client name on property or model. **Examples**: -``` +```json "parameters": { "ApiVersionParameter": { "name": "x-ms-version", @@ -496,7 +496,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Impact on generated code**: Generated SDK code will expose the corresponding client name on property or model. **Examples**: -``` +```json { "definitions": { "Product": { @@ -524,7 +524,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Why the rule is important**: Facilitate decoupling of "msdn.microsoft.com" from "docs.microsoft.com". -**How to fix the violation**: Please avoid using referenes to "msdn.microsoft.com" in title and descriptions. +**How to fix the violation**: Please avoid using references to "msdn.microsoft.com" in title and descriptions. **Impact on generated code**: N/A. @@ -648,7 +648,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Applies to** : ARM and Data plane OpenAPI(swagger) specs -**Output Message**: Guid used in model definition '{1}' for property '{0}'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. +**Output Message**: Guid used in model definition '{1}' for property '{0}'. Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. **Description**: Verifies whether format is specified as "uuid" or not. @@ -678,7 +678,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Impact on generated code**: N/A. **Examples**: -``` +```json "schemes": [ "https" ] @@ -721,7 +721,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Examples**: **Bad Examples**: Following example contains 2 resource providers. **Microsoft.Compute** and **Microsoft.Network**. -``` +```json "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { "get": { @@ -791,7 +791,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Based on the value of the `readOnly` property, assign appropriate `x-ms-mutability` options. **Bad Example**: -``` +```json "prop0":{ "type": "string", "readOnly":true, @@ -799,7 +799,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` **Good Example**: -``` +```json "prop0":{ "type": "string", "readOnly": false, @@ -816,14 +816,14 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: Paths in x-ms-paths must overload a normal path in the paths section, i.e. a path in the x-ms-paths must either be same as a path in the paths section or a path in the paths sections followed by additional parameters. -**Description**: The `x-ms-paths` extension allows us to overload an existing path based on path parameters. We cannot specify an `x-ms-paths` without a path that already exists in the `paths` section. For more details about this extension please refere [here](https://github.com/Azure/azure-rest-api-specs/blob/dce4da0d748565efd2ab97a43d0683c2979a974a/documentation/swagger-extensions.md#x-ms-paths). +**Description**: The `x-ms-paths` extension allows us to overload an existing path based on path parameters. We cannot specify an `x-ms-paths` without a path that already exists in the `paths` section. For more details about this extension please refer [here](https://github.com/Azure/azure-rest-api-specs/blob/dce4da0d748565efd2ab97a43d0683c2979a974a/documentation/swagger-extensions.md#x-ms-paths). **Why the rule is important**: The `x-ms-paths` overload an existing path only, not adhering to this rule would violate the applicability of the extension itself. **How to fix the violation**: Ensure that the `x-ms-paths` is overloading an existing url path in the `paths` section. **Good Example**: -``` +```json "paths":{ "/foo":{ ... @@ -836,7 +836,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` **Bad Example**: -``` +```json "paths":{ "/foo":{ ... @@ -895,7 +895,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the default desired actually exists in the enums' list. **Bad Example**: -``` +```json "status":{ "type": "string", "enum": [ @@ -924,7 +924,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Add a non-empty `name` property to the parameter. **Good Example**: -``` +```json "MyParam":{ "name":"myParam", "type": "string", @@ -934,7 +934,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ``` **Bad Example**: -``` +```json "MyParam":{ "type": "string", "in": "path", @@ -976,7 +976,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: Only 1 underscore is permitted in the operation id, following Noun_Verb conventions. -**Description**: An operationId can have exaclty one underscore, not adhering to it can cause errors in code generation. +**Description**: An operationId can have exactly one underscore, not adhering to it can cause errors in code generation. **Why the rule is important**: Given an operationId of the form `Noun_Verb`, AutoRest breaks the operation id into its `Noun` and `Verb` where `Noun` becomes name of the operations class and the `Verb` becomes the name of the method in that class. Not adhering to this format can cause AutoRest to fail during code generation. @@ -1007,7 +1007,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Add an operations API endpoint (if not already present) and add details regarding this endpoint in the corresponding OpenAPI document. Examples can be found for most RPs in this repo. **Example**: A typical operations path would look like -``` +```json "/providers/Microsoft.ResourceProviderName/operations": { "get": { "tags": [ @@ -1039,7 +1039,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul } ``` A typical `OperationsList` and `Operation` model would look like -``` +```json "Operation": { "description": "REST API operation", @@ -1135,7 +1135,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Ensure that the given property is either marked as `readonly: true` or `required` but not both. **Bad Example**: -``` +```json "MyModel": { "properties":{ "MyProp":{ @@ -1174,7 +1174,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Description**: Only valid types are allowed for properties. -**Why the rule is important**: Invalid formats can cause errors during code generation or result in erraneous generated code. +**Why the rule is important**: Invalid formats can cause errors during code generation or result in erroneous generated code. **How to fix the violation**: Ensure format defined for property is valid. Please refer [here](https://github.com/Azure/autorest/blob/81d4d31d06637f4f9ef042d7f2ec64cfea29892f/docs/developer/validation-rules/valid-formats.md) for allowed types in OpenAPI. @@ -1238,7 +1238,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: A response for the 200 HTTP status code must be defined to use x-ms-pageable. -**Description**: Per definition of AutoRest [x-ms-pageable extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable), the response shema must contain a 200 response schema. +**Description**: Per definition of AutoRest [x-ms-pageable extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable), the response schema must contain a 200 response schema. **Why the rule is important**: Pageable operation needs to have a response schema to be used by the SDK to serialize/deserialize the result. @@ -1472,9 +1472,9 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: The enum types should have x-ms-enum type extension set with appropriate options. Property name: {0}. -**Description**: AutoRest defines [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) to provide more flexibily for enum types, please refer to the documentation. +**Description**: AutoRest defines [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) to provide more flexibility for enum types, please refer to the documentation. -**Why the rule is important**: Including [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) provides more flexibilty for enum types in SDK generated code. +**Why the rule is important**: Including [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) provides more flexibility for enum types in SDK generated code. **How to fix the violation**: Include the [x-ms-enum extension](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-enum) per indicated in its documentation. Consider setting "modelAsString": true, if you'd like the enum to be modeled as a string in generated SDKs, no enum validation will happen, though the values are exposed to the user for a better experience. @@ -1534,11 +1534,11 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message**: A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: '{0}' Request Model: '{1}' Response Model: '{2}' -**Description**: The request & reponse('200') schema of the PUT operation must be same. +**Description**: The request & response('200') schema of the PUT operation must be same. **Why the rule is important**: This will provide a consistent experience to the user, i.e. the user could use the same model object to perform various operations. Also, within the SDK, this will encourage reuse of the same model objects. -**How to fix the violation**: Ensure the request & reponse('200') schema of the PUT operation must be same. This might involve a service side change which will result cause a breaking change in the generated SDK. +**How to fix the violation**: Ensure the request & response('200') schema of the PUT operation must be same. This might involve a service side change which will result cause a breaking change in the generated SDK. Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) @@ -1703,7 +1703,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Why the rule is important**: Appropriate documentation could not be generated without the 'description'/'title' property. -**How to fix the violation**: For each definition, provide atleast one of the properties - description/title. +**How to fix the violation**: For each definition, provide at least one of the properties - description/title. Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) @@ -1718,7 +1718,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Why the rule is important**: Appropriate documentation could not be generated without the 'description'/'summary' property. -**How to fix the violation**: For each operation, provide atleast one of the property - description/summary. +**How to fix the violation**: For each operation, provide at least one of the property - description/summary. Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) @@ -1736,12 +1736,12 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **How to fix the violation**: Provide a short summary for the summary section and a detailed description for the description section. **Good Examples**: The following operation is a good example: -``` +```json ...... ...... "put": { - "summary": "Creates or Updates an availabilty set", - "description": "This operation creates or updates an availability set. This takes the resourceGroupName and availabiltySetName as input. If an availability set with the same name exists, then the same is updated. Else a new availabilty set is created.", + "summary": "Creates or Updates an availability set", + "description": "This operation creates or updates an availability set. This takes the resourceGroupName and availabilitySetName as input. If an availability set with the same name exists, then the same is updated. Else a new availability set is created.", ..... ..... } @@ -1750,12 +1750,12 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ``` **Bad Examples**: The following would be invalid: -``` +```json ...... ...... "put": { - "summary": "Creates or Updates an availabilty set", - "description": "Creates or Updates an availabilty set", + "summary": "Creates or Updates an availability set", + "description": "Creates or Updates an availability set", ..... ..... } @@ -1788,11 +1788,11 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message** : The parameter '{your parameter name}' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension "x-ms-parameter-location": "client". Else, apply the extension "x-ms-parameter-location": "method". -**Description** : SDKs generated by AutoRest have two types of operation parameters: method arguments and client fields. The `x-ms-parameter-location` extension gives the Swagger author control of how an operation-parameter will be interpreted by AutoRest, and as such is one of few things in a Swagger document that has semantic value only relvant to the shape of the generated SDKs. +**Description** : SDKs generated by AutoRest have two types of operation parameters: method arguments and client fields. The `x-ms-parameter-location` extension gives the Swagger author control of how an operation-parameter will be interpreted by AutoRest, and as such is one of few things in a Swagger document that has semantic value only relevant to the shape of the generated SDKs. Some parameters, such as API Version and Subscription ID will make sense as part of nearly every request. For these, having developers specify them for each method call would be burdensome; attaching them to the client and automatically including them in each request makes way more sense. Other parameters will be very operation specific and should be provided each time the method is called. -**Why this rule is important**: Without providing the parameter-location, constructor parameter lists end up incorporating entries that are only relevant to one of the methods that belong to a type. Needlees to say, this can spiral out of control and turn your SDKs into gunk. +**Why this rule is important**: Without providing the parameter-location, constructor parameter lists end up incorporating entries that are only relevant to one of the methods that belong to a type. Needless to say, this can spiral out of control and turn your SDKs into gunk. **How to fix the violation**: For each parameter in the document-level "parameters" section of your document provide either: ``` json diff --git a/documentation/swagger-authoring-descriptions.md b/documentation/swagger-authoring-descriptions.md index daf1cb8a79ca..7334bc42940a 100644 --- a/documentation/swagger-authoring-descriptions.md +++ b/documentation/swagger-authoring-descriptions.md @@ -20,7 +20,7 @@ Therefore, take the time to craft your descriptions well! This doc provides some - [Arjun Swagger Viewer](https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer) is another Swagger preview extension, but has less validation warnings. - [OpenAPI Linting Extension](https://github.com/Azure/openapi-lint-extension#preview) can be used to check your Swagger for common mistakes. -3. Treat these descriptions like the rest of your code. Plan to have them throughly reviewed, either by a content developer or an engineering team member with English language writing experience. CodeFlow and the CodeFlow GitHub Chrome extension are a great way to do this. +3. Treat these descriptions like the rest of your code. Plan to have them thoroughly reviewed, either by a content developer or an engineering team member with English language writing experience. CodeFlow and the CodeFlow GitHub Chrome extension are a great way to do this. ## Basic rules for public docs (descriptions) @@ -47,7 +47,7 @@ Below is a list of common expectations for published description strings that yo 1. Right now, description strings are very limited in their expressiveness. The Open Publishing (OP) DocFX tool does not currently support the rendering of GFM syntax, nor does it support any documentation-friendly vendor extensions at this time. (This will change.) If you need more expressive formatting, contact a content developer for the CSI org and ask them to create overwrite files for the REST API reference page and the similar client SDK pages (for Java, .NET, and Azure CLI 2.0). -2. Some level of redundancy is good! For example, if you have an operation "GET /notes/latest", it's okay to have a description "Gets the latest notes." and to leave it at that. While any dev worth her salt can look at the operation and the path and come to the same conclusion, this adds a level of scanability to the page -- especially for newer developers, their eyes will go to the prose before attempting to parse the API syntax. Also, an empty operation description on a doc page makes it look like we don't care and that the docs are autogenerated from sources without any respect for the human beings that might read them. +2. Some level of redundancy is good! For example, if you have an operation `GET /notes/latest`, it's okay to have a description "Gets the latest notes." and to leave it at that. While any dev worth her salt can look at the operation and the path and come to the same conclusion, this adds a level of scanability to the page -- especially for newer developers, their eyes will go to the prose before attempting to parse the API syntax. Also, an empty operation description on a doc page makes it look like we don't care and that the docs are autogenerated from sources without any respect for the human beings that might read them. 3. Need to provide more detail for a critical or complex API? Contact your content developer in CSI, and we can create an "overwrite" Markdown file that adds remarks, code samples, and formatted descriptions for your published API doc. We won't do this for every API, but we're also aware that there are some serious limitations with our early tools and approach -- and that some APIs are more equal than others. diff --git a/documentation/swagger-checklist.md b/documentation/swagger-checklist.md index f054457091a2..05933d96b41b 100644 --- a/documentation/swagger-checklist.md +++ b/documentation/swagger-checklist.md @@ -12,7 +12,7 @@ This checklist is a current snapshot of requirements for developing Swagger spec Today, there are tools available for validating a sizable portion of this checklist. Please install these tools on your development machine and use them to validate your Swaggers as you build them. -- [AutoRest OpenAPI Validator](https://github.com/Azure/autorest/blob/master/docs/user/cli.md#validation) – The OpenAPI validator (activated with `--azure-validator`) statically analyzes a Swagger for errors and violations of requirements outlined in the automated rules checklist. The validator should be run when Swaggers are created or updated. It will be continously updated to validate newer requirements. +- [AutoRest OpenAPI Validator](https://github.com/Azure/autorest/blob/master/docs/user/cli.md#validation) – The OpenAPI validator (activated with `--azure-validator`) statically analyzes a Swagger for errors and violations of requirements outlined in the automated rules checklist. The validator should be run when Swaggers are created or updated. It will be continuously updated to validate newer requirements. **NOTE**: This checkmark ( :white_check_mark: ) indicates that rule is covered by AutoRest validation tool. - [Swagger Model Validator](https://github.com/Azure/openapi-validation-tools) - Model Validator validates models defined for body parameters and responses, and matches them against the expected input and output of an operation. To make this real, test examples are required to be specified in a Swagger for every operation defined in a Swagger. Test examples are integrated into a Swagger using the ["x-ms-examples"](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/x-ms-examples.md) extension, which will be used to test against the defined models. Sample test examples for this extension can be found in the [Redis Cache Swagger](https://github.com/Azure/azure-rest-api-specs/blob/master/arm-redis/2016-04-01/swagger/redis.json ). diff --git a/documentation/x-ms-examples.md b/documentation/x-ms-examples.md index 9f6b88ff4cf1..16584d474363 100644 --- a/documentation/x-ms-examples.md +++ b/documentation/x-ms-examples.md @@ -23,7 +23,7 @@ Field Pattern | Type | Description **_shortcomings/concerns_**: What if the service team wants to show different examples. Scenario: GET on NetworkInterface with $expand and without $expand will have an impact on the NetworkSecurityGroup property of the NIC. In the former it will be a full blown NSG and in the latter it will be a Subresource(object with one property 'id')? - - _**For any model definition**_ (body parameter is a model definition; example: StorageAccountCreateParameters), [swagger specfication says](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields-13): + - _**For any model definition**_ (body parameter is a model definition; example: StorageAccountCreateParameters), [swagger specification says](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields-13): Field Name | Type | Description ---|:---:|--- @@ -88,7 +88,7 @@ _This will keep the spec cleaner and easy to manage._ }, "responses": { //Provide examples of the response headers and body per status code (as per the operation defined in the swagger spec) as applicable. "statusCode1": { - "headers": { ... }, //Examples for location, azure-asyncoperation, retry-after response headers for long running (asynchronous) operations would be valueable + "headers": { ... }, //Examples for location, azure-asyncoperation, retry-after response headers for long running (asynchronous) operations would be valuable "body": { ... } }, "statuscode2": { ... } From 24ab24bdc72cb5f0e7c6b9bdb3e54462983c79c3 Mon Sep 17 00:00:00 2001 From: QingqingYuan2 <43078227+QingqingYuan2@users.noreply.github.com> Date: Mon, 26 Nov 2018 13:38:23 -0800 Subject: [PATCH 197/464] Deprecate old version of RDBMS (#4526) * Deprecate pre-GA APIs * update readme files --- .../examples/CheckNameAvailability.json | 19 - .../examples/ConfigurationCreateOrUpdate.json | 33 - .../examples/ConfigurationGet.json | 26 - .../examples/ConfigurationListByServer.json | 276 --- .../examples/DatabaseCreate.json | 40 - .../examples/DatabaseDelete.json | 14 - .../examples/DatabaseGet.json | 22 - .../examples/DatabaseListByServer.json | 34 - .../examples/FirewallRuleCreate.json | 40 - .../examples/FirewallRuleDelete.json | 14 - .../examples/FirewallRuleGet.json | 22 - .../examples/FirewallRuleListByServer.json | 34 - .../examples/LogFileListByServer.json | 42 - .../examples/OperationList.json | 185 -- .../examples/PerformanceTiersList.json | 62 - .../PerformanceTiersListByLocation.json | 63 - .../examples/ServerCreate.json | 75 - .../examples/ServerDelete.json | 13 - .../examples/ServerGet.json | 33 - .../examples/ServerList.json | 77 - .../examples/ServerListByResourceGroup.json | 57 - .../examples/ServerUpdate.json | 40 - .../preview/2017-04-30-preview/mysql.json | 1659 ----------------- .../mysql/resource-manager/readme.go.md | 9 - .../mysql/resource-manager/readme.md | 10 - .../examples/CheckNameAvailability.json | 19 - .../examples/ConfigurationCreateOrUpdate.json | 33 - .../examples/ConfigurationGet.json | 26 - .../examples/ConfigurationListByServer.json | 1056 ----------- .../examples/DatabaseCreate.json | 40 - .../examples/DatabaseDelete.json | 14 - .../examples/DatabaseGet.json | 22 - .../examples/DatabaseListByServer.json | 34 - .../examples/FirewallRuleCreate.json | 40 - .../examples/FirewallRuleDelete.json | 14 - .../examples/FirewallRuleGet.json | 22 - .../examples/FirewallRuleListByServer.json | 34 - .../examples/LogFileListByServer.json | 42 - .../examples/OperationList.json | 194 -- .../examples/PerformanceTiersList.json | 62 - .../PerformanceTiersListByLocation.json | 63 - .../examples/ServerCreate.json | 75 - .../examples/ServerDelete.json | 13 - .../examples/ServerGet.json | 33 - .../examples/ServerList.json | 77 - .../examples/ServerListByResourceGroup.json | 57 - .../examples/ServerUpdate.json | 40 - .../2017-04-30-preview/postgresql.json | 1658 ---------------- .../postgresql/resource-manager/readme.go.md | 9 - .../postgresql/resource-manager/readme.md | 10 - 50 files changed, 6586 deletions(-) delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationGet.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseCreate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseDelete.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseGet.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/LogFileListByServer.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/OperationList.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerDelete.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json delete mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/mysql.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationGet.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseCreate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseDelete.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseGet.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/LogFileListByServer.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/OperationList.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerDelete.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json delete mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/postgresql.json diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json deleted file mode 100644 index 57b9438f93ed..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "nameAvailabilityRequest": { - "name": "name1", - "type": "Microsoft.DBforMySQL" - } - }, - "responses": { - "200": { - "body": { - "nameAvailable": true, - "message": "", - "reason": "" - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json deleted file mode 100644 index d6d44aff8c30..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "configurationName": "event_scheduler", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "value": "ON", - "source": "user-override" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "value": "ON", - "description": "Indicates the status of the Event Scheduler.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF,DISABLED", - "source": "user-override" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/event_scheduler", - "name": "event_scheduler", - "type": "Microsoft.DBforMySQL/servers/configurations" - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationGet.json deleted file mode 100644 index 28cd43dc862c..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "configurationName": "event_scheduler", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "properties": { - "value": "OFF", - "description": "Indicates the status of the Event Scheduler.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF,DISABLED", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/event_scheduler", - "name": "event_scheduler", - "type": "Microsoft.DBforMySQL/servers/configurations" - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json deleted file mode 100644 index 275bb1cce4b4..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json +++ /dev/null @@ -1,276 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "value": "OFF", - "description": "Indicates the status of the Event Scheduler.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF,DISABLED", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/event_scheduler", - "name": "event_scheduler", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "4", - "description": "Number of digits by which to increase the scale of the result of division operations.", - "defaultValue": "4", - "dataType": "Integer", - "allowedValues": "0-30", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/div_precision_increment", - "name": "div_precision_increment", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "1024", - "description": "Maximum allowed result length in bytes for the GROUP_CONCAT().", - "defaultValue": "1024", - "dataType": "Integer", - "allowedValues": "4-16777216", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/group_concat_max_len", - "name": "group_concat_max_len", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "ON", - "description": "Whether innodb adaptive hash indexes are enabled or disabled.", - "defaultValue": "ON", - "dataType": "Enumeration", - "allowedValues": "ON,OFF", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/innodb_adaptive_hash_index", - "name": "innodb_adaptive_hash_index", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "50", - "description": "The length of time in seconds an InnoDB transaction waits for a row lock before giving up.", - "defaultValue": "50", - "dataType": "Integer", - "allowedValues": "1-3600", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/innodb_lock_wait_timeout", - "name": "innodb_lock_wait_timeout", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "1800", - "description": "Number of seconds the server waits for activity on an interactive connection before closing it.", - "defaultValue": "1800", - "dataType": "Integer", - "allowedValues": "10-1800", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/interactive_timeout", - "name": "interactive_timeout", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "OFF", - "description": "Logs queries that are expected to retrieve all rows to slow query log.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/log_queries_not_using_indexes", - "name": "log_queries_not_using_indexes", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "0", - "description": "Limits the number of such queries per minute that can be written to the slow query log.", - "defaultValue": "0", - "dataType": "Integer", - "allowedValues": "0-4294967295", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/log_throttle_queries_not_using_indexes", - "name": "log_throttle_queries_not_using_indexes", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "OFF", - "description": "Include slow administrative statements in the statements written to the slow query log.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/log_slow_admin_statements", - "name": "log_slow_admin_statements", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "OFF", - "description": "This variable applies when binary logging is enabled. It controls whether stored function creators can be trusted not to create stored functions that will cause unsafe events to be written to the binary log.", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF,FALSE", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/log_bin_trust_function_creators", - "name": "log_bin_trust_function_creators", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "10", - "description": "If a query takes longer than this many seconds, the server increments the Slow_queries status variable.", - "defaultValue": "10", - "dataType": "Numeric", - "allowedValues": "1-1E+100", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/long_query_time", - "name": "long_query_time", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "0", - "description": "Can be used to cause queries which examine fewer than the stated number of rows not to be logged.", - "defaultValue": "0", - "dataType": "Integer", - "allowedValues": "0-18446744073709551615", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/min_examined_row_limit", - "name": "min_examined_row_limit", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "OFF", - "description": "Enable or disable the slow query log", - "defaultValue": "OFF", - "dataType": "Enumeration", - "allowedValues": "ON,OFF", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/slow_query_log", - "name": "slow_query_log", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "", - "description": "The current server SQL mode.", - "defaultValue": "", - "dataType": "Set", - "allowedValues": ",ALLOW_INVALID_DATES,ANSI_QUOTES,ERROR_FOR_DIVISION_BY_ZERO,HIGH_NOT_PRECEDENCE,IGNORE_SPACE,NO_AUTO_CREATE_USER,NO_AUTO_VALUE_ON_ZERO,NO_BACKSLASH_ESCAPES,NO_DIR_IN_CREATE,NO_ENGINE_SUBSTITUTION,NO_FIELD_OPTIONS,NO_KEY_OPTIONS,NO_TABLE_OPTIONS,NO_UNSIGNED_SUBTRACTION,NO_ZERO_DATE,NO_ZERO_IN_DATE,ONLY_FULL_GROUP_BY,PAD_CHAR_TO_FULL_LENGTH,PIPES_AS_CONCAT,REAL_AS_FLOAT,STRICT_ALL_TABLES,STRICT_TRANS_TABLES", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/sql_mode", - "name": "sql_mode", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "120", - "description": "The number of seconds the server waits for activity on a noninteractive connection before closing it.", - "defaultValue": "120", - "dataType": "Integer", - "allowedValues": "60-240", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/wait_timeout", - "name": "wait_timeout", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "1129667931", - "description": "The server ID, used in replication to give each master and slave a unique identity.", - "defaultValue": "1000", - "dataType": "Integer", - "allowedValues": "1000-4294967295", - "source": "user-override" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/server_id", - "name": "server_id", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "536870912", - "description": "The maximum size of one packet or any generated/intermediate string, or any parameter sent by the mysql_stmt_send_long_data() C API function.", - "defaultValue": "536870912", - "dataType": "Integer", - "allowedValues": "1024-1073741824", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/max_allowed_packet", - "name": "max_allowed_packet", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "60", - "description": "The number of seconds to wait for more data from the master before the slave considers the connection broken, aborts the read, and tries to reconnect.", - "defaultValue": "60", - "dataType": "Integer", - "allowedValues": "30-3600", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/slave_net_timeout", - "name": "slave_net_timeout", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "SYSTEM", - "description": "The server time zone", - "defaultValue": "SYSTEM", - "dataType": "String", - "allowedValues": "[+|-][0]{0,1}[0-9]:[0-5][0-9]|[+|-][1][0-2]:[0-5][0-9]|SYSTEM", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/time_zone", - "name": "time_zone", - "type": "Microsoft.DBforMySQL/servers/configurations" - }, - { - "properties": { - "value": "latin1", - "description": "Use charset_name as the default server character set.", - "defaultValue": "latin1", - "dataType": "Enumeration", - "allowedValues": "BIG5,DEC8,CP850,HP8,KOI8R,LATIN1,LATIN2,SWE7,ASCII,UJIS,SJIS,HEBREW,TIS620,EUCKR,KOI8U,GB2312,GREEK,CP1250,GBK,LATIN5,ARMSCII8,UTF8,UCS2,CP866,KEYBCS2,MACCE,MACROMAN,CP852,LATIN7,UTF8MB4,CP1251,UTF16,CP1256,CP1257,UTF32,BINARY,GEOSTD8,CP932,EUCJPMS", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/configurations/character_set_server", - "name": "character_set_server", - "type": "Microsoft.DBforMySQL/servers/configurations" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseCreate.json deleted file mode 100644 index 3b2601ec7762..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseCreate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "charset":"utf8", - "collation":"utf8_general_ci" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforMySQL/servers/databases", - "properties": { - "charset": "utf8", - "collation": "utf8_general_ci" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforMySQL/servers/databases", - "properties": { - "charset": "utf8", - "collation": "utf8_general_ci" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseDelete.json deleted file mode 100644 index 600a8fd87165..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseGet.json deleted file mode 100644 index cb7cf4e9e0bc..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforMySQL/servers/databases", - "properties": { - "charset": "utf8", - "collation": "utf8_general_ci" - } - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json deleted file mode 100644 index 8de5b643abed..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforMySQL/servers/databases", - "properties": { - "charset": "utf8", - "collation": "utf8_general_ci" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/databases/db2", - "name": "db2", - "type": "Microsoft.DBforMySQL/servers/databases", - "properties": { - "charset": "utf8", - "collation": "utf8_general_ci" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json deleted file mode 100644 index 0fd24aeca93c..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "startIpAddress":"0.0.0.0", - "endIpAddress":"255.255.255.255" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforMySQL/servers/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.DBforMySQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforMySQL/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json deleted file mode 100644 index 7dde700aa259..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json deleted file mode 100644 index 81b79fac78fd..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforMySQL/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json deleted file mode 100644 index e3626d5616a4..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforMySQL/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/firewallRules/rule2", - "name": "rule2", - "type": "Microsoft.DBforMySQL/servers/firewallRules", - "properties": { - "startIpAddress": "1.0.0.0", - "endIpAddress": "255.0.0.0" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/LogFileListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/LogFileListByServer.json deleted file mode 100644 index e6b662e34a16..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/LogFileListByServer.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "name": "mysql-slow-testserver-2017042102.log", - "sizeInKB": 1, - "createdTime": "0001-01-01T00:00:00+00:00", - "lastModifiedTime": "2017-04-21T03:02:23+00:00", - "type": "slowlog", - "url": "https://wasd2orcasseas1aelsfse0.file.core.windows.net/52bd047495b3459b95185a1738cbaeac/serverlogs/mysql-slow-testserver-2017042102.log?sv=2015-04-05&sr=f&sig=zt6C6CBMygNbwzbDw5qcU%2F3duOgP9ZERQ8aWJr7fnuM%3D&se=2017-04-21T04%3A02%3A33Z&sp=r" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/logFiles/mysql-slow-testserver-2017042102.log", - "name": "mysql-slow-testserver-2017042102.log", - "type": "Microsoft.DBforMySQL/servers/logFiles" - }, - { - "properties": { - "name": "mysql-slow-testserver-2017042202.log", - "sizeInKB": 1, - "createdTime": "0001-01-01T00:00:00+00:00", - "lastModifiedTime": "2017-04-22T03:02:23+00:00", - "type": "slowlog", - "url": "https://wasd2orcasseas1aelsfse0.file.core.windows.net/52bd047495b3459b95185a1738cbaeac/serverlogs/mysql-slow-testserver-2017042202.log?sv=2015-04-05&sr=f&sig=zt6C6CBMygNbwzbDw5qcU%2F3duOgP9ZERQ8aWJr7fnuM%3D&se=2017-04-22T04%3A02%3A33Z&sp=r" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver/logFiles/mysql-slow-testserver-2017042202.log", - "name": "mysql-slow-testserver-2017042202.log", - "type": "Microsoft.DBforMySQL/servers/logFiles" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/OperationList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/OperationList.json deleted file mode 100644 index a3346c8be6dc..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/OperationList.json +++ /dev/null @@ -1,185 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DBforMySQL/servers/firewallRules/read", - "display": { - "provider": "Microsoft DB for MySQL", - "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.DBforMySQL/servers/firewallRules/write", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "Firewall Rules", - "operation": "Create/Update Firewall Rule", - "description": "Creates a firewall rule with the specified parameters or update an existing rule." - } - }, - { - "name": "Microsoft.DBforMySQL/servers/firewallRules/delete", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "Firewall Rules", - "operation": "Delete Firewall Rule", - "description": "Deletes an existing firewall rule." - } - }, - { - "name": "Microsoft.DBforMySQL/servers/read", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "MySQL Server", - "operation": "List/Get MySQL Servers", - "description": "Return the list of servers or gets the properties for the specified server." - } - }, - { - "name": "Microsoft.DBforMySQL/servers/write", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "MySQL Server", - "operation": "Create/Update MySQL Server", - "description": "Creates a server with the specified parameters or update the properties or tags for the specified server." - } - }, - { - "name": "Microsoft.DBforMySQL/servers/delete", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "MySQL Server", - "operation": "Delete MySQL Server", - "description": "Deletes an existing server." - } - }, - { - "name": "Microsoft.DBforMySQL/performanceTiers/read", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "Performance Tiers", - "operation": "List Performance Tiers", - "description": "Returns the list of Performance Tiers available." - } - }, - { - "name": "Microsoft.DBforMySQL/servers/providers/Microsoft.Insights/metricDefinitions/read", - "display": { - "provider": "Microsoft DB for MySQL", - "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 limit", - "displayDescription": "Compute limit", - "unit": "Count", - "aggregationType": "Average" - }, - { - "name": "compute_consumption_percent", - "displayName": "Compute percentage", - "displayDescription": "Compute 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.DBforMySQL/servers/providers/Microsoft.Insights/diagnosticSettings/read", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "Database Metric Definition", - "operation": "Read diagnostic setting", - "description": "Gets the disagnostic setting for the resource" - } - }, - { - "name": "Microsoft.DBforMySQL/servers/providers/Microsoft.Insights/diagnosticSettings/write", - "display": { - "provider": "Microsoft DB for MySQL", - "resource": "Database Metric Definition", - "operation": "Write diagnostic setting", - "description": "Creates or updates the diagnostic setting for the resource" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json deleted file mode 100644 index 463ea5f6c716..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "Basic", - "backupRetentionDays": 7, - "serviceLevelObjectives": [ - { - "edition": "Basic", - "dtu": 50, - "storageMB": 51200, - "id": "MYSQLB50" - }, - { - "edition": "Basic", - "dtu": 100, - "storageMB": 51200, - "id": "MYSQLB100" - } - ] - }, - { - "id": "Standard", - "backupRetentionDays": 35, - "serviceLevelObjectives": [ - { - "edition": "Standard", - "dtu": 100, - "storageMB": 128000, - "id": "MYSQLS100" - }, - { - "edition": "Standard", - "dtu": 200, - "storageMB": 128000, - "id": "MYSQLS200" - }, - { - "edition": "Standard", - "dtu": 400, - "storageMB": 128000, - "id": "MYSQLS400" - }, - { - "edition": "Standard", - "dtu": 800, - "storageMB": 128000, - "id": "MYSQLS800" - } - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json deleted file mode 100644 index 4025aa45560f..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "locationName": "WestUS" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "Basic", - "backupRetentionDays": 7, - "serviceLevelObjectives": [ - { - "edition": "Basic", - "dtu": 50, - "storageMB": 51200, - "id": "MYSQLB50" - }, - { - "edition": "Basic", - "dtu": 100, - "storageMB": 51200, - "id": "MYSQLB100" - } - ] - }, - { - "id": "Standard", - "backupRetentionDays": 35, - "serviceLevelObjectives": [ - { - "edition": "Standard", - "dtu": 100, - "storageMB": 128000, - "id": "MYSQLS100" - }, - { - "edition": "Standard", - "dtu": 200, - "storageMB": 128000, - "id": "MYSQLS200" - }, - { - "edition": "Standard", - "dtu": 400, - "storageMB": 128000, - "id": "MYSQLS400" - }, - { - "edition": "Standard", - "dtu": 800, - "storageMB": 128000, - "id": "MYSQLS800" - } - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json deleted file mode 100644 index 76ec59d78b80..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerCreate.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "location": "eastus", - "properties": { - "administratorLogin": "cloudsa", - "administratorLoginPassword": "password", - "storageMB": 1024, - "sslEnforcement": "Enabled", - "createMode": "Default" - }, - "sku": { - "name": "SkuName", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "ElasticServer": "1" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerDelete.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerDelete.json deleted file mode 100644 index 50b9770f2180..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json deleted file mode 100644 index 79f41a88dfca..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerGet.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json deleted file mode 100644 index 03c1712c3de6..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerList.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/serv1", - "name": "serv1", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv1.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforMySQL/servers/serv2", - "name": "serv2", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv2.test-vm1.onebox.xdb.mscds.com" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json deleted file mode 100644 index d826e30ce245..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/serv1", - "name": "serv1", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv1.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json deleted file mode 100644 index b212155df693..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/examples/ServerUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "administratorLoginPassword":"newpassword", - "sslEnforcement": "Disabled" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforMySQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforMySQL/servers", - "location": "eastus", - "sku": { - "name": "MYSQLS3M100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement": "Disabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/mysql.json deleted file mode 100644 index cd942742a90d..000000000000 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-04-30-preview/mysql.json +++ /dev/null @@ -1,1659 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "MySQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, log files and configurations.", - "version": "2017-04-30-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}": { - "put": { - "tags": [ - "Servers" - ], - "operationId": "Servers_CreateOrUpdate", - "x-ms-examples": { - "ServerCreate": { "$ref": "./examples/ServerCreate.json" } - }, - "description": "Creates a new server or updates an existing server. The update action will overwrite the existing server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerForCreate" - }, - "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" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Servers" - ], - "operationId": "Servers_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": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerUpdateParameters" - }, - "description": "The required parameters for updating a server." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Server" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Servers" - ], - "operationId": "Servers_Delete", - "x-ms-examples": { - "ServerDelete": { "$ref": "./examples/ServerDelete.json" } - }, - "description": "Deletes a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_Get", - "x-ms-examples": { - "ServerGet": { "$ref": "./examples/ServerGet.json" } - }, - "description": "Gets information about a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Server" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers": { - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_ListByResourceGroup", - "x-ms-examples": { - "ServerListByResourceGroup": { "$ref": "./examples/ServerListByResourceGroup.json" } - }, - "description": "List all the servers in a given resource group.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/servers": { - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_List", - "x-ms-examples": { - "ServerList": { "$ref": "./examples/ServerList.json" } - }, - "description": "List all the servers in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules/{firewallRuleName}": { - "put": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_CreateOrUpdate", - "x-ms-examples": { - "FirewallRuleCreate": { "$ref": "./examples/FirewallRuleCreate.json" } - }, - "description": "Creates a new firewall rule or updates an existing firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$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" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_Delete", - "x-ms-examples": { - "FirewallRuleDelete": { "$ref": "./examples/FirewallRuleDelete.json" } - }, - "description": "Deletes a server firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/FirewallRuleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_Get", - "x-ms-examples": { - "FirewallRuleGet": { "$ref": "./examples/FirewallRuleGet.json" } - }, - "description": "Gets information about a server firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/FirewallRuleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FirewallRule" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/firewallRules": { - "get": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_ListByServer", - "x-ms-examples": { - "FirewallRuleList": { "$ref": "./examples/FirewallRuleListByServer.json" } - }, - "description": "List all the firewall rules in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FirewallRuleListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { - "put": { - "tags": [ - "Databases" - ], - "operationId": "Databases_CreateOrUpdate", - "x-ms-examples": { - "DatabaseCreate": { "$ref": "./examples/DatabaseCreate.json" } - }, - "description": "Creates a new database or updates an existing database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Database" - }, - "description": "The required parameters for creating or updating a database." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Database" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Database" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Databases" - ], - "operationId": "Databases_Delete", - "x-ms-examples": { - "DatabaseDelete": { "$ref": "./examples/DatabaseDelete.json" } - }, - "description": "Deletes a database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Databases" - ], - "operationId": "Databases_Get", - "x-ms-examples": { - "DatabaseGet": { "$ref": "./examples/DatabaseGet.json" } - }, - "description": "Gets information about a database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Database" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases": { - "get": { - "tags": [ - "Databases" - ], - "operationId": "Databases_ListByServer", - "x-ms-examples": { - "DatabaseList": { "$ref": "./examples/DatabaseListByServer.json" } - }, - "description": "List all the databases in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DatabaseListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations/{configurationName}": { - "put": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_CreateOrUpdate", - "x-ms-examples": { - "ConfigurationCreateOrUpdate": { "$ref": "./examples/ConfigurationCreateOrUpdate.json" } - }, - "description": "Updates a configuration of a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Configuration" - }, - "description": "The required parameters for updating a server configuration." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Configuration" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Get", - "x-ms-examples": { - "ConfigurationGet": { "$ref": "./examples/ConfigurationGet.json" } - }, - "description": "Gets information about a configuration of server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Configuration" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/configurations": { - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_ListByServer", - "x-ms-examples": { - "ConfigurationList": { "$ref": "./examples/ConfigurationListByServer.json" } - }, - "description": "List all the configurations in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/logFiles": { - "get": { - "tags": [ - "LogFiles" - ], - "operationId": "LogFiles_ListByServer", - "x-ms-examples": { - "LogFileList": { "$ref": "./examples/LogFileListByServer.json" } - }, - "description": "List all the log files in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/LogFileListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/performanceTiers": { - "get": { - "tags": [ - "PerformanceTiers" - ], - "operationId": "PerformanceTiers_List", - "x-ms-examples": { - "PerformanceTiersList": { - "$ref": "./examples/PerformanceTiersList.json" - } - }, - "description": "List all the performance tiers in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PerformanceTierListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/locations/{locationName}/performanceTiers": { - "get": { - "tags": [ - "LocationBasedPerformanceTier" - ], - "operationId": "LocationBasedPerformanceTier_List", - "x-ms-examples": { - "PerformanceTiersList": { - "$ref": "./examples/PerformanceTiersListByLocation.json" - } - }, - "description": "List all the performance tiers at specified location in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LocationNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PerformanceTierListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforMySQL/checkNameAvailability": { - "post": { - "tags": [ - "CheckNameAvailability" - ], - "operationId": "CheckNameAvailability_Execute", - "x-ms-examples": { - "NameAvailability": { "$ref": "./examples/CheckNameAvailability.json" } - }, - "description": "Check the availability of name for resource", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/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" - } - } - } - } - }, - "/providers/Microsoft.DBforMySQL/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": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - } - } - } - }, - "definitions": { - "ServerVersion": { - "type": "string", - "description": "The version of a server.", - "enum": [ - "5.6", - "5.7" - ], - "x-ms-enum": { - "name": "ServerVersion", - "modelAsString": true - } - }, - "SslEnforcement": { - "type": "string", - "description": "Enable ssl enforcement or not when connect to server.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "SslEnforcementEnum", - "modelAsString": false - } - }, - "ProxyResource": { - "description": "Resource properties.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, - "ServerProperties": { - "properties": { - "administratorLogin": { - "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)." - }, - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The maximum storage allowed for a server." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "Server version." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - }, - "userVisibleState": { - "type": "string", - "description": "A state of a server that is visible to user.", - "enum": [ - "Ready", - "Dropping", - "Disabled" - ], - "x-ms-enum": { - "name": "ServerState", - "modelAsString": true - } - }, - "fullyQualifiedDomainName": { - "type": "string", - "description": "The fully qualified domain name of a server." - } - }, - "description": "The properties of a server." - }, - "ServerPropertiesForCreate": { - "discriminator": "createMode", - "required": [ "createMode" ], - "properties": { - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The maximum storage allowed for a server." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "Server version." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - }, - "createMode": { - "type": "string", - "description": "The mode to create a new server.", - "enum": [ - "Default", - "PointInTimeRestore" - ], - "x-ms-enum": { - "name": "CreateMode", - "modelAsString": true - } - } - }, - "description": "The properties used to create a new server." - }, - "ServerPropertiesForDefaultCreate": { - "x-ms-discriminator-value": "Default", - "allOf": [ - { - "$ref": "#/definitions/ServerPropertiesForCreate" - } - ], - "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)." - }, - "administratorLoginPassword": { - "type": "string", - "format": "password", - "description": "The password of the administrator login." - } - }, - "required": [ - "administratorLogin", - "administratorLoginPassword" - ], - "description": "The properties used to create a new server." - }, - "ServerPropertiesForRestore": { - "x-ms-discriminator-value": "PointInTimeRestore", - "allOf": [ - { - "$ref": "#/definitions/ServerPropertiesForCreate" - } - ], - "properties": { - "sourceServerId": { - "type": "string", - "description": "The source server id to restore from." - }, - "restorePointInTime": { - "type": "string", - "format": "date-time", - "description": "Restore point creation time (ISO8601 format), specifying the time to restore from." - } - }, - "required": [ - "sourceServerId", - "restorePointInTime" - ], - "description": "The properties to a new server by restoring from a backup." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "The name of the sku, typically, a letter + Number code, e.g. P3." - }, - "tier": { - "type": "string", - "description": "The tier of the particular SKU, e.g. Basic.", - "enum": [ - "Basic", - "Standard" - ], - "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." - }, - "size": { - "type": "string", - "description": "The size code, to be interpreted by resource as appropriate." - }, - "family": { - "type": "string", - "description": "The family of hardware." - } - }, - "description": "Billing information related properties of a server." - }, - "Server": { - "properties": { - "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": "#/definitions/TrackedResource" - } - ], - "description": "Represents a server." - }, - "ServerForCreate": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." - }, - "properties": { - "$ref": "#/definitions/ServerPropertiesForCreate", - "x-ms-client-flatten": false, - "description": "Properties of the server." - }, - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "required": [ - "properties", - "location" - ], - "description": "Represents a server to be created." - }, - "ServerUpdateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." - }, - "properties": { - "properties": { - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The max storage allowed for a server." - }, - "administratorLoginPassword": { - "type": "string", - "format": "password", - "description": "The password of the administrator login." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "The version of a server." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - } - }, - "x-ms-client-flatten": true, - "description": "The properties that can be updated for a server." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "description": "Parameters allowd to update for a server." - }, - "ServerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Server" - }, - "description": "The list of servers" - } - }, - "description": "A list of servers." - }, - "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": "#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "description": "Represents a server firewall rule." - }, - "FirewallRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "description": "The list of firewall rules in a server." - } - }, - "description": "A list of firewall rules." - }, - "DatabaseProperties": { - "properties": { - "charset": { - "type": "string", - "description": "The charset of the database." - }, - "collation": { - "type": "string", - "description": "The collation of the database." - } - }, - "description": "The properties of a database." - }, - "Database": { - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseProperties", - "x-ms-client-flatten": true, - "description": "The properties of a database." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Represents a Database." - }, - "DatabaseListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Database" - }, - "description": "The list of databases housed in a server" - } - }, - "description": "A List of databases." - }, - "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." - }, - "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": "#/definitions/ProxyResource" - } - ], - "description": "Represents a Configuration." - }, - "ConfigurationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Configuration" - }, - "description": "The list of server configurations." - } - }, - "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." - }, - "LogFileProperties": { - "properties": { - "name": { - "type": "string", - "description": "Log file name." - }, - "sizeInKB": { - "type": "integer", - "format": "int64", - "description": "Size of the log file." - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp of the log file." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Last modified timestamp of the log file." - }, - "type": { - "type": "string", - "description": "Type of the log file." - }, - "url": { - "type": "string", - "description": "The url to download the log file from." - } - }, - "description": "The properties of a log file." - }, - "LogFile": { - "properties": { - "name": { - "type": "string", - "description": "The name of the log file." - }, - "properties": { - "$ref": "#/definitions/LogFileProperties", - "x-ms-client-flatten": true, - "description": "The properties of the log file." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Represents a log file." - }, - "LogFileListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/LogFile" - }, - "description": "The list of log files." - } - }, - "description": "A list of log files." - }, - "PerformanceTierServiceLevelObjectives": { - "properties": { - "id": { - "type": "string", - "description": "ID for the service level objective." - }, - "edition": { - "type": "string", - "description": "Edition of the performance tier." - }, - "dtu": { - "type": "integer", - "description": "Database throughput unit associated with the service level objective" - }, - "storageMB": { - "type": "integer", - "description": "Maximum storage in MB associated with the service level objective" - } - }, - "description": "Service level objectives for performance tier." - }, - "PerformanceTierProperties": { - "properties": { - "id": { - "type": "string", - "description": "ID of the performance tier." - }, - "backupRetentionDays": { - "type": "integer", - "description": "Backup retention in days for the performance tier edition" - }, - "serviceLevelObjectives": { - "type": "array", - "items": { - "$ref": "#/definitions/PerformanceTierServiceLevelObjectives" - }, - "description": "Service level objectives associated with the performance tier" - } - }, - "description": "Performance tier properties" - }, - "PerformanceTierListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PerformanceTierProperties" - }, - "description": "The list of performance tiers" - } - }, - "description": "A list of performance tiers." - }, - "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." - }, - "reason": { - "type": "string", - "description": "Reason for name being unavailable." - } - }, - "description": "Represents a resource name availability." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server.", - "x-ms-parameter-location": "method" - }, - "FirewallRuleNameParameter": { - "name": "firewallRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server firewall rule.", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the database.", - "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" - }, - "LocationNameParameter": { - "name": "locationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the location.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/mysql/resource-manager/readme.go.md b/specification/mysql/resource-manager/readme.go.md index b332b6bd153e..6cddaf2787ac 100644 --- a/specification/mysql/resource-manager/readme.go.md +++ b/specification/mysql/resource-manager/readme.go.md @@ -16,15 +16,6 @@ batch: - tag: package-2017-12-01 ``` -### Tag: package-2017-04-preview and go - -These settings apply only when `--tag=package-2017-04-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-04-30-preview/$(namespace) -``` - ### Tag: package-2017-12-01-preview and go These settings apply only when `--tag=package-2017-12-01-preview --go` is specified on the command line. diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index 9595ab03be01..a5e6226e6371 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -30,16 +30,6 @@ tag: package-2017-12-01 ``` -### Tag: package-2017-04-preview - -These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04-preview' -input-file: -- Microsoft.DBforMySQL/preview/2017-04-30-preview/mysql.json -``` - - ### Tag: package-2017-12-01-preview These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json deleted file mode 100644 index 206d8b5a6498..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/CheckNameAvailability.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "nameAvailabilityRequest": { - "name": "name1", - "type": "Microsoft.DBforPostgreSQL" - } - }, - "responses": { - "200": { - "body": { - "nameAvailable": true, - "message": "", - "reason": "" - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json deleted file mode 100644 index 20144aee3247..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationCreateOrUpdate.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "configurationName": "array_nulls", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "value": "off", - "source": "user-override" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "value": "off", - "description": "Enable input of NULL elements in arrays.", - "defaultValue": "on", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "user-override" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/array_nulls", - "name": "array_nulls", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationGet.json deleted file mode 100644 index 951fb59e1aae..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationGet.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "configurationName": "array_nulls", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "properties": { - "value": "on", - "description": "Enable input of NULL elements in arrays.", - "defaultValue": "on", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/array_nulls", - "name": "array_nulls", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json deleted file mode 100644 index 19802c224f4b..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ConfigurationListByServer.json +++ /dev/null @@ -1,1056 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "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/servers/testserver/configurations/array_nulls", - "name": "array_nulls", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/backslash_quote", - "name": "backslash_quote", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/bytea_output", - "name": "bytea_output", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "on", - "description": "Check 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/servers/testserver/configurations/check_function_bodies", - "name": "check_function_bodies", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/client_encoding", - "name": "client_encoding", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/client_min_messages", - "name": "client_min_messages", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/constraint_exclusion", - "name": "constraint_exclusion", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/cpu_index_tuple_cost", - "name": "cpu_index_tuple_cost", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/cpu_operator_cost", - "name": "cpu_operator_cost", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/cpu_tuple_cost", - "name": "cpu_tuple_cost", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/cursor_tuple_fraction", - "name": "cursor_tuple_fraction", - "type": "Microsoft.DBforPostgreSQL/servers/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)\\,\\s(dmy|mdy|ymd)", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/datestyle", - "name": "datestyle", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/deadlock_timeout", - "name": "deadlock_timeout", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/debug_print_parse", - "name": "debug_print_parse", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/debug_print_plan", - "name": "debug_print_plan", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/debug_print_rewritten", - "name": "debug_print_rewritten", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/default_statistics_target", - "name": "default_statistics_target", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/default_text_search_config", - "name": "default_text_search_config", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/default_transaction_deferrable", - "name": "default_transaction_deferrable", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/default_transaction_isolation", - "name": "default_transaction_isolation", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/default_transaction_read_only", - "name": "default_transaction_read_only", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "off", - "description": "Create 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/servers/testserver/configurations/default_with_oids", - "name": "default_with_oids", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_bitmapscan", - "name": "enable_bitmapscan", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_hashagg", - "name": "enable_hashagg", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_hashjoin", - "name": "enable_hashjoin", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_indexonlyscan", - "name": "enable_indexonlyscan", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_indexscan", - "name": "enable_indexscan", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_material", - "name": "enable_material", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_mergejoin", - "name": "enable_mergejoin", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_nestloop", - "name": "enable_nestloop", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_seqscan", - "name": "enable_seqscan", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_sort", - "name": "enable_sort", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/enable_tidscan", - "name": "enable_tidscan", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "on", - "description": "Warn 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/servers/testserver/configurations/escape_string_warning", - "name": "escape_string_warning", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "off", - "description": "Terminate 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/servers/testserver/configurations/exit_on_error", - "name": "exit_on_error", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "0", - "description": "Sets the number of digits displayed for floating-point values.", - "defaultValue": "0", - "dataType": "Integer", - "allowedValues": "-15-3", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/extra_float_digits", - "name": "extra_float_digits", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/from_collapse_limit", - "name": "from_collapse_limit", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/geqo", - "name": "geqo", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/geqo_effort", - "name": "geqo_effort", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/geqo_generations", - "name": "geqo_generations", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/geqo_pool_size", - "name": "geqo_pool_size", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "0.0", - "description": "GEQO: seed for random path selection.", - "defaultValue": "0.0", - "dataType": "Numeric", - "allowedValues": "0-1", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/geqo_seed", - "name": "geqo_seed", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "2.0", - "description": "GEQO: selective pressure within the population.", - "defaultValue": "2.0", - "dataType": "Numeric", - "allowedValues": "1.5-2", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/geqo_selection_bias", - "name": "geqo_selection_bias", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/geqo_threshold", - "name": "geqo_threshold", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/gin_fuzzy_search_limit", - "name": "gin_fuzzy_search_limit", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/intervalstyle", - "name": "intervalstyle", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/join_collapse_limit", - "name": "join_collapse_limit", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/lock_timeout", - "name": "lock_timeout", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "off", - "description": "Logs each checkpoint.", - "defaultValue": "off", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/log_checkpoints", - "name": "log_checkpoints", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "off", - "description": "Logs each successful connection.", - "defaultValue": "off", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/log_connections", - "name": "log_connections", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_disconnections", - "name": "log_disconnections", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_duration", - "name": "log_duration", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_error_verbosity", - "name": "log_error_verbosity", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_lock_waits", - "name": "log_lock_waits", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_min_duration_statement", - "name": "log_min_duration_statement", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_min_error_statement", - "name": "log_min_error_statement", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_min_messages", - "name": "log_min_messages", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/log_statement", - "name": "log_statement", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "64", - "description": "Sets the maximum number of locks per transaction.", - "defaultValue": "64", - "dataType": "Integer", - "allowedValues": "10-2147483647", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/max_locks_per_transaction", - "name": "max_locks_per_transaction", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "64", - "description": "Sets the maximum number of predicate locks per transaction.", - "defaultValue": "64", - "dataType": "Integer", - "allowedValues": "10-2147483647", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/max_pred_locks_per_transaction", - "name": "max_pred_locks_per_transaction", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "0", - "description": "Sets the maximum number of simultaneously prepared transactions.", - "defaultValue": "0", - "dataType": "Integer", - "allowedValues": "0-8388607", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/max_prepared_transactions", - "name": "max_prepared_transactions", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "off", - "description": "When generating SQL fragments, quote all identifiers.", - "defaultValue": "off", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/quote_all_identifiers", - "name": "quote_all_identifiers", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "4.0", - "description": "Sets the planner's estimate of the cost of a nonsequentially fetched disk page.", - "defaultValue": "4.0", - "dataType": "Numeric", - "allowedValues": "0-1.79769e+308", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/random_page_cost", - "name": "random_page_cost", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/search_path", - "name": "search_path", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "1.0", - "description": "Sets the planner's estimate of the cost of a sequentially fetched disk page.", - "defaultValue": "1.0", - "dataType": "Numeric", - "allowedValues": "0-1.79769e+308", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/seq_page_cost", - "name": "seq_page_cost", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "on", - "description": "Causes subtables to be included by default in various commands.", - "defaultValue": "on", - "dataType": "Boolean", - "allowedValues": "on,off", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/sql_inheritance", - "name": "sql_inheritance", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/standard_conforming_strings", - "name": "standard_conforming_strings", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/statement_timeout", - "name": "statement_timeout", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "on", - "description": "Enable 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/servers/testserver/configurations/synchronize_seqscans", - "name": "synchronize_seqscans", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/synchronous_commit", - "name": "synchronous_commit", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/transform_null_equals", - "name": "transform_null_equals", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/xmlbinary", - "name": "xmlbinary", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/xmloption", - "name": "xmloption", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/force_parallel_mode", - "name": "force_parallel_mode", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/idle_in_transaction_session_timeout", - "name": "idle_in_transaction_session_timeout", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "0", - "description": "Sets the maximum number of parallel processes per executor node.", - "defaultValue": "0", - "dataType": "Integer", - "allowedValues": "0-1024", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/max_parallel_workers_per_gather", - "name": "max_parallel_workers_per_gather", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "8388608", - "description": "Sets the minimum size of relations to be considered for parallel scan.", - "defaultValue": "8388608", - "dataType": "Integer", - "allowedValues": "0-715827882", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/min_parallel_relation_size", - "name": "min_parallel_relation_size", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/parallel_setup_cost", - "name": "parallel_setup_cost", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/testserver/configurations/parallel_tuple_cost", - "name": "parallel_tuple_cost", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - }, - { - "properties": { - "value": "3", - "description": "Sets how many days a log file is saved for.", - "defaultValue": "3", - "dataType": "Integer", - "allowedValues": "1-7", - "source": "system-default" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/configurations/log_retention_days", - "name": "log_retention_days", - "type": "Microsoft.DBforPostgreSQL/servers/configurations" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseCreate.json deleted file mode 100644 index b63a12e41e9b..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseCreate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "charset":"UTF8", - "collation":"English_United States.1252" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforPostgreSQL/servers/databases", - "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforPostgreSQL/servers/databases", - "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseDelete.json deleted file mode 100644 index 600a8fd87165..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseGet.json deleted file mode 100644 index 4ea6aac9a4d3..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "databaseName": "db1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforPostgreSQL/servers/databases", - "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" - } - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json deleted file mode 100644 index 6bb09763b1be..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/DatabaseListByServer.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db1", - "name": "db1", - "type": "Microsoft.DBforPostgreSQL/servers/databases", - "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/databases/db2", - "name": "db2", - "type": "Microsoft.DBforPostgreSQL/servers/databases", - "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json deleted file mode 100644 index 7454e35e6a08..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleCreate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "startIpAddress":"0.0.0.0", - "endIpAddress":"255.255.255.255" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforPostgreSQL/servers/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/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json deleted file mode 100644 index 7dde700aa259..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleDelete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json deleted file mode 100644 index 534c07717684..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "firewallRuleName": "rule1", - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforPostgreSQL/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json deleted file mode 100644 index a6b877fa46b5..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/FirewallRuleListByServer.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule1", - "name": "rule1", - "type": "Microsoft.DBforPostgreSQL/servers/firewallRules", - "properties": { - "startIpAddress": "0.0.0.0", - "endIpAddress": "255.255.255.255" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/firewallRules/rule2", - "name": "rule2", - "type": "Microsoft.DBforPostgreSQL/servers/firewallRules", - "properties": { - "startIpAddress": "1.0.0.0", - "endIpAddress": "255.0.0.0" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/LogFileListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/LogFileListByServer.json deleted file mode 100644 index 3a03b74c9100..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/LogFileListByServer.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "name": "postgresql-2017-06-22_010000.log", - "sizeInKB": 4, - "createdTime": "0001-01-01T00:00:00+00:00", - "lastModifiedTime": "2017-06-22T01:59:36+00:00", - "type": "text", - "url": "https://wasd2stageneu1btlm4.file.core.windows.net/42679871f6cc4302b39ab9c2e3044df3/pg_log/postgresql-2017-06-22_010000.log?sv=2015-04-05&sr=f&sig=gqIQsa6VyGyUNpzYYPWLP5gM%2BeF1so9GYbHKu6Zs0DM%3D&se=2017-06-22T03%3A21%3A09Z&sp=r" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/logFiles/postgresql-2017-06-22_010000.log", - "name": "postgresql-2017-06-22_010000.log", - "type": "Microsoft.DBforPostgreSQL/servers/logFiles" - }, - { - "properties": { - "name": "postgresql-2017-06-22_020000.log", - "sizeInKB": 1, - "createdTime": "0001-01-01T00:00:00+00:00", - "lastModifiedTime": "2017-06-22T02:19:36+00:00", - "type": "text", - "url": "https://wasd2stageneu1btlm4.file.core.windows.net/42679871f6cc4302b39ab9c2e3044df3/pg_log/postgresql-2017-06-22_020000.log?sv=2015-04-05&sr=f&sig=i99UWBlYfR0tKaxix8yHAOnfym4HV9Auto6BbZogyRs%3D&se=2017-06-22T03%3A21%3A09Z&sp=r" - }, - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/logFiles/postgresql-2017-06-22_020000.log", - "name": "postgresql-2017-06-22_020000.log", - "type": "Microsoft.DBforPostgreSQL/servers/logFiles" - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/OperationList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/OperationList.json deleted file mode 100644 index 0649be041fb6..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/OperationList.json +++ /dev/null @@ -1,194 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.DBforPostgreSQL/locations/performanceTiers/read", - "display": { - "provider": "Microsoft DB for PostgreSQL", - "resource": "Performance Tiers", - "operation": "List Performance Tiers", - "description": "Returns the list of Performance Tiers available." - } - }, - { - "name": "Microsoft.DBforPostgreSQL/servers/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/servers/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/servers/delete", - "display": { - "provider": "Microsoft DB for PostgreSQL", - "resource": "PostgreSQL Server", - "operation": "Delete PostgreSQL Server", - "description": "Deletes an existing server." - } - }, - { - "name": "Microsoft.DBforPostgreSQL/performanceTiers/read", - "display": { - "provider": "Microsoft DB for PostgreSQL", - "resource": "Performance Tiers", - "operation": "List Performance Tiers", - "description": "Returns the list of Performance Tiers available." - } - }, - { - "name": "Microsoft.DBforPostgreSQL/servers/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/servers/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/servers/firewallRules/delete", - "display": { - "provider": "Microsoft DB for PostgreSQL", - "resource": "Firewall Rules", - "operation": "Delete Firewall Rule", - "description": "Deletes an existing firewall rule." - } - }, - { - "name": "Microsoft.DBforPostgreSQL/servers/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/servers/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/servers/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" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json deleted file mode 100644 index 98daf7136515..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersList.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "Basic", - "backupRetentionDays": 7, - "serviceLevelObjectives": [ - { - "edition": "Basic", - "dtu": 50, - "storageMB": 51200, - "id": "PGSQLB50" - }, - { - "edition": "Basic", - "dtu": 100, - "storageMB": 51200, - "id": "PGSQLB100" - } - ] - }, - { - "id": "Standard", - "backupRetentionDays": 35, - "serviceLevelObjectives": [ - { - "edition": "Standard", - "dtu": 100, - "storageMB": 128000, - "id": "PGSQLS100" - }, - { - "edition": "Standard", - "dtu": 200, - "storageMB": 128000, - "id": "PGSQLS200" - }, - { - "edition": "Standard", - "dtu": 400, - "storageMB": 128000, - "id": "PGSQLS400" - }, - { - "edition": "Standard", - "dtu": 800, - "storageMB": 128000, - "id": "PGSQLS800" - } - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json deleted file mode 100644 index 289fa6eedc9e..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/PerformanceTiersListByLocation.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "locationName": "WestUS" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "Basic", - "backupRetentionDays": 7, - "serviceLevelObjectives": [ - { - "edition": "Basic", - "dtu": 50, - "storageMB": 51200, - "id": "PGSQLB50" - }, - { - "edition": "Basic", - "dtu": 100, - "storageMB": 51200, - "id": "PGSQLB100" - } - ] - }, - { - "id": "Standard", - "backupRetentionDays": 35, - "serviceLevelObjectives": [ - { - "edition": "Standard", - "dtu": 100, - "storageMB": 128000, - "id": "PGSQLS100" - }, - { - "edition": "Standard", - "dtu": 200, - "storageMB": 128000, - "id": "PGSQLS200" - }, - { - "edition": "Standard", - "dtu": 400, - "storageMB": 128000, - "id": "PGSQLS400" - }, - { - "edition": "Standard", - "dtu": 800, - "storageMB": 128000, - "id": "PGSQLS800" - } - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json deleted file mode 100644 index 0a38ebac97f5..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerCreate.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "location": "eastus", - "properties": { - "administratorLogin": "cloudsa", - "administratorLoginPassword": "password", - "storageMB": 1024, - "sslEnforcement": "Enabled", - "createMode": "Default" - }, - "sku": { - "name": "SkuName", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "ElasticServer": "1" - } - } - }, - "responses": { - "201": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerDelete.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerDelete.json deleted file mode 100644 index 50b9770f2180..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json deleted file mode 100644 index ea8361077947..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerGet.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json deleted file mode 100644 index dda22aa039ad..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerList.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/serv1", - "name": "serv1", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv1.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup2/providers/Microsoft.DBforPostgreSQL/servers/serv2", - "name": "serv2", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv2.test-vm1.onebox.xdb.mscds.com" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json deleted file mode 100644 index 3da768516584..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerListByResourceGroup.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/serv1", - "name": "serv1", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "serv1.test-vm1.onebox.xdb.mscds.com" - } - }, - { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement":"Enabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json deleted file mode 100644 index 161426a7aa80..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/examples/ServerUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "serverName": "testserver", - "resourceGroupName": "TestGroup", - "api-version": "2017-04-30-preview", - "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", - "parameters": { - "properties":{ - "administratorLoginPassword":"newpassword", - "sslEnforcement": "Disabled" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver", - "name": "testserver", - "type": "Microsoft.DBforPostgreSQL/servers", - "location": "eastus", - "sku": { - "name": "PGSQLB100", - "tier": "Basic", - "capacity": 100 - }, - "tags": { - "elasticServer": "1" - }, - "properties": { - "administratorLogin": "cloudsa", - "storageMB": 1024, - "sslEnforcement": "Disabled", - "userVisibleState": "Ready", - "fullyQualifiedDomainName": "testserver.test-vm1.onebox.xdb.mscds.com" - } - } - }, - "202": {} - } -} \ No newline at end of file diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/postgresql.json deleted file mode 100644 index b24847a180b2..000000000000 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/postgresql.json +++ /dev/null @@ -1,1658 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "PostgreSQLManagementClient", - "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, log files and configurations.", - "version": "2017-04-30-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}": { - "put": { - "tags": [ - "Servers" - ], - "operationId": "Servers_Create", - "x-ms-examples": { - "ServerCreate": { "$ref": "./examples/ServerCreate.json" } - }, - "description": "Creates a new server, or will overwrite an existing server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerForCreate" - }, - "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" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "Servers" - ], - "operationId": "Servers_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": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ServerUpdateParameters" - }, - "description": "The required parameters for updating a server." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Server" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Servers" - ], - "operationId": "Servers_Delete", - "x-ms-examples": { - "ServerDelete": { "$ref": "./examples/ServerDelete.json" } - }, - "description": "Deletes a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_Get", - "x-ms-examples": { - "ServerGet": { "$ref": "./examples/ServerGet.json" } - }, - "description": "Gets information about a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Server" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers": { - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_ListByResourceGroup", - "x-ms-examples": { - "ServerListByResourceGroup": { "$ref": "./examples/ServerListByResourceGroup.json" } - }, - "description": "List all the servers in a given resource group.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/servers": { - "get": { - "tags": [ - "Servers" - ], - "operationId": "Servers_List", - "x-ms-examples": { - "ServerList": { "$ref": "./examples/ServerList.json" } - }, - "description": "List all the servers in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ServerListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules/{firewallRuleName}": { - "put": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_CreateOrUpdate", - "x-ms-examples": { - "FirewallRuleCreate": { "$ref": "./examples/FirewallRuleCreate.json" } - }, - "description": "Creates a new firewall rule or updates an existing firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$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" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_Delete", - "x-ms-examples": { - "FirewallRuleDelete": { "$ref": "./examples/FirewallRuleDelete.json" } - }, - "description": "Deletes a server firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/FirewallRuleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_Get", - "x-ms-examples": { - "FirewallRuleGet": { "$ref": "./examples/FirewallRuleGet.json" } - }, - "description": "Gets information about a server firewall rule.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/FirewallRuleNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FirewallRule" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/firewallRules": { - "get": { - "tags": [ - "FirewallRules" - ], - "operationId": "FirewallRules_ListByServer", - "x-ms-examples": { - "FirewallRuleList": { "$ref": "./examples/FirewallRuleListByServer.json" } - }, - "description": "List all the firewall rules in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FirewallRuleListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { - "put": { - "tags": [ - "Databases" - ], - "operationId": "Databases_CreateOrUpdate", - "x-ms-examples": { - "DatabaseCreate": { "$ref": "./examples/DatabaseCreate.json" } - }, - "description": "Creates a new database or updates an existing database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Database" - }, - "description": "The required parameters for creating or updating a database." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Database" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/Database" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Databases" - ], - "operationId": "Databases_Delete", - "x-ms-examples": { - "DatabaseDelete": { "$ref": "./examples/DatabaseDelete.json" } - }, - "description": "Deletes a database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Databases" - ], - "operationId": "Databases_Get", - "x-ms-examples": { - "DatabaseGet": { "$ref": "./examples/DatabaseGet.json" } - }, - "description": "Gets information about a database.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/DatabaseNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Database" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases": { - "get": { - "tags": [ - "Databases" - ], - "operationId": "Databases_ListByServer", - "x-ms-examples": { - "DatabaseList": { "$ref": "./examples/DatabaseListByServer.json" } - }, - "description": "List all the databases in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DatabaseListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations/{configurationName}": { - "put": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_CreateOrUpdate", - "x-ms-examples": { - "ConfigurationCreateOrUpdate": { "$ref": "./examples/ConfigurationCreateOrUpdate.json" } - }, - "description": "Updates a configuration of a server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Configuration" - }, - "description": "The required parameters for updating a server configuration." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Configuration" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_Get", - "x-ms-examples": { - "ConfigurationGet": { "$ref": "./examples/ConfigurationGet.json" } - }, - "description": "Gets information about a configuration of server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "$ref": "#/parameters/ConfigurationNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Configuration" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/configurations": { - "get": { - "tags": [ - "Configurations" - ], - "operationId": "Configurations_ListByServer", - "x-ms-examples": { - "ConfigurationList": { "$ref": "./examples/ConfigurationListByServer.json" } - }, - "description": "List all the configurations in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/logFiles": { - "get": { - "tags": [ - "LogFiles" - ], - "operationId": "LogFiles_ListByServer", - "x-ms-examples": { - "LogFileList": { "$ref": "./examples/LogFileListByServer.json" } - }, - "description": "List all the log files in a given server.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/LogFileListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/performanceTiers": { - "get": { - "tags": [ - "PerformanceTiers" - ], - "operationId": "PerformanceTiers_List", - "x-ms-examples": { - "PerformanceTiersList": { - "$ref": "./examples/PerformanceTiersList.json" - } - }, - "description": "List all the performance tiers in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PerformanceTierListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/locations/{locationName}/performanceTiers": { - "get": { - "tags": [ - "LocationBasedPerformanceTier" - ], - "operationId": "LocationBasedPerformanceTier_List", - "x-ms-examples": { - "PerformanceTiersList": { - "$ref": "./examples/PerformanceTiersListByLocation.json" - } - }, - "description": "List all the performance tiers at specified location in a given subscription.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/LocationNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PerformanceTierListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.DBforPostgreSQL/checkNameAvailability": { - "post": { - "tags": [ - "CheckNameAvailability" - ], - "operationId": "CheckNameAvailability_Execute", - "x-ms-examples": { - "NameAvailability": { "$ref": "./examples/CheckNameAvailability.json" } - }, - "description": "Check the availability of name for resource", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/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" - } - } - } - } - }, - "/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": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - } - } - } - }, - "definitions": { - "ServerVersion": { - "type": "string", - "description": "The version of a server.", - "enum": [ - "9.5", - "9.6" - ], - "x-ms-enum": { - "name": "ServerVersion", - "modelAsString": true - } - }, - "SslEnforcement": { - "type": "string", - "description": "Enable ssl enforcement or not when connect to server.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "SslEnforcementEnum", - "modelAsString": false - } - }, - "ProxyResource": { - "description": "Resource properties.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "Resource properties including location and tags for track resources.", - "properties": { - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "required": [ - "location" - ] - }, - "ServerProperties": { - "properties": { - "administratorLogin": { - "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)." - }, - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The maximum storage allowed for a server." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "Server version." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - }, - "userVisibleState": { - "type": "string", - "description": "A state of a server that is visible to user.", - "enum": [ - "Ready", - "Dropping", - "Disabled" - ], - "x-ms-enum": { - "name": "ServerState", - "modelAsString": true - } - }, - "fullyQualifiedDomainName": { - "type": "string", - "description": "The fully qualified domain name of a server." - } - }, - "description": "The properties of a server." - }, - "ServerPropertiesForCreate": { - "discriminator": "createMode", - "required": [ "createMode" ], - "properties": { - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The maximum storage allowed for a server." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "Server version." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - }, - "createMode": { - "type": "string", - "description": "The mode to create a new server.", - "enum": [ - "Default", - "PointInTimeRestore" - ], - "x-ms-enum": { - "name": "CreateMode", - "modelAsString": true - } - } - }, - "description": "The properties used to create a new server." - }, - "ServerPropertiesForDefaultCreate": { - "x-ms-discriminator-value": "Default", - "allOf": [ - { - "$ref": "#/definitions/ServerPropertiesForCreate" - } - ], - "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)." - }, - "administratorLoginPassword": { - "type": "string", - "format": "password", - "description": "The password of the administrator login." - } - }, - "required": [ - "administratorLogin", - "administratorLoginPassword" - ], - "description": "The properties used to create a new server." - }, - "ServerPropertiesForRestore": { - "x-ms-discriminator-value": "PointInTimeRestore", - "allOf": [ - { - "$ref": "#/definitions/ServerPropertiesForCreate" - } - ], - "properties": { - "sourceServerId": { - "type": "string", - "description": "The source server id to restore from." - }, - "restorePointInTime": { - "type": "string", - "format": "date-time", - "description": "Restore point creation time (ISO8601 format), specifying the time to restore from." - } - }, - "required": [ - "sourceServerId", - "restorePointInTime" - ], - "description": "The properties to a new server by restoring from a backup." - }, - "Sku": { - "properties": { - "name": { - "type": "string", - "description": "The name of the sku, typically, a letter + Number code, e.g. P3." - }, - "tier": { - "type": "string", - "description": "The tier of the particular SKU, e.g. Basic.", - "enum": [ - "Basic", - "Standard" - ], - "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." - }, - "size": { - "type": "string", - "description": "The size code, to be interpreted by resource as appropriate." - }, - "family": { - "type": "string", - "description": "The family of hardware." - } - }, - "description": "Billing information related properties of a server." - }, - "Server": { - "properties": { - "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": "#/definitions/TrackedResource" - } - ], - "description": "Represents a server." - }, - "ServerForCreate": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." - }, - "properties": { - "$ref": "#/definitions/ServerPropertiesForCreate", - "x-ms-client-flatten": false, - "description": "Properties of the server." - }, - "location": { - "type": "string", - "description": "The location the resource resides in." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "required": [ - "properties", - "location" - ], - "description": "Represents a server to be created." - }, - "ServerUpdateParameters": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "The SKU (pricing tier) of the server." - }, - "properties": { - "properties": { - "storageMB": { - "type": "integer", - "format": "int64", - "minimum": 1024, - "description": "The max storage allowed for a server." - }, - "administratorLoginPassword": { - "type": "string", - "format": "password", - "description": "The password of the administrator login." - }, - "version": { - "$ref": "#/definitions/ServerVersion", - "description": "The version of a server." - }, - "sslEnforcement": { - "$ref": "#/definitions/SslEnforcement", - "description": "Enable ssl enforcement or not when connect to server." - } - }, - "x-ms-client-flatten": true, - "description": "The properties that can be updated for a server." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Application-specific metadata in the form of key-value pairs." - } - }, - "description": "Parameters allowd to update for a server." - }, - "ServerListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Server" - }, - "description": "The list of servers" - } - }, - "description": "A list of servers." - }, - "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": "#/definitions/ProxyResource" - } - ], - "required": [ - "properties" - ], - "description": "Represents a server firewall rule." - }, - "FirewallRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/FirewallRule" - }, - "description": "The list of firewall rules in a server." - } - }, - "description": "A list of firewall rules." - }, - "DatabaseProperties": { - "properties": { - "charset": { - "type": "string", - "description": "The charset of the database." - }, - "collation": { - "type": "string", - "description": "The collation of the database." - } - }, - "description": "The properties of a database." - }, - "Database": { - "properties": { - "properties": { - "$ref": "#/definitions/DatabaseProperties", - "x-ms-client-flatten": true, - "description": "The properties of a database." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Represents a Database." - }, - "DatabaseListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Database" - }, - "description": "The list of databases housed in a server" - } - }, - "description": "A List of databases." - }, - "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." - }, - "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": "#/definitions/ProxyResource" - } - ], - "description": "Represents a Configuration." - }, - "ConfigurationListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Configuration" - }, - "description": "The list of server configurations." - } - }, - "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." - }, - "LogFileProperties": { - "properties": { - "name": { - "type": "string", - "description": "Log file name." - }, - "sizeInKB": { - "type": "integer", - "format": "int64", - "description": "Size of the log file." - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "Creation timestamp of the log file." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Last modified timestamp of the log file." - }, - "type": { - "type": "string", - "description": "Type of the log file." - }, - "url": { - "type": "string", - "description": "The url to download the log file from." - } - }, - "description": "The properties of a log file." - }, - "LogFile": { - "properties": { - "name": { - "type": "string", - "description": "The name of the log file." - }, - "properties": { - "$ref": "#/definitions/LogFileProperties", - "x-ms-client-flatten": true, - "description": "The properties of the log file." - } - }, - "allOf": [ - { - "$ref": "#/definitions/ProxyResource" - } - ], - "description": "Represents a log file." - }, - "LogFileListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/LogFile" - }, - "description": "The list of log files." - } - }, - "description": "A list of log files." - }, - "PerformanceTierServiceLevelObjectives": { - "properties": { - "id": { - "type": "string", - "description": "ID for the service level objective." - }, - "edition": { - "type": "string", - "description": "Edition of the performance tier." - }, - "dtu": { - "type": "integer", - "description": "Database throughput unit associated with the service level objective" - }, - "storageMB": { - "type": "integer", - "description": "Maximum storage in MB associated with the service level objective" - } - }, - "description": "Service level objectives for performance tier." - }, - "PerformanceTierProperties": { - "properties": { - "id": { - "type": "string", - "description": "ID of the performance tier." - }, - "backupRetentionDays": { - "type": "integer", - "description": "Backup retention in days for the performance tier edition" - }, - "serviceLevelObjectives": { - "type": "array", - "items": { - "$ref": "#/definitions/PerformanceTierServiceLevelObjectives" - }, - "description": "Service level objectives associated with the performance tier" - } - }, - "description": "Performance tier properties" - }, - "PerformanceTierListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/PerformanceTierProperties" - }, - "description": "The list of performance tiers" - } - }, - "description": "A list of performance tiers." - }, - "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." - }, - "reason": { - "type": "string", - "description": "Reason for name being unavailable." - } - }, - "description": "Represents a resource name availability." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The subscription ID that identifies an Azure subscription." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request." - }, - "ResourceGroupParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", - "x-ms-parameter-location": "method" - }, - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server.", - "x-ms-parameter-location": "method" - }, - "FirewallRuleNameParameter": { - "name": "firewallRuleName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server firewall rule.", - "x-ms-parameter-location": "method" - }, - "DatabaseNameParameter": { - "name": "databaseName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the database.", - "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" - }, - "LocationNameParameter": { - "name": "locationName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the location.", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/postgresql/resource-manager/readme.go.md b/specification/postgresql/resource-manager/readme.go.md index 8e195f52a918..153c55816410 100644 --- a/specification/postgresql/resource-manager/readme.go.md +++ b/specification/postgresql/resource-manager/readme.go.md @@ -16,15 +16,6 @@ batch: - tag: package-2017-12-01 ``` -### Tag: package-2017-04-preview and go - -These settings apply only when `--tag=package-2017-04-preview --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2017-04-preview' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-04-30-preview/$(namespace) -``` - ### Tag: package-2017-12-01-preview and go These settings apply only when `--tag=package-2017-12-01-preview --go` is specified on the command line. diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index f65192cb23dc..3053b1935403 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -30,16 +30,6 @@ tag: package-2017-12-01 ``` -### Tag: package-2017-04-preview - -These settings apply only when `--tag=package-2017-04-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2017-04-preview' -input-file: -- Microsoft.DBforPostgreSQL/preview/2017-04-30-preview/postgresql.json -``` - - ### Tag: package-2017-12-01-preview These settings apply only when `--tag=package-2017-12-01-preview` is specified on the command line. From 134de63cde5d2d832b3388f3641019b475b1eda6 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Mon, 26 Nov 2018 16:27:39 -0800 Subject: [PATCH 198/464] Network november release (#4509) * Adds base for updating Microsoft.Network from version stable/2018-08-01 to version 2018-10-01 * Updates readme * Updates API version in new specs and examples * [Networkwatcer] add FlowLogFormatParameters (#4374) * Update specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json [Networkwatcher] add a new field "Format" with new type"FlowLogFormat" to FlowLogProperties * Revert "Update specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json" This reverts commit f4f438af5a3d42a21936ecb6d3f661f3fa4a4442. * Update specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json [networkwatcer] add FlowLogFormatParameters * [Network wathcer] add a new field trafficAnalyticsInterval for TA (#4420) * Make NIC VM ref readonly (#4443) * Mark private IP address read-only (#4447) * change container nics property type on container nic config to resourceid (#4459) * Port fix from PR 4459 to 2018-10-01 (#4463) * Application Gateway - Adds Rewrite rule set for Header CRUD (#4331) * Adds base for updating Microsoft.Network from version stable/2018-08-01 to version 2018-10-01 * Updates readme * Updates API version in new specs and examples * Adds Rewrite rule set for Header CRUD Adds the structure of rewriteRuleSets in the applicationGatewayProperties. Adds recursively the sub structures in the rewriteRuleSet. Adds the reference to rewriteRuleSet in the requestRoutingRule for both Basic rule and Path based rule. * Adds examples for the Header CRUD in application gateway * Fix the examples; replacing rules with rewriteRules. * Fixing the properties of application Gateway rewriteRule * Revert "Fixing the properties of application Gateway rewriteRule" This reverts commit 05c9c9103af1da0162b6cc0a04c4b37b4360f66c. * Fixing the properties of application Gateway rewriteRule * Mark the provisioning state as readOnly * Mark etag as readOnly * Revert "Model ContainerNic refs under ContainerNicConfig as sub resources" (#4467) * Revert "Application Gateway - Adds Rewrite rule set for Header CRUD (#4331)" This reverts commit 633d12d5b552b102f874182b8f50266eb97fdc85. * Revert "Port fix from PR 4459 to 2018-10-01 (#4463)" This reverts commit 5ea0c7b8bcf16d992bb1f2b5f3b52208354a4391. * Revert "change container nics property type on container nic config to resourceid (#4459)" This reverts commit baf31d901254dd4bf4f1813e9faeec1c9805f775. * Fixes the missing array for the header actions (#4497) * Network py 2018-10 * add package-2018-10 to Go SDK codegen * Application gateway Identity and Keyvault support (#4387) * identity and keyvault * Capitalization comment * Ported fix from master branch (#4547) --- .../stable/2018-10-01/applicationGateway.json | 2358 +++++++++++ .../2018-10-01/applicationSecurityGroup.json | 303 ++ .../2018-10-01/availableDelegations.json | 166 + .../stable/2018-10-01/azureFirewall.json | 766 ++++ .../2018-10-01/azureFirewallFqdnTag.json | 139 + .../2018-10-01/checkDnsAvailability.json | 88 + .../stable/2018-10-01/ddosProtectionPlan.json | 343 ++ .../stable/2018-10-01/endpointService.json | 111 + ...licationGatewayAvailableSslOptionsGet.json | 9 + ...ilableSslOptionsPredefinedPoliciesGet.json | 9 + ...vailableSslOptionsPredefinedPolicyGet.json | 10 + ...icationGatewayAvailableWafRuleSetsGet.json | 36 + .../ApplicationGatewayBackendHealthGet.json | 57 + .../examples/ApplicationGatewayCreate.json | 701 ++++ .../examples/ApplicationGatewayDelete.json | 13 + .../examples/ApplicationGatewayGet.json | 242 ++ .../examples/ApplicationGatewayList.json | 125 + .../examples/ApplicationGatewayListAll.json | 124 + .../examples/ApplicationGatewayStart.json | 12 + .../examples/ApplicationGatewayStop.json | 12 + .../ApplicationGatewayUpdateTags.json | 148 + .../ApplicationSecurityGroupCreate.json | 38 + .../ApplicationSecurityGroupDelete.json | 13 + .../examples/ApplicationSecurityGroupGet.json | 22 + .../ApplicationSecurityGroupList.json | 35 + .../ApplicationSecurityGroupListAll.json | 34 + .../AvailableDelegationsResourceGroupGet.json | 25 + .../AvailableDelegationsSubscriptionGet.json | 24 + .../examples/AzureFirewallDelete.json | 13 + ...ureFirewallFqdnTagsListBySubscription.json | 28 + .../2018-10-01/examples/AzureFirewallGet.json | 128 + .../AzureFirewallListByResourceGroup.json | 131 + .../AzureFirewallListBySubscription.json | 130 + .../2018-10-01/examples/AzureFirewallPut.json | 352 ++ .../examples/CheckDnsNameAvailability.json | 15 + .../examples/DdosProtectionPlanCreate.json | 40 + .../examples/DdosProtectionPlanDelete.json | 13 + .../examples/DdosProtectionPlanGet.json | 27 + .../examples/DdosProtectionPlanList.json | 45 + .../examples/DdosProtectionPlanListAll.json | 47 + .../examples/DefaultSecurityRuleGet.json | 33 + .../examples/DefaultSecurityRuleList.json | 136 + .../examples/EndpointServicesList.json | 30 + .../ExpressRouteCircuitARPTableList.json | 32 + ...xpressRouteCircuitAuthorizationCreate.json | 39 + ...xpressRouteCircuitAuthorizationDelete.json | 20 + .../ExpressRouteCircuitAuthorizationGet.json | 21 + .../ExpressRouteCircuitAuthorizationList.json | 24 + .../ExpressRouteCircuitConnectionCreate.json | 63 + .../ExpressRouteCircuitConnectionDelete.json | 15 + .../ExpressRouteCircuitConnectionGet.json | 31 + .../examples/ExpressRouteCircuitCreate.json | 84 + ...sRouteCircuitCreateOnExpressRoutePort.json | 79 + .../examples/ExpressRouteCircuitDelete.json | 13 + .../examples/ExpressRouteCircuitGet.json | 38 + ...xpressRouteCircuitListByResourceGroup.json | 91 + ...ExpressRouteCircuitListBySubscription.json | 90 + .../ExpressRouteCircuitPeeringCreate.json | 80 + .../ExpressRouteCircuitPeeringDelete.json | 14 + .../ExpressRouteCircuitPeeringGet.json | 55 + .../ExpressRouteCircuitPeeringList.json | 86 + .../ExpressRouteCircuitPeeringStats.json | 17 + .../ExpressRouteCircuitRouteTableList.json | 34 + ...ressRouteCircuitRouteTableSummaryList.json | 34 + .../examples/ExpressRouteCircuitStats.json | 16 + .../ExpressRouteCircuitUpdateTags.json | 48 + .../ExpressRouteConnectionCreate.json | 50 + .../ExpressRouteConnectionDelete.json | 14 + .../examples/ExpressRouteConnectionGet.json | 25 + .../examples/ExpressRouteConnectionList.json | 28 + ...sRouteCrossConnectionBgpPeeringCreate.json | 76 + ...sRouteCrossConnectionBgpPeeringDelete.json | 17 + ...ressRouteCrossConnectionBgpPeeringGet.json | 37 + ...essRouteCrossConnectionBgpPeeringList.json | 40 + .../ExpressRouteCrossConnectionGet.json | 32 + .../ExpressRouteCrossConnectionList.json | 33 + ...uteCrossConnectionListByResourceGroup.json | 34 + .../ExpressRouteCrossConnectionUpdate.json | 36 + ...ExpressRouteCrossConnectionUpdateTags.json | 41 + .../ExpressRouteCrossConnectionsArpTable.json | 26 + ...xpressRouteCrossConnectionsRouteTable.json | 34 + ...outeCrossConnectionsRouteTableSummary.json | 32 + .../examples/ExpressRouteGatewayCreate.json | 65 + .../examples/ExpressRouteGatewayDelete.json | 13 + .../examples/ExpressRouteGatewayGet.json | 26 + ...xpressRouteGatewayListByResourceGroup.json | 47 + ...ExpressRouteGatewayListBySubscription.json | 46 + .../examples/ExpressRouteLinkGet.json | 26 + .../examples/ExpressRouteLinkList.json | 42 + .../examples/ExpressRoutePortCreate.json | 112 + .../examples/ExpressRoutePortDelete.json | 13 + .../examples/ExpressRoutePortGet.json | 57 + .../examples/ExpressRoutePortList.json | 59 + .../ExpressRoutePortListByResourceGroup.json | 60 + .../examples/ExpressRoutePortUpdateLink.json | 120 + .../examples/ExpressRoutePortUpdateTags.json | 63 + .../ExpressRoutePortsLocationGet.json | 28 + .../ExpressRoutePortsLocationList.json | 27 + .../examples/ExpressRouteProviderList.json | 58 + .../HubVirtualNetworkConnectionDelete.json | 14 + .../HubVirtualNetworkConnectionGet.json | 26 + .../HubVirtualNetworkConnectionList.json | 41 + .../HubVirtualNetworkConnectionPut.json | 54 + .../examples/InboundNatRuleCreate.json | 64 + .../examples/InboundNatRuleDelete.json | 14 + .../examples/InboundNatRuleGet.json | 32 + .../examples/InboundNatRuleList.json | 54 + .../examples/InterfaceEndpointCreate.json | 67 + .../examples/InterfaceEndpointDelete.json | 13 + .../examples/InterfaceEndpointGet.json | 34 + .../examples/InterfaceEndpointList.json | 59 + .../examples/InterfaceEndpointListAll.json | 80 + .../LoadBalancerBackendAddressPoolGet.json | 31 + .../LoadBalancerBackendAddressPoolList.json | 34 + .../examples/LoadBalancerCreate.json | 338 ++ .../LoadBalancerCreateStandardSku.json | 335 ++ .../LoadBalancerCreateWithInboundNatPool.json | 168 + .../examples/LoadBalancerCreateWithZones.json | 335 ++ .../examples/LoadBalancerDelete.json | 13 + ...oadBalancerFrontendIPConfigurationGet.json | 36 + ...adBalancerFrontendIPConfigurationList.json | 39 + .../2018-10-01/examples/LoadBalancerGet.json | 127 + .../2018-10-01/examples/LoadBalancerList.json | 142 + .../examples/LoadBalancerListAll.json | 141 + .../LoadBalancerLoadBalancingRuleGet.json | 37 + .../LoadBalancerLoadBalancingRuleList.json | 40 + ...oadBalancerNetworkInterfaceListSimple.json | 59 + .../LoadBalancerNetworkInterfaceListVmss.json | 112 + .../examples/LoadBalancerOutboundRuleGet.json | 33 + .../LoadBalancerOutboundRuleList.json | 36 + .../examples/LoadBalancerProbeGet.json | 31 + .../examples/LoadBalancerProbeList.json | 34 + .../examples/LoadBalancerUpdateTags.json | 132 + .../examples/LocalNetworkGatewayCreate.json | 59 + .../examples/LocalNetworkGatewayDelete.json | 13 + .../examples/LocalNetworkGatewayGet.json | 29 + .../examples/LocalNetworkGatewayList.json | 49 + .../LocalNetworkGatewayUpdateTags.json | 38 + .../examples/NetworkInterfaceCreate.json | 98 + .../examples/NetworkInterfaceDelete.json | 13 + .../NetworkInterfaceEffectiveNSGList.json | 71 + ...tworkInterfaceEffectiveRouteTableList.json | 71 + .../examples/NetworkInterfaceGet.json | 55 + .../NetworkInterfaceIPConfigurationGet.json | 45 + .../NetworkInterfaceIPConfigurationList.json | 31 + .../examples/NetworkInterfaceList.json | 90 + .../examples/NetworkInterfaceListAll.json | 89 + .../NetworkInterfaceLoadBalancerList.json | 139 + ...etworkInterfaceTapConfigurationCreate.json | 47 + ...etworkInterfaceTapConfigurationDelete.json | 14 + .../NetworkInterfaceTapConfigurationGet.json | 26 + .../NetworkInterfaceTapConfigurationList.json | 28 + .../examples/NetworkInterfaceUpdateTags.json | 55 + .../NetworkProfileCreateConfigOnly.json | 110 + .../examples/NetworkProfileDelete.json | 13 + .../examples/NetworkProfileGetConfigOnly.json | 84 + .../NetworkProfileGetWithContainerNic.json | 203 + .../examples/NetworkProfileList.json | 97 + .../examples/NetworkProfileListAll.json | 84 + .../examples/NetworkProfileUpdateTags.json | 58 + .../examples/NetworkSecurityGroupCreate.json | 231 ++ .../NetworkSecurityGroupCreateWithRule.json | 281 ++ .../examples/NetworkSecurityGroupDelete.json | 13 + .../examples/NetworkSecurityGroupGet.json | 136 + .../examples/NetworkSecurityGroupList.json | 231 ++ .../examples/NetworkSecurityGroupListAll.json | 230 ++ .../NetworkSecurityGroupRuleCreate.json | 57 + .../NetworkSecurityGroupRuleDelete.json | 14 + .../examples/NetworkSecurityGroupRuleGet.json | 28 + .../NetworkSecurityGroupRuleList.json | 31 + .../NetworkSecurityGroupUpdateTags.json | 130 + ...tworkWatcherAvailableProvidersListGet.json | 66 + ...workWatcherAzureReachabilityReportGet.json | 82 + ...NetworkWatcherConnectionMonitorCreate.json | 70 + ...NetworkWatcherConnectionMonitorDelete.json | 13 + .../NetworkWatcherConnectionMonitorGet.json | 35 + .../NetworkWatcherConnectionMonitorList.json | 60 + .../NetworkWatcherConnectionMonitorQuery.json | 77 + .../NetworkWatcherConnectionMonitorStart.json | 13 + .../NetworkWatcherConnectionMonitorStop.json | 13 + .../NetworkWatcherConnectivityCheck.json | 79 + .../examples/NetworkWatcherCreate.json | 41 + .../examples/NetworkWatcherDelete.json | 12 + .../NetworkWatcherFlowLogConfigure.json | 35 + .../NetworkWatcherFlowLogStatusQuery.json | 31 + .../examples/NetworkWatcherGet.json | 23 + .../examples/NetworkWatcherIpFlowVerify.json | 31 + .../examples/NetworkWatcherList.json | 37 + .../examples/NetworkWatcherListAll.json | 36 + ...WatcherNetworkConfigurationDiagnostic.json | 198 + .../examples/NetworkWatcherNextHopGet.json | 30 + .../NetworkWatcherPacketCaptureCreate.json | 56 + .../NetworkWatcherPacketCaptureDelete.json | 13 + .../NetworkWatcherPacketCaptureGet.json | 37 + ...etworkWatcherPacketCaptureQueryStatus.json | 31 + .../NetworkWatcherPacketCaptureStop.json | 13 + .../NetworkWatcherPacketCapturesList.json | 58 + .../NetworkWatcherSecurityGroupViewGet.json | 141 + .../examples/NetworkWatcherTopologyGet.json | 39 + .../NetworkWatcherTroubleshootGet.json | 71 + ...NetworkWatcherTroubleshootResultQuery.json | 67 + .../examples/NetworkWatcherUpdateTags.json | 32 + .../2018-10-01/examples/OperationList.json | 137 + .../examples/P2SVpnGatewayDelete.json | 13 + .../P2SVpnGatewayGenerateVpnProfile.json | 19 + .../2018-10-01/examples/P2SVpnGatewayGet.json | 43 + .../examples/P2SVpnGatewayList.json | 77 + .../P2SVpnGatewayListByResourceGroup.json | 77 + .../2018-10-01/examples/P2SVpnGatewayPut.json | 86 + .../examples/P2SVpnGatewayUpdateTags.json | 87 + .../P2SVpnServerConfigurationDelete.json | 14 + .../P2SVpnServerConfigurationGet.json | 75 + .../P2SVpnServerConfigurationList.json | 77 + .../P2SVpnServerConfigurationPut.json | 182 + ...PublicIpAddressCreateCustomizedValues.json | 63 + .../PublicIpAddressCreateDefaults.json | 51 + .../examples/PublicIpAddressCreateDns.json | 59 + .../examples/PublicIpAddressDelete.json | 13 + .../examples/PublicIpAddressGet.json | 37 + .../examples/PublicIpAddressList.json | 60 + .../examples/PublicIpAddressListAll.json | 49 + .../examples/PublicIpAddressUpdateTags.json | 37 + .../PublicIpPrefixCreateCustomizedValues.json | 54 + .../PublicIpPrefixCreateDefaults.json | 43 + .../examples/PublicIpPrefixDelete.json | 13 + .../examples/PublicIpPrefixGet.json | 32 + .../examples/PublicIpPrefixList.json | 45 + .../examples/PublicIpPrefixListAll.json | 44 + .../examples/PublicIpPrefixUpdateTags.json | 33 + .../examples/RouteFilterCreate.json | 96 + .../examples/RouteFilterDelete.json | 13 + .../2018-10-01/examples/RouteFilterGet.json | 42 + .../2018-10-01/examples/RouteFilterList.json | 44 + .../RouteFilterListByResourceGroup.json | 45 + .../examples/RouteFilterRuleCreate.json | 53 + .../examples/RouteFilterRuleDelete.json | 14 + .../examples/RouteFilterRuleGet.json | 27 + .../RouteFilterRuleListByRouteFilter.json | 30 + .../examples/RouteFilterRuleUpdate.json | 37 + .../examples/RouteFilterUpdate.json | 60 + .../2018-10-01/examples/RouteTableCreate.json | 37 + .../examples/RouteTableCreateWithRoute.json | 69 + .../2018-10-01/examples/RouteTableDelete.json | 13 + .../2018-10-01/examples/RouteTableGet.json | 33 + .../2018-10-01/examples/RouteTableList.json | 47 + .../examples/RouteTableListAll.json | 44 + .../examples/RouteTableRouteCreate.json | 39 + .../examples/RouteTableRouteDelete.json | 14 + .../examples/RouteTableRouteGet.json | 22 + .../examples/RouteTableRouteList.json | 34 + .../examples/RouteTableUpdateTags.json | 32 + .../examples/ServiceCommunityList.json | 56 + .../examples/ServiceEndpointPolicyCreate.json | 41 + ...iceEndpointPolicyCreateWithDefinition.json | 84 + ...ServiceEndpointPolicyDefinitionCreate.json | 52 + ...ServiceEndpointPolicyDefinitionDelete.json | 14 + .../ServiceEndpointPolicyDefinitionGet.json | 26 + .../ServiceEndpointPolicyDefinitionList.json | 29 + .../examples/ServiceEndpointPolicyDelete.json | 13 + .../examples/ServiceEndpointPolicyGet.json | 39 + .../examples/ServiceEndpointPolicyList.json | 65 + .../ServiceEndpointPolicyListAll.json | 66 + .../ServiceEndpointPolicyUpdateTags.json | 47 + .../2018-10-01/examples/SubnetCreate.json | 36 + .../examples/SubnetCreateServiceEndpoint.json | 55 + .../examples/SubnetCreateWithDelegation.json | 60 + .../2018-10-01/examples/SubnetDelete.json | 14 + .../stable/2018-10-01/examples/SubnetGet.json | 21 + .../examples/SubnetGetWithDelegation.json | 33 + .../2018-10-01/examples/SubnetList.json | 32 + .../stable/2018-10-01/examples/UsageList.json | 265 ++ .../examples/UsageListSpacedLocation.json | 335 ++ .../2018-10-01/examples/VirtualHubDelete.json | 13 + .../2018-10-01/examples/VirtualHubGet.json | 27 + .../2018-10-01/examples/VirtualHubList.json | 72 + .../VirtualHubListByResourceGroup.json | 73 + .../2018-10-01/examples/VirtualHubPut.json | 56 + .../examples/VirtualHubUpdateTags.json | 58 + ...tualNetworkCheckIPAddressAvailability.json | 23 + .../examples/VirtualNetworkCreate.json | 56 + ...ualNetworkCreateServiceEndpointPolicy.json | 120 + .../VirtualNetworkCreateServiceEndpoints.json | 110 + .../examples/VirtualNetworkCreateSubnet.json | 81 + ...etworkCreateSubnetWithAddressPrefixes.json | 90 + ...tualNetworkCreateSubnetWithDelegation.json | 113 + .../examples/VirtualNetworkDelete.json | 13 + ...VirtualNetworkGatewayConnectionCreate.json | 136 + ...VirtualNetworkGatewayConnectionDelete.json | 13 + .../VirtualNetworkGatewayConnectionGet.json | 41 + ...lNetworkGatewayConnectionGetSharedKey.json | 15 + ...etworkGatewayConnectionResetSharedKey.json | 19 + ...lNetworkGatewayConnectionSetSharedKey.json | 23 + ...ualNetworkGatewayConnectionUpdateTags.json | 49 + .../VirtualNetworkGatewayConnectionsList.json | 69 + .../examples/VirtualNetworkGatewayDelete.json | 13 + ...etworkGatewayGenerateVpnClientPackage.json | 15 + ...rtualNetworkGatewayGenerateVpnProfile.json | 16 + .../examples/VirtualNetworkGatewayGet.json | 54 + ...tualNetworkGatewayGetAdvertisedRoutes.json | 17 + ...VirtualNetworkGatewayGetBGPPeerStatus.json | 16 + ...orkGatewayGetVpnClientIpsecParameters.json | 20 + ...NetworkGatewayGetVpnProfilePackageUrl.json | 14 + .../VirtualNetworkGatewayLearnedRoutes.json | 16 + .../examples/VirtualNetworkGatewayList.json | 109 + .../examples/VirtualNetworkGatewayReset.json | 55 + ...NetworkGatewayResetVpnClientSharedKey.json | 12 + ...orkGatewaySetVpnClientIpsecParameters.json | 25 + ...rtualNetworkGatewaySupportedVpnDevice.json | 13 + .../examples/VirtualNetworkGatewayUpdate.json | 152 + .../VirtualNetworkGatewayUpdateTags.json | 62 + ...rkGatewayVpnDeviceConfigurationScript.json | 18 + ...VirtualNetworkGatewaysListConnections.json | 40 + .../examples/VirtualNetworkGet.json | 40 + ...lNetworkGetWithServiceAssociationLink.json | 69 + ...VirtualNetworkGetWithSubnetDelegation.json | 48 + .../examples/VirtualNetworkList.json | 64 + .../examples/VirtualNetworkListAll.json | 63 + .../examples/VirtualNetworkListUsage.json | 36 + .../examples/VirtualNetworkPeeringCreate.json | 66 + .../examples/VirtualNetworkPeeringDelete.json | 14 + .../examples/VirtualNetworkPeeringGet.json | 33 + .../examples/VirtualNetworkPeeringList.json | 56 + .../examples/VirtualNetworkTapCreate.json | 62 + .../examples/VirtualNetworkTapDelete.json | 13 + .../examples/VirtualNetworkTapGet.json | 32 + .../examples/VirtualNetworkTapList.json | 55 + .../examples/VirtualNetworkTapListAll.json | 54 + .../examples/VirtualNetworkTapUpdateTags.json | 40 + .../examples/VirtualNetworkUpdateTags.json | 39 + .../2018-10-01/examples/VirtualWANDelete.json | 13 + .../2018-10-01/examples/VirtualWANGet.json | 34 + .../2018-10-01/examples/VirtualWANList.json | 58 + .../VirtualWANListByResourceGroup.json | 59 + .../2018-10-01/examples/VirtualWANPut.json | 67 + .../examples/VirtualWANUpdateTags.json | 66 + .../VirtualWanSupportedSecurityProviders.json | 27 + .../examples/VmssNetworkInterfaceGet.json | 65 + .../VmssNetworkInterfaceIpConfigGet.json | 39 + .../VmssNetworkInterfaceIpConfigList.json | 42 + .../examples/VmssNetworkInterfaceList.json | 118 + .../2018-10-01/examples/VmssPublicIpGet.json | 34 + .../examples/VmssPublicIpListAll.json | 52 + .../examples/VmssVmNetworkInterfaceList.json | 68 + .../examples/VmssVmPublicIpList.json | 37 + .../examples/VpnConnectionDelete.json | 14 + .../2018-10-01/examples/VpnConnectionGet.json | 33 + .../examples/VpnConnectionList.json | 34 + .../2018-10-01/examples/VpnConnectionPut.json | 60 + .../2018-10-01/examples/VpnGatewayDelete.json | 13 + .../2018-10-01/examples/VpnGatewayGet.json | 51 + .../2018-10-01/examples/VpnGatewayList.json | 93 + .../VpnGatewayListByResourceGroup.json | 93 + .../2018-10-01/examples/VpnGatewayPut.json | 115 + .../examples/VpnGatewayUpdateTags.json | 110 + .../2018-10-01/examples/VpnSiteDelete.json | 13 + .../2018-10-01/examples/VpnSiteGet.json | 41 + .../2018-10-01/examples/VpnSiteList.json | 72 + .../examples/VpnSiteListByResourceGroup.json | 73 + .../2018-10-01/examples/VpnSitePut.json | 96 + .../examples/VpnSiteUpdateTags.json | 80 + .../VpnSitesConfigurationDownload.json | 22 + .../2018-10-01/expressRouteCircuit.json | 1951 +++++++++ .../expressRouteCrossConnection.json | 922 +++++ .../2018-10-01/expressRouteGateway.json | 648 +++ .../stable/2018-10-01/expressRoutePort.json | 747 ++++ .../stable/2018-10-01/interfaceEndpoint.json | 338 ++ .../stable/2018-10-01/loadBalancer.json | 1804 ++++++++ .../stable/2018-10-01/network.json | 213 + .../stable/2018-10-01/networkInterface.json | 1393 +++++++ .../stable/2018-10-01/networkProfile.json | 575 +++ .../2018-10-01/networkSecurityGroup.json | 848 ++++ .../stable/2018-10-01/networkWatcher.json | 3648 +++++++++++++++++ .../stable/2018-10-01/operation.json | 263 ++ .../stable/2018-10-01/publicIpAddress.json | 469 +++ .../stable/2018-10-01/publicIpPrefix.json | 440 ++ .../stable/2018-10-01/routeFilter.json | 783 ++++ .../stable/2018-10-01/routeTable.json | 654 +++ .../stable/2018-10-01/serviceCommunity.json | 149 + .../2018-10-01/serviceEndpointPolicy.json | 647 +++ .../stable/2018-10-01/usage.json | 150 + .../stable/2018-10-01/virtualNetwork.json | 1381 +++++++ .../2018-10-01/virtualNetworkGateway.json | 2817 +++++++++++++ .../stable/2018-10-01/virtualNetworkTap.json | 391 ++ .../stable/2018-10-01/virtualWan.json | 3348 +++++++++++++++ .../2018-10-01/vmssNetworkInterface.json | 389 ++ .../2018-10-01/vmssPublicIpAddress.json | 250 ++ .../network/resource-manager/readme.go.md | 10 + .../network/resource-manager/readme.md | 45 +- .../network/resource-manager/readme.python.md | 12 + 389 files changed, 50552 insertions(+), 2 deletions(-) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/availableDelegations.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/endpointService.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayBackendHealthGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsSubscriptionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallFqdnTagsListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/CheckDnsNameAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/EndpointServicesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitARPTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableSummaryList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsArpTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteProviderList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateStandardSku.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithInboundNatPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListSimple.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListVmss.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveNSGList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceLoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileCreateConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetWithContainerNic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreateWithRule.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAvailableProvidersListGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAzureReachabilityReportGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogConfigure.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogStatusQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherIpFlowVerify.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNextHopGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureQueryStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCapturesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherSecurityGroupViewGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTopologyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootResultQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/OperationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDns.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleListByRouteFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreateWithRoute.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceCommunityList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreateWithDefinition.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateServiceEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageListSpacedLocation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCheckIPAddressAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpoints.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayLearnedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaysListConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithServiceAssociationLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithSubnetDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListUsage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWanSupportedSecurityProviders.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmPublicIpList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitesConfigurationDownload.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/loadBalancer.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/network.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/operation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceCommunity.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/usage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetwork.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json new file mode 100644 index 000000000000..7dab7e5d9985 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationGateway.json @@ -0,0 +1,2358 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { + "delete": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Delete", + "x-ms-examples": { + "Delete ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayDelete.json" + } + }, + "description": "Deletes the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist" + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Get", + "x-ms-examples": { + "Get ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayGet.json" + } + }, + "description": "Gets the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_CreateOrUpdate", + "x-ms-examples": { + "Create Application Gateway": { + "$ref": "./examples/ApplicationGatewayCreate.json" + } + }, + "description": "Creates or updates the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "Parameters supplied to the create or update application gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_UpdateTags", + "x-ms-examples": { + "Update Application Gateway tags": { + "$ref": "./examples/ApplicationGatewayUpdateTags.json" + } + }, + "description": "Updates the specified application gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_List", + "x-ms-examples": { + "Lists all application gateways in a resource group": { + "$ref": "./examples/ApplicationGatewayList.json" + } + }, + "description": "Lists all application gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAll", + "x-ms-examples": { + "Lists all application gateways in a subscription": { + "$ref": "./examples/ApplicationGatewayListAll.json" + } + }, + "description": "Gets all the application gateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Start", + "x-ms-examples": { + "Start Application Gateway": { + "$ref": "./examples/ApplicationGatewayStart.json" + } + }, + "description": "Starts the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Stop", + "x-ms-examples": { + "Stop Application Gateway": { + "$ref": "./examples/ApplicationGatewayStop.json" + } + }, + "description": "Stops the specified application gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealth", + "description": "Gets the backend health of the specified application gateway in a resource group.", + "x-ms-examples": { + "Get Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableWafRuleSets", + "x-ms-examples": { + "Get Available Waf Rule Sets": { + "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" + } + }, + "description": "Lists all available web application firewall rule sets.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall rule sets.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslOptions", + "x-ms-examples": { + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + } + }, + "description": "Lists available Ssl options for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", + "x-ms-examples": { + "Get Available Ssl Predefined Policies": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all SSL predefined policies for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_GetSslPredefinedPolicy", + "x-ms-examples": { + "Get Available Ssl Predefined Policy by name": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" + } + }, + "description": "Gets Ssl predefined policy with the specified policy name.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "predefinedPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of Ssl predefined policy." + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", + "schema": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + } + } + } + } + } + }, + "definitions": { + "ApplicationGatewayBackendHealth": { + "properties": { + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" + } + } + }, + "description": "List of ApplicationGatewayBackendHealthPool resources." + }, + "ApplicationGatewayBackendHealthPool": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference of an ApplicationGatewayBackendAddressPool resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" + }, + "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." + } + }, + "description": "Application gateway BackendHealth pool." + }, + "ApplicationGatewayBackendHealthHttpSettings": { + "properties": { + "backendHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", + "description": "Reference of an ApplicationGatewayBackendHttpSettings resource." + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" + }, + "description": "List of ApplicationGatewayBackendHealthServer resources." + } + }, + "description": "Application gateway BackendHealthHttp settings." + }, + "ApplicationGatewayBackendHealthServer": { + "properties": { + "address": { + "type": "string", + "description": "IP address or FQDN of backend server." + }, + "ipConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference of IP configuration of backend server." + }, + "health": { + "type": "string", + "description": "Health of backend server.", + "enum": [ + "Unknown", + "Up", + "Down", + "Partial", + "Draining" + ], + "x-ms-enum": { + "name": "ApplicationGatewayBackendHealthServerHealth", + "modelAsString": true + } + } + }, + "description": "Application gateway backendhealth http settings." + }, + "ApplicationGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an application gateway SKU.", + "enum": [ + "Standard_Small", + "Standard_Medium", + "Standard_Large", + "WAF_Medium", + "WAF_Large", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an application gateway.", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity (instance count) of an application gateway." + } + }, + "description": "SKU of an application gateway" + }, + "ApplicationGatewaySslPolicy": { + "properties": { + "disabledSslProtocols": { + "type": "array", + "description": "Ssl protocols to be disabled on application gateway.", + "items": { + "type": "string", + "$ref": "#/definitions/ProtocolsEnum", + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + } + }, + "policyType": { + "type": "string", + "description": "Type of Ssl Policy", + "enum": [ + "Predefined", + "Custom" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyType", + "modelAsString": true + } + }, + "policyName": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of Ssl predefined policy" + }, + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order to application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Application Gateway Ssl policy." + }, + "ApplicationGatewayIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource. A subnet from where application gateway gets its private address." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the application gateway subnet resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration of an application gateway." + }, + "ApplicationGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the IP configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." + }, + "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the authentication certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Authentication certificates properties of an application gateway." + }, + "ApplicationGatewayAuthenticationCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the authentication certificate that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authentication certificates of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the trusted root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Trusted Root certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the trusted root certificate that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted Root certificates of an application gateway." + }, + "ApplicationGatewaySslCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." + }, + "password": { + "type": "string", + "description": "Password for the pfx file specified in data. Only applicable in PUT request." + }, + "publicCertData": { + "type": "string", + "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the SSL certificate resource Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of SSL certificates of an application gateway." + }, + "ApplicationGatewaySslCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the SSL certificate that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL certificates of an application gateway." + }, + "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress of the network interface IP Configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "PrivateIP allocation method.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the frontend IP configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendPortPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "Frontend port" + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the frontend port resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend port of an application gateway." + }, + "ApplicationGatewayFrontendPort": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the frontend port that is unique within an Application Gateway" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend port of an application gateway." + }, + "ApplicationGatewayBackendAddress": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fully qualified domain name (FQDN)." + }, + "ipAddress": { + "type": "string", + "description": "IP address" + } + }, + "description": "Backend address of an application gateway." + }, + "ApplicationGatewayBackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Collection of references to IPs defined in network interfaces." + }, + "backendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddress" + }, + "description": "Backend addresses" + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the backend address pool that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "type": "string", + "description": "The protocol used to communicate with the backend. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "cookieBasedAffinity": { + "type": "string", + "description": "Cookie based affinity.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCookieBasedAffinity", + "modelAsString": true + } + }, + "requestTimeout": { + "type": "integer", + "format": "int32", + "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway authentication certificates." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "connectionDraining": { + "$ref": "#/definitions/ApplicationGatewayConnectionDraining", + "description": "Connection draining of the backend http settings resource." + }, + "hostName": { + "type": "string", + "description": "Host header to be sent to the backend servers." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." + }, + "affinityCookieName": { + "type": "string", + "description": "Cookie name to use for the affinity cookie." + }, + "probeEnabled": { + "type": "boolean", + "description": "Whether the probe is enabled. Default value is false." + }, + "path": { + "type": "string", + "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendHttpSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the backend http settings that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewayHttpListenerPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "type": "string", + "description": "Protocol of the HTTP listener. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "hostName": { + "type": "string", + "description": "Host name of HTTP listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "requireServerNameIndication": { + "type": "boolean", + "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the HTTP listener resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the HTTP listener." + } + }, + "description": "Properties of HTTP listener of an application gateway." + }, + "ApplicationGatewayHttpListener": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the HTTP listener that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Http listener of an application gateway." + }, + "ApplicationGatewayPathRulePropertiesFormat": { + "properties": { + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Path rules of URL path map." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of URL path map path rule." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of URL path map path rule." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of URL path map path rule." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite rule set resource of URL path map path rule." + }, + "provisioningState": { + "type": "string", + "description": "Path rule of URL path map resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of path rule of an application gateway." + }, + "ApplicationGatewayPathRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the path rule that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Path rule of URL path map of an application gateway." + }, + "ApplicationGatewayProbePropertiesFormat": { + "properties": { + "protocol": { + "type": "string", + "description": "The protocol used for the probe. Possible values are 'Http' and 'Https'.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:" + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "the probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "unhealthyThreshold": { + "type": "integer", + "format": "int32", + "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "minServers": { + "type": "integer", + "format": "int32", + "description": "Minimum number of servers that are always marked healthy. Default value is 0." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of probe of an application gateway." + }, + "ApplicationGatewayProbeHealthResponseMatch": { + "properties": { + "body": { + "type": "string", + "description": "Body that must be contained in the health response. Default value is empty." + }, + "statusCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." + } + }, + "description": "Application gateway probe health response match" + }, + "ApplicationGatewayProbe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the probe that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Probe of the application gateway." + }, + "ApplicationGatewayRequestRoutingRulePropertiesFormat": { + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway. " + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of the application gateway." + }, + "httpListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Http listener resource of the application gateway. " + }, + "urlPathMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "URL path map resource of the application gateway." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite Rule Set resource in Basic rule of the application gateway." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of the application gateway." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the request routing rule resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of request routing rule of the application gateway." + }, + "ApplicationGatewayRequestRoutingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the request routing rule that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Request routing rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the rewrite rule set that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Rewrite rule set of an application gateway." + }, + "ApplicationGatewayRewriteRuleSetPropertiesFormat": { + "properties": { + "rewriteRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRule" + }, + "description": "Rewrite rules in the rewrite rule set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the rewrite rule set resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of rewrite rule set of the application gateway." + }, + "ApplicationGatewayRewriteRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rewrite rule that is unique within an Application Gateway." + }, + "actionSet": { + "type": "object", + "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", + "description": "Set of actions to be done as part of the rewrite Rule." + } + }, + "description": "Rewrite rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleActionSet": { + "properties": { + "requestHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Request Header Actions in the Action Set" + }, + "responseHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Response Header Actions in the Action Set" + } + }, + "description": "Set of actions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayHeaderConfiguration": { + "properties": { + "headerName": { + "type": "string", + "description": "Header name of the header configuration" + }, + "headerValue": { + "type": "string", + "description": "Header value of the header configuration" + } + }, + "description": "Header configuration of the Actions set in Application Gateway." + }, + "ApplicationGatewayRedirectConfigurationPropertiesFormat": { + "properties": { + "redirectType": { + "type": "string", + "$ref": "#/definitions/RedirectTypeEnum", + "description": "Supported http redirection types - Permanent, Temporary, Found, SeeOther.", + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + }, + "targetListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to a listener to redirect the request to." + }, + "targetUrl": { + "type": "string", + "description": "Url to redirect the request to." + }, + "includePath": { + "type": "boolean", + "description": "Include path in the redirected url." + }, + "includeQueryString": { + "type": "boolean", + "description": "Include query string in the redirected url." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Request routing specifying redirect configuration." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Url path maps specifying default redirect configuration." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Path rules specifying redirect configuration." + } + }, + "description": "Properties of redirect configuration of the application gateway." + }, + "ApplicationGatewayRedirectConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the redirect configuration that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Redirect configuration of an application gateway." + }, + "ApplicationGatewayPropertiesFormat": { + "properties": { + "sku": { + "$ref": "#/definitions/ApplicationGatewaySku", + "description": "SKU of the application gateway resource." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "operationalState": { + "readOnly": true, + "type": "string", + "description": "Operational state of the application gateway resource.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping" + ], + "x-ms-enum": { + "name": "ApplicationGatewayOperationalState", + "modelAsString": true + } + }, + "gatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Subnets of application the gateway resource." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" + }, + "description": "Authentication certificates of the application gateway resource." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" + }, + "description": "Trusted Root certificates of the application gateway resource." + }, + "sslCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslCertificate" + }, + "description": "SSL certificates of the application gateway resource." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" + }, + "description": "Frontend IP addresses of the application gateway resource." + }, + "frontendPorts": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendPort" + }, + "description": "Frontend ports of the application gateway resource." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayProbe" + }, + "description": "Probes of the application gateway resource." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "Backend address pool of the application gateway resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" + }, + "description": "Backend http settings of the application gateway resource." + }, + "httpListeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHttpListener" + }, + "description": "Http listeners of the application gateway resource." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayUrlPathMap" + }, + "description": "URL path map of the application gateway resource." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" + }, + "description": "Request routing rules of the application gateway resource." + }, + "rewriteRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" + }, + "description": "Rewrite rules for the application gateway resource." + }, + "redirectConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" + }, + "description": "Redirect configurations of the application gateway resource." + }, + "webApplicationFirewallConfiguration": { + "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", + "description": "Web application firewall configuration." + }, + "enableHttp2": { + "type": "boolean", + "description": "Whether HTTP2 is enabled on the application gateway resource." + }, + "enableFips": { + "type": "boolean", + "description": "Whether FIPS is enabled on the application gateway resource." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", + "description": "Autoscale Configuration." + }, + "resourceGuid": { + "type": "string", + "description": "Resource GUID property of the application gateway resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the application gateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the application gateway resource." + } + }, + "description": "Properties of the application gateway." + }, + "ApplicationGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the application gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Application gateway resource" + }, + "ApplicationGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "List of an application gateways in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGateways API service call." + }, + "ApplicationGatewayUrlPathMapPropertiesFormat": { + "properties": { + "defaultBackendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend address pool resource of URL path map." + }, + "defaultBackendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend http settings resource of URL path map." + }, + "defaultRewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Rewrite rule set resource of URL path map." + }, + "defaultRedirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default redirect configuration resource of URL path map." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPathRule" + }, + "description": "Path rule of URL path map resource." + }, + "provisioningState": { + "type": "string", + "description": "Provisioning state of the backend http settings resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of UrlPathMap of the application gateway." + }, + "ApplicationGatewayUrlPathMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Name of the URL path map that is unique within an Application Gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." + }, + "ApplicationGatewayWebApplicationFirewallConfiguration": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the web application firewall is enabled or not." + }, + "firewallMode": { + "type": "string", + "description": "Web application firewall mode.", + "enum": [ + "Detection", + "Prevention" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallMode", + "modelAsString": true + } + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the rule set type." + }, + "disabledRuleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" + }, + "description": "The disabled rule groups." + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether allow WAF to check request Body." + }, + "maxRequestBodySize": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maxium request body size for WAF." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maxium request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "maximum": 500, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maxium file upload size in Mb for WAF." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" + }, + "description": "The exclusion list." + } + }, + "required": [ + "enabled", + "firewallMode", + "ruleSetType", + "ruleSetVersion" + ], + "description": "Application gateway web application firewall configuration." + }, + "ApplicationGatewayAutoscaleConfiguration": { + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "exclusiveMinimum": false, + "description": "Lower bound on number of Application Gateway instances" + } + }, + "required": [ + "minCapacity" + ], + "description": "Application Gateway autoscale configuration." + }, + "ApplicationGatewayConnectionDraining": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether connection draining is enabled or not." + }, + "drainTimeoutInSec": { + "type": "integer", + "format": "int32", + "maximum": 3600, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." + } + }, + "required": [ + "enabled", + "drainTimeoutInSec" + ], + "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." + }, + "ApplicationGatewayFirewallDisabledRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the rule group that will be disabled." + }, + "rules": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." + } + }, + "required": [ + "ruleGroupName" + ], + "description": "Allows to disable rules within a rule group or an entire rule group." + }, + "ApplicationGatewayFirewallExclusion": { + "properties": { + "matchVariable": { + "type": "string", + "description": "The variable to be excluded." + }, + "selectorMatchOperator": { + "type": "string", + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + }, + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check" + }, + "ApplicationGatewayAvailableWafRuleSetsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" + }, + "description": "The list of application gateway rule sets." + } + }, + "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." + }, + "ApplicationGatewayFirewallRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleSetPropertiesFormat": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the web application firewall rule set." + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set." + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ], + "description": "Properties of the web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the web application firewall rule group." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule group." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRule" + }, + "description": "The rules of the web application firewall rule group." + } + }, + "required": [ + "ruleGroupName", + "rules" + ], + "description": "A web application firewall rule group." + }, + "ApplicationGatewayFirewallRule": { + "properties": { + "ruleId": { + "type": "integer", + "format": "int32", + "description": "The identifier of the web application firewall rule." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule." + } + }, + "required": [ + "ruleId" + ], + "description": "A web application firewall rule." + }, + "ApplicationGatewayAvailableSslOptions": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { + "properties": { + "predefinedPolicies": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of available Ssl predefined policy." + }, + "defaultPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of the Ssl predefined policy applied by default to application gateway" + }, + "availableCipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "List of available Ssl cipher suites." + }, + "availableProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolsEnum" + }, + "description": "List of available Ssl protocols." + } + }, + "description": "Properties of ApplicationGatewayAvailableSslOptions" + }, + "ApplicationGatewayAvailableSslPredefinedPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + }, + "description": "List of available Ssl predefined policy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewaySslPredefinedPolicy": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Ssl predefined policy." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "An Ssl predefined policy" + }, + "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { + "properties": { + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order for application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Properties of ApplicationGatewaySslPredefinedPolicy" + }, + "ApplicationGatewayCustomError": { + "properties": { + "statusCode": { + "type": "string", + "description": "Status code of the application gateway customer error.", + "enum": [ + "HttpStatus403", + "HttpStatus502" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCustomErrorStatusCode", + "modelAsString": true + } + }, + "customErrorPageUrl": { + "type": "string", + "description": "Error page URL of the application gateway customer error." + } + }, + "description": "Customer error of an application gateway." + }, + "PolicyNameEnum": { + "type": "string", + "description": "Ssl predefined policy name enums.", + "enum": [ + "AppGwSslPolicy20150501", + "AppGwSslPolicy20170401", + "AppGwSslPolicy20170401S" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyName", + "modelAsString": true + } + }, + "ProtocolsEnum": { + "type": "string", + "description": "Ssl protocol enums.", + "enum": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + }, + "CipherSuitesEnum": { + "type": "string", + "description": "Ssl cipher suites enums.", + "enum": [ + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslCipherSuite", + "modelAsString": true + } + }, + "RedirectTypeEnum": { + "type": "string", + "enum": [ + "Permanent", + "Found", + "SeeOther", + "Temporary" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json new file mode 100644 index 000000000000..7e28dfe0e636 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json @@ -0,0 +1,303 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { + "delete": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Delete", + "description": "Deletes the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete application security group": { "$ref": "./examples/ApplicationSecurityGroupDelete.json" } + } + }, + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Get", + "description": "Gets information about the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + } + }, + "x-ms-examples": { + "Get application security group": { "$ref": "./examples/ApplicationSecurityGroupGet.json" } + } + }, + "put": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_CreateOrUpdate", + "description": "Creates or updates an application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create application security group": { "$ref": "./examples/ApplicationSecurityGroupCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_ListAll", + "description": "Gets all application security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all application security groups": { "$ref": "./examples/ApplicationSecurityGroupListAll.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_List", + "description": "Gets all the application security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { "$ref": "./examples/ApplicationSecurityGroupList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", + "description": "Properties of the application security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "An application security group in a resource group." + }, + "ApplicationSecurityGroupPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the application security group resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Application security group properties." + }, + "ApplicationSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "A list of application security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of application security groups." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/availableDelegations.json new file mode 100644 index 000000000000..537f1e059eff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/availableDelegations.json @@ -0,0 +1,166 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource " + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Describes the actions permitted to the service upon delegation" + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json new file mode 100644 index 000000000000..bd022bf77421 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewall.json @@ -0,0 +1,766 @@ +{ + "swagger":"2.0", + "info":{ + "title":"NetworkManagementClient", + "description":"The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host":"management.azure.com", + "schemes":[ + "https" + ], + "consumes":[ + "application/json" + ], + "produces":[ + "application/json" + ], + "security":[ + { + "azure_auth":[ + "user_impersonation" + ] + } + ], + "securityDefinitions":{ + "azure_auth":{ + "type":"oauth2", + "authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize", + "flow":"implicit", + "description":"Azure Active Directory OAuth2 Flow", + "scopes":{ + "user_impersonation":"impersonate your user account" + } + } + }, + "paths":{ + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}":{ + "delete":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_Delete", + "description":"Deletes the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "$ref":"./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref":"./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "202":{ + "description":"Accepted and the operation will complete asynchronously." + }, + "204":{ + "description":"Request successful. Resource with the specified name does not exist" + }, + "200":{ + "description":"Delete successful." + } + }, + "x-ms-examples":{ + "Delete Azure Firewall":{ + "$ref":"./examples/AzureFirewallDelete.json" + } + }, + "x-ms-long-running-operation":true + }, + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_Get", + "description":"Gets the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "$ref":"./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref":"./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Request successful. The operation returns an AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + } + }, + "x-ms-examples":{ + "Get Azure Firewall":{ + "$ref":"./examples/AzureFirewallGet.json" + } + } + }, + "put":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_CreateOrUpdate", + "description":"Creates or updates the specified Azure Firewall.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "name":"azureFirewallName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the Azure Firewall." + }, + { + "name":"parameters", + "in":"body", + "required":true, + "schema":{ + "$ref":"#/definitions/AzureFirewall" + }, + "description":"Parameters supplied to the create or update Azure Firewall operation." + }, + { + "$ref":"./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref":"./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "201":{ + "description":"Create successful. The operation returns the resulting AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + }, + "200":{ + "description":"Update successful. The operation returns the resulting AzureFirewall resource.", + "schema":{ + "$ref":"#/definitions/AzureFirewall" + } + } + }, + "x-ms-examples":{ + "Create Azure Firewall":{ + "$ref":"./examples/AzureFirewallPut.json" + } + }, + "x-ms-long-running-operation":true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_List", + "description":"Lists all Azure Firewalls in a resource group.", + "parameters":[ + { + "name":"resourceGroupName", + "in":"path", + "required":true, + "type":"string", + "description":"The name of the resource group." + }, + { + "$ref":"./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref":"./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Success. The operation returns a list of AzureFirewall resources.", + "schema":{ + "$ref":"#/definitions/AzureFirewallListResult" + } + } + }, + "x-ms-examples":{ + "List all Azure Firewalls for a given resource group":{ + "$ref":"./examples/AzureFirewallListByResourceGroup.json" + } + }, + "x-ms-pageable":{ + "nextLinkName":"nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls":{ + "get":{ + "tags":[ + "AzureFirewalls" + ], + "operationId":"AzureFirewalls_ListAll", + "description":"Gets all the Azure Firewalls in a subscription.", + "parameters":[ + { + "$ref":"./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref":"./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Success. The operation returns a list of AzureFirewall resources.", + "schema":{ + "$ref":"#/definitions/AzureFirewallListResult" + } + } + }, + "x-ms-examples":{ + "List all Azure Firewalls for a given subscription":{ + "$ref":"./examples/AzureFirewallListBySubscription.json" + } + }, + "x-ms-pageable":{ + "nextLinkName":"nextLink" + } + } + } + }, + "definitions":{ + "AzureFirewallIPConfigurationPropertiesFormat":{ + "properties":{ + "privateIPAddress": { + "type": "string", + "readOnly": true, + "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." + }, + "subnet":{ + "$ref":"./network.json#/definitions/SubResource", + "description":"Reference of the subnet resource. This resource must be named 'AzureFirewallSubnet'." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource. This field is a mandatory input if subnet is not null." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of IP configuration of an Azure Firewall." + }, + "AzureFirewallIPConfiguration":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallIPConfigurationPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly": true, + "description":"A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"IP configuration of an Azure Firewall." + }, + "AzureFirewallPropertiesFormat":{ + "properties":{ + "applicationRuleCollections":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRuleCollection" + }, + "description":"Collection of application rule collections used by Azure Firewall." + }, + "natRuleCollections":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNatRuleCollection" + }, + "description":"Collection of NAT rule collections used by Azure Firewall." + }, + "networkRuleCollections":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRuleCollection" + }, + "description":"Collection of network rule collections used by Azure Firewall." + }, + "ipConfigurations":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallIPConfiguration" + }, + "description":"IP configuration of the Azure Firewall resource." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the Azure Firewall." + }, + "AzureFirewall":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallPropertiesFormat" + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/Resource" + } + ], + "description":"Azure Firewall resource" + }, + "AzureFirewallListResult":{ + "properties":{ + "value":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewall" + }, + "description":"List of Azure Firewalls in a resource group." + }, + "nextLink":{ + "type":"string", + "description":"URL to get the next set of results." + } + }, + "description":"Response for ListAzureFirewalls API service call." + }, + "AzureFirewallApplicationRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ + "type":"integer", + "format":"int32", + "maximum":65000, + "exclusiveMaximum":false, + "minimum":100, + "exclusiveMinimum":false, + "description":"Priority of the application rule collection resource." + }, + "action":{ + "$ref":"#/definitions/AzureFirewallRCAction", + "description":"The action type of a rule collection" + }, + "rules":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRule" + }, + "description":"Collection of rules used by a application rule collection." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the application rule collection." + }, + "AzureFirewallApplicationRuleCollection":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"Application rule collection resource" + }, + "AzureFirewallApplicationRuleProtocol":{ + "properties":{ + "protocolType":{ + "description":"Protocol type", + "$ref":"#/definitions/AzureFirewallApplicationRuleProtocolType" + }, + "port":{ + "type":"integer", + "format":"int32", + "maximum":64000, + "exclusiveMaximum":false, + "minimum":0, + "exclusiveMinimum":false, + "description":"Port number for the protocol, cannot be greater than 64000. This field is optional." + } + }, + "description":"Properties of the application rule protocol." + }, + "AzureFirewallApplicationRule":{ + "properties":{ + "name":{ + "type":"string", + "description":"Name of the application rule." + }, + "description":{ + "type":"string", + "description":"Description of the rule." + }, + "sourceAddresses":{ + "type":"array", + "description":"List of source IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "protocols":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallApplicationRuleProtocol" + }, + "description":"Array of ApplicationRuleProtocols." + }, + "targetFqdns":{ + "type":"array", + "description":"List of FQDNs for this rule.", + "items":{ + "type":"string" + } + }, + "fqdnTags":{ + "type":"array", + "description":"List of FQDN Tags for this rule.", + "items":{ + "type":"string" + } + } + }, + "description":"Properties of an application rule." + }, + "AzureFirewallNatRuleCollectionProperties": { + "properties":{ + "priority":{ + "type":"integer", + "format":"int32", + "maximum":65000, + "exclusiveMaximum":false, + "minimum":100, + "exclusiveMinimum":false, + "description":"Priority of the NAT rule collection resource." + }, + "action":{ + "$ref":"#/definitions/AzureFirewallNatRCAction", + "description":"The action type of a NAT rule collection" + }, + "rules":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNatRule" + }, + "description":"Collection of rules used by a NAT rule collection." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the NAT rule collection." + }, + "AzureFirewallNatRuleCollection":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallNatRuleCollectionProperties" + }, + "name":{ + "type":"string", + "description":"Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"NAT rule collection resource" + }, + "AzureFirewallNatRule":{ + "properties":{ + "name":{ + "type":"string", + "description":"Name of the NAT rule." + }, + "description":{ + "type":"string", + "description":"Description of the rule." + }, + "sourceAddresses":{ + "type":"array", + "description":"List of source IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "destinationAddresses":{ + "type":"array", + "description":"List of destination IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "destinationPorts":{ + "type":"array", + "description":"List of destination ports.", + "items":{ + "type":"string" + } + }, + "protocols":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description":"Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." + }, + "translatedAddress":{ + "type":"string", + "description":"The translated address for this NAT rule." + }, + "translatedPort":{ + "type":"string", + "description":"The translated port for this NAT rule." + } + }, + "description":"Properties of a NAT rule." + }, + "AzureFirewallNatRCAction":{ + "properties":{ + "type":{ + "description":"The type of action.", + "$ref":"#/definitions/AzureFirewallNatRCActionType" + } + }, + "description":"AzureFirewall NAT Rule Collection Action." + }, + "AzureFirewallNatRCActionType":{ + "type":"string", + "description":"The action type of a NAT rule collection", + "enum":[ + "Snat", + "Dnat" + ], + "x-ms-enum":{ + "name":"AzureFirewallNatRCActionType", + "modelAsString":true + } + }, + "AzureFirewallNetworkRuleCollectionPropertiesFormat":{ + "properties":{ + "priority":{ + "type":"integer", + "format":"int32", + "maximum":65000, + "exclusiveMaximum":false, + "minimum":100, + "exclusiveMinimum":false, + "description":"Priority of the network rule collection resource." + }, + "action":{ + "$ref":"#/definitions/AzureFirewallRCAction", + "description":"The action type of a rule collection" + }, + "rules":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRule" + }, + "description":"Collection of rules used by a network rule collection." + }, + "provisioningState":{ + "description":"The provisioning state of the resource.", + "$ref":"#/definitions/ProvisioningState" + } + }, + "description":"Properties of the network rule collection." + }, + "AzureFirewallNetworkRuleCollection":{ + "properties":{ + "properties":{ + "x-ms-client-flatten":true, + "$ref":"#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat" + }, + "name":{ + "type":"string", + "description":"Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag":{ + "type":"string", + "readOnly":true, + "description":"Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf":[ + { + "$ref":"./network.json#/definitions/SubResource" + } + ], + "description":"Network rule collection resource" + }, + "AzureFirewallNetworkRule":{ + "properties":{ + "name":{ + "type":"string", + "description":"Name of the network rule." + }, + "description":{ + "type":"string", + "description":"Description of the rule." + }, + "protocols":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description":"Array of AzureFirewallNetworkRuleProtocols." + }, + "sourceAddresses":{ + "type":"array", + "description":"List of source IP addresses for this rule.", + "items":{ + "type":"string" + } + }, + "destinationAddresses":{ + "type":"array", + "description":"List of destination IP addresses.", + "items":{ + "type":"string" + } + }, + "destinationPorts":{ + "type":"array", + "description":"List of destination ports.", + "items":{ + "type":"string" + } + } + }, + "description":"Properties of the network rule." + }, + "AzureFirewallRCAction":{ + "properties":{ + "type":{ + "description":"The type of action.", + "$ref":"#/definitions/AzureFirewallRCActionType" + } + }, + "description":"Properties of the AzureFirewallRCAction." + }, + "AzureFirewallRCActionType":{ + "type":"string", + "description":"The action type of a rule collection", + "enum":[ + "Allow", + "Deny" + ], + "x-ms-enum":{ + "name":"AzureFirewallRCActionType", + "modelAsString":true + } + }, + "ProvisioningState":{ + "type":"string", + "readOnly":true, + "description":"The current provisisoning state.", + "enum":[ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum":{ + "name":"ProvisioningState", + "modelAsString":true + } + }, + "AzureFirewallNetworkRuleProtocol":{ + "type":"string", + "description":"The protocol of a Network Rule resource", + "enum":[ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum":{ + "name":"AzureFirewallNetworkRuleProtocol", + "modelAsString":true + } + }, + "AzureFirewallApplicationRuleProtocolType":{ + "type":"string", + "description":"The protocol type of a Application Rule resource", + "enum":[ + "Http", + "Https" + ], + "x-ms-enum":{ + "name":"AzureFirewallApplicationRuleProtocolType", + "modelAsString":true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json new file mode 100644 index 000000000000..bb233724b083 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json @@ -0,0 +1,139 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewallFqdnTags": { + "get": { + "tags": [ + "AzureFirewallFqdnTags" + ], + "operationId": "AzureFirewallFqdnTags_ListAll", + "description":"Gets all the Azure Firewall FQDN Tags in a subscription.", + "parameters":[ + { + "$ref":"#/parameters/ApiVersionParameter" + }, + { + "$ref":"#/parameters/SubscriptionIdParameter" + } + ], + "responses":{ + "200":{ + "description":"Success. The operation returns a list of Azure Firewall FQDN Tag resources.", + "schema":{ + "$ref":"#/definitions/AzureFirewallFqdnTagListResult" + } + } + }, + "x-ms-examples":{ + "List all Azure Firewall FQDN Tags for a given subscription":{ + "$ref":"./examples/AzureFirewallFqdnTagsListBySubscription.json" + } + }, + "x-ms-pageable":{ + "nextLinkName":"nextLink" + } + } + } + }, + "definitions": { + "AzureFirewallFqdnTagPropertiesFormat": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource." + }, + "fqdnTagName": { + "type": "string", + "readOnly": true, + "description": "The name of this FQDN Tag." + } + }, + "description": "Azure Firewall FQDN Tag Properties" + }, + "AzureFirewallFqdnTag": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall FQDN Tag Resource" + }, + "AzureFirewallFqdnTagListResult":{ + "properties":{ + "value":{ + "type":"array", + "items":{ + "$ref":"#/definitions/AzureFirewallFqdnTag" + }, + "description":"List of Azure Firewall FQDN Tags in a resource group." + }, + "nextLink":{ + "type":"string", + "description":"URL to get the next set of results." + } + }, + "description":"Response for ListAzureFirewallFqdnTags API service call." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json new file mode 100644 index 000000000000..418de8fc4003 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json @@ -0,0 +1,88 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability": { + "get": { + "operationId": "CheckDnsNameAvailability", + "description": "Checks whether a domain name in the cloudapp.azure.com zone is available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "domainNameLabel", + "in": "query", + "required": true, + "type": "string", + "description": "The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the DNS name is available.", + "schema": { + "$ref": "#/definitions/DnsNameAvailabilityResult" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { "$ref": "./examples/CheckDnsNameAvailability.json" } + } + } + } + }, + "definitions": { + "DnsNameAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Domain availability (True/False)." + } + }, + "description": "Response for the CheckDnsNameAvailability API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json new file mode 100644 index 000000000000..b08f7a906670 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json @@ -0,0 +1,343 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}": { + "delete": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Delete", + "description": "Deletes the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanDelete.json" + } + } + }, + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Get", + "description": "Gets information about the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + } + }, + "x-ms-examples": { + "Get DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanGet.json" + } + } + }, + "put": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_CreateOrUpdate", + "description": "Creates or updates a DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_List", + "description": "Gets all DDoS protection plans in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all DDoS protection plans": { + "$ref": "./examples/DdosProtectionPlanListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_ListByResourceGroup", + "description": "Gets all the DDoS protection plans in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + } + }, + "x-ms-examples": { + "List DDoS protection plans in resource group": { + "$ref": "./examples/DdosProtectionPlanList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DdosProtectionPlan": { + "description": "A DDoS protection plan in a resource group.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosProtectionPlanPropertiesFormat", + "description": "Properties of the DDoS protection plan." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "DdosProtectionPlanPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the DDoS protection plan resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + }, + "virtualNetworks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of virtual networks associated with the DDoS protection plan resource. This list is read-only." + } + }, + "description": "DDoS protection plan properties." + }, + "DdosProtectionPlanListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "A list of DDoS protection plans." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of DDoS protection plans." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/endpointService.json new file mode 100644 index 000000000000..f786d0e70102 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/endpointService.json @@ -0,0 +1,111 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { "$ref": "./examples/EndpointServicesList.json" } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsGet.json new file mode 100644 index 000000000000..80f6240dd1cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsGet.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json new file mode 100644 index 000000000000..80f6240dd1cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json new file mode 100644 index 000000000000..e3715b2fcb2c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "predefinedPolicyName": "AppGwSslPolicy20150501" + }, + "responses": { + "200": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json new file mode 100644 index 000000000000..752ac4559fa0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OWASP_3.0", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets/", + "type": "Microsoft.Network/applicationGatewayAvailableWafRuleSets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200004, + "description": "Possible Multipart Unmatched Boundary." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayBackendHealthGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayBackendHealthGet.json new file mode 100644 index 000000000000..4bc8ce00b427 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayBackendHealthGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "appgw", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "backendAddressPools": [ + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.8", + "health": "Up" + } + ] + } + ] + }, + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + ] + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayCreate.json new file mode 100644 index 000000000000..cc72751af2d7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayCreate.json @@ -0,0 +1,701 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "parameters": { + "identity": { + "type":"UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "****", + "password": "****" + } + }, + { + "name": "sslcert2", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedRootCertificates": [ + { + "name": "rootcert", + "properties": { + "data": "****" + } + }, + { + "name": "rootcert1", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + }, + { + "name": "appgwfp80", + "properties": { + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "properties": { + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "properties": { + "paths": [ + "/api", "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "properties": { + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "properties": { + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ] + } + } + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ] + } + } + ] + } + } + ], + "probes": [] + } + } + }, + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ] + } + } + ] + } + } + ], + "probes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayDelete.json new file mode 100644 index 000000000000..76cd1cb39495 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayGet.json new file mode 100644 index 000000000000..99ea2be67476 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayGet.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ] + } + } + ] + } + } + ], + "probes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayList.json new file mode 100644 index 000000000000..ffbb9e84b6dc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayList.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayListAll.json new file mode 100644 index 000000000000..42f23c0bc009 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayListAll.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStart.json new file mode 100644 index 000000000000..2e355fe8fdd3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStop.json new file mode 100644 index 000000000000..2e355fe8fdd3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayUpdateTags.json new file mode 100644 index 000000000000..e045515db52e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationGatewayUpdateTags.json @@ -0,0 +1,148 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "applicationGatewayName" : "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupCreate.json new file mode 100644 index 000000000000..ba3897e93172 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupCreate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "parameters": { + "location": "westus", + "properties": { } + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupDelete.json new file mode 100644 index 000000000000..4e19fbde1d50 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupGet.json new file mode 100644 index 000000000000..1ad27f74041a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupList.json new file mode 100644 index 000000000000..6f3330d2b17d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupList.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } + } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupListAll.json new file mode 100644 index 000000000000..7aa76d127665 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ApplicationSecurityGroupListAll.json @@ -0,0 +1,34 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsResourceGroupGet.json new file mode 100644 index 000000000000..b85d96c2b4cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "location": "regionName", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsSubscriptionGet.json new file mode 100644 index 000000000000..389f618e833e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AvailableDelegationsSubscriptionGet.json @@ -0,0 +1,24 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "location": "regionName", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallDelete.json new file mode 100644 index 000000000000..3d568db64489 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "azureFirewallName" : "azurefirewall" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallFqdnTagsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallFqdnTagsListBySubscription.json new file mode 100644 index 000000000000..97bf4ed560d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallFqdnTagsListBySubscription.json @@ -0,0 +1,28 @@ +{ + "parameters":{ + "api-version":"2018-10-01", + "subscriptionId":"subid" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"azfwfqdntag", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewallFqdnTags/azfwfqdntag", + "type":"Microsoft.Network/azureFirewallFqdnTags", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "fqdnTagName":"azfwfqdntag" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallGet.json new file mode 100644 index 000000000000..e32c34ce534b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallGet.json @@ -0,0 +1,128 @@ +{ + "parameters":{ + "api-version": "2018-10-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1", + "azureFirewallName":"azurefirewall" + }, + "responses":{ + "200":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListByResourceGroup.json new file mode 100644 index 000000000000..e6081ccb4160 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListByResourceGroup.json @@ -0,0 +1,131 @@ +{ + "parameters":{ + "api-version": "2018-10-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListBySubscription.json new file mode 100644 index 000000000000..436e755280e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallListBySubscription.json @@ -0,0 +1,130 @@ +{ + "parameters":{ + "api-version": "2018-10-01", + "subscriptionId":"subid" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallPut.json new file mode 100644 index 000000000000..71565f3e3947 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/AzureFirewallPut.json @@ -0,0 +1,352 @@ +{ + "parameters":{ + "api-version": "2018-10-01", + "subscriptionId":"subid", + "resourceGroupName":"rg1", + "azureFirewallName":"azurefirewall", + "parameters":{ + "tags":{ + "key1":"value1" + }, + "properties":{ + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "properties":{ + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses":{ + "200":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "201":{ + "body":{ + "name":"azurefirewall", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type":"Microsoft.Network/azureFirewalls", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "location":"West US", + "tags":{ + "key1":"value1" + }, + "properties":{ + "provisioningState":"Succeeded", + "ipConfigurations":[ + { + "name":"azureFirewallIpConfiguration", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag":"w/\\00000000-0000-0000-0000-000000000000\\", + "properties":{ + "provisioningState":"Succeeded", + "privateIPAddress":"10.0.0.0", + "subnet":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress":{ + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections":[ + { + "name":"apprulecoll", + "properties":{ + "priority":110, + "action":"Deny", + "rules":[ + { + "name":"rule1", + "description":"Deny inbound rule", + "protocols":[ + { + "protocolType":"Https", + "port":443 + } + ], + "targetFqdns":[ + "www.test.com" + ], + "sourceAddresses":[ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections":[ + { + "name":"natrulecoll", + "properties":{ + "priority":112, + "action":"Dnat", + "rules":[ + { + "name":"DNAT-HTTPS-traffic", + "description":"D-NAT all outbound web traffic for inspection", + "sourceAddresses":[ + "*" + ], + "destinationAddresses":[ + "1.2.3.4" + ], + "destinationPorts":[ + "443" + ], + "protocols":[ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + } + ] + } + } + ], + "networkRuleCollections":[ + { + "name":"netrulecoll", + "properties":{ + "priority":112, + "action":"Deny", + "rules":[ + { + "name":"L4-traffic", + "description":"Block traffic based on source IPs and ports", + "sourceAddresses":[ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts":[ + "443-444", + "8443" + ], + "destinationAddresses":[ + "*" + ], + "protocols":[ + "TCP" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/CheckDnsNameAvailability.json new file mode 100644 index 000000000000..a30e5f252fa2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/CheckDnsNameAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "location" : "westus", + "domainNameLabel" : "testdns" + }, + "responses" : { + "200" : { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanCreate.json new file mode 100644 index 000000000000..b3748727f8ba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + }, + "201": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanDelete.json new file mode 100644 index 000000000000..6a7b805b2e69 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanGet.json new file mode 100644 index 000000000000..83a3bed1d587 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanList.json new file mode 100644 index 000000000000..5498fa6128fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanListAll.json new file mode 100644 index 000000000000..d27dbcfb4944 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DdosProtectionPlanListAll.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleGet.json new file mode 100644 index 000000000000..23dbb7930796 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleList.json new file mode 100644 index 000000000000..7d47326bdd06 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/DefaultSecurityRuleList.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/EndpointServicesList.json new file mode 100644 index 000000000000..dd24826a99c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/EndpointServicesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitARPTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitARPTableList.json new file mode 100644 index 000000000000..3404123c3433 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitARPTableList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + }, + "202": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationCreate.json new file mode 100644 index 000000000000..ea882e1cf236 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -0,0 +1,39 @@ +{ + "parameters":{ + "circuitName":"circuitName", + "resourceGroupName":"rg1", + "authorizationName":"authorizatinName", + "api-version": "2018-10-01", + "subscriptionId":"subid", + "authorizationParameters":{ + "properties": { + "authorizationKey": "authKey", + "authorizationUseStatus":"Available" + } + } + }, + "responses":{ + "201":{ + "body":{ + "name":"authorizationName", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties":{ + "provisioningState":"Updating", + "authorizationUseStatus":"Available" + } + } + }, + "200":{ + "body":{ + "name":"authorizationName", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/authorizations/authorizationName", + "etag":"W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties":{ + "provisioningState":"Updating", + "authorizationUseStatus":"Available" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationDelete.json new file mode 100644 index 000000000000..b6fad4e71906 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -0,0 +1,20 @@ +{ + "parameters":{ + "circuitName":"circuitName", + "resourceGroupName":"rg1", + "api-version": "2018-10-01", + "subscriptionId":"subid", + "authorizationName":"authorizationName" + }, + "responses":{ + "200":{ + + }, + "202":{ + + }, + "204":{ + + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationGet.json new file mode 100644 index 000000000000..576925b9df1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationList.json new file mode 100644 index 000000000000..97b432f3c266 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitAuthorizationList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionCreate.json new file mode 100644 index 000000000000..93cf3d17941f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionCreate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections", + "expressRouteCircuitConnectionParameters": { + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/29" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionDelete.json new file mode 100644 index 000000000000..78087b08d8ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..c988a43b5ba0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreate.json new file mode 100644 index 000000000000..b8c53891801e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + }, + "properties": { + "authorizations": [], + "peerings": [], + "allowClassicOperations": false, + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + } + }, + "location": "West US" + } + }, + "responses": { + "201": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + }, + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json new file mode 100644 index 000000000000..3f2e46e7f1f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "type": "Microsoft.Network/expressRouteCircuits", + "circuitName": "expressRouteCircuit1", + "parameters": { + "location": "westus", + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + }, + "properties": { + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + }, + "201": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps":10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitDelete.json new file mode 100644 index 000000000000..cea07629b30a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitGet.json new file mode 100644 index 000000000000..cba761de2468 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListByResourceGroup.json new file mode 100644 index 000000000000..92e098d148cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "262effd3-248d-4754-9068-0a89260dd918", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "47853fd2-9261-4670-b7c3-2debcf9b88da", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListBySubscription.json new file mode 100644 index 000000000000..64612a8c6d6d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitListBySubscription.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "262effd3-248d-4754-9068-0a89260dd918", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "47853fd2-9261-4670-b7c3-2debcf9b88da", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringCreate.json new file mode 100644 index 000000000000..3c55a37e55c9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringDelete.json new file mode 100644 index 000000000000..0cf95abd0083 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringGet.json new file mode 100644 index 000000000000..fb47bbd1f815 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "MicrosoftPeering" + }, + "responses": { + "200": { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringList.json new file mode 100644 index 000000000000..d73f10927a48 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringList.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "expressRouteConnection": "" + } + }, + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "10.0.0.0/30", + "secondaryPeerAddressPrefix": "10.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringStats.json new file mode 100644 index 000000000000..22bf9484d391 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitPeeringStats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": { + "primaryBytesIn": 537408, + "primaryBytesOut": 44032550, + "secondaryBytesIn": 0, + "secondaryBytesOut": 39002500 + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableList.json new file mode 100644 index 000000000000..84c20369b80e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + }, + "202": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableSummaryList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableSummaryList.json new file mode 100644 index 000000000000..e1c11c41e2b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitRouteTableSummaryList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + }, + "202": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitStats.json new file mode 100644 index 000000000000..1306127c47d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitStats.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "primaryBytesIn": 537408, + "primaryBytesOut": 44032550, + "secondaryBytesIn": 0, + "secondaryBytesOut": 39002500 + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitUpdateTags.json new file mode 100644 index 000000000000..41143924aa0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "ertest", + "circuitName" : "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionCreate.json new file mode 100644 index 000000000000..13b88d4aef74 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionCreate.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "connectionName": "connectionName", + "putExpressRouteConnectionParameters": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "name": "connectionName", + "properties": { + "routingWeight": 2, + "authorizationKey": "authorizationKey", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2 + } + } + }, + "201": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2 + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionDelete.json new file mode 100644 index 000000000000..4875ced216fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "connectionName": "connectionName", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionGet.json new file mode 100644 index 000000000000..c3850c09bfe3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "connectionName": "connectionName" + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionList.json new file mode 100644 index 000000000000..ef7f48cbb367 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteConnectionList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "resourceGroupName", + "expressRouteGatewayName": "expressRouteGatewayName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json new file mode 100644 index 000000000000..a95d660b8bc8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json new file mode 100644 index 000000000000..e0b21ef22405 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + }, + "202": { + }, + "204": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json new file mode 100644 index 000000000000..0bf90b58ac59 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json new file mode 100644 index 000000000000..1e74005b78f0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionGet.json new file mode 100644 index 000000000000..66e19c92b565 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "" + }, + "responses" : { + "200" : { + "body" : { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionList.json new file mode 100644 index 000000000000..2799dbfb3ff2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json new file mode 100644 index 000000000000..0bb1e2450bb1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "CrossConnection-SiliconValley", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdate.json new file mode 100644 index 000000000000..b7053f7f7257 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "", + "parameters": { + "properties": { + "serviceProviderProvisioningState": "NotProvisioned" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdateTags.json new file mode 100644 index 000000000000..dd959cd7f9ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "CrossConnection-SiliconValley", + "crossConnectionName" : "", + "crossConnectionParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsArpTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsArpTable.json new file mode 100644 index 000000000000..e18b44976a8f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsArpTable.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft" , + "ipAddress": "192.116.14.254", + "macAddress": "885a.9269.9110" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTable.json new file mode 100644 index 000000000000..301e95a87ebc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "10.6.0.0/16", + "nextHop": "10.6.1.12" , + "locPrf": "", + "weight": 0, + "path": "65514" + }, + { + "network": "10.7.0.0/16", + "nextHop": "10.7.1.13" , + "locPrf": "", + "weight": 0, + "path": "65514" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json new file mode 100644 index 000000000000..fccf6249502d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "10.6.1.112", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "Active" + }, + { + "neighbor": "10.6.1.113", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "1" + } + ] + } + }, + "202": { + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayCreate.json new file mode 100644 index 000000000000..0f551065fbb0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayCreate.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "subscriptionId": "subid", + "resourceGroupName": "resourceGroupName", + "api-version": "2018-10-01", + "putExpressRouteGatewayParameters": { + "name": "gateway-2", + "type": "Microsoft.Network/expressRouteGateways", + "location": "westus", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupId/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + }, + "200": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayDelete.json new file mode 100644 index 000000000000..cbbc26d0a92b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayGet.json new file mode 100644 index 000000000000..63a6dc496d87 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + } + } + } + }, + "404": {} + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListByResourceGroup.json new file mode 100644 index 000000000000..85fb86f7b928 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListByResourceGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1 + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListBySubscription.json new file mode 100644 index 000000000000..4eea871fa916 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteGatewayListBySubscription.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1 + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkGet.json new file mode 100644 index 000000000000..72b201e652b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "linkName": "linkName" + }, + "responses": { + "200": { + "body": { + "name": "linkName", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/linkName", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkList.json new file mode 100644 index 000000000000..108beccfa0a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteLinkList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "name": "link2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortCreate.json new file mode 100644 index 000000000000..12f64e4b6101 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortCreate.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortDelete.json new file mode 100644 index 000000000000..3428d2059476 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortGet.json new file mode 100644 index 000000000000..3270169e3f69 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortList.json new file mode 100644 index 000000000000..7bbbf6bc4aff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortListByResourceGroup.json new file mode 100644 index 000000000000..3fb4aa93ece2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortListByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateLink.json new file mode 100644 index 000000000000..75b1b9460fa7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateLink.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "links": [ + { + "name":"link1", + "properties": { + "adminState": "Enabled" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateTags.json new file mode 100644 index 000000000000..2b1b310c34d0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortUpdateTags.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName", + "type": "Microsofot.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationGet.json new file mode 100644 index 000000000000..e28c51f246bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01", + "locationName": "locationName" + }, + "responses": { + "200": { + "body": { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsofot.Network/expressRoutePortsLocations/locationName", + "type": "Microsofot.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + { + "offerName": "100 Gbps", + "valueInGbps": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationList.json new file mode 100644 index 000000000000..75f7327ee3bc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRoutePortsLocationList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsofot.Network/expressRoutePortsLocations/locationName", + "type": "Microsofot.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteProviderList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteProviderList.json new file mode 100644 index 000000000000..e1daa48b394f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteProviderList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "name": "providerName", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/", + "type": "Microsoft.Network/expressRouteServiceProviders", + "properties": { + "provisioningState": "Succeeded", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ], + "bandwidthsOffered": [ + { + "offerName": "50Mbps", + "valueInMbps": 50 + }, + { + "offerName": "100Mbps", + "valueInMbps": 100 + }, + { + "offerName": "200Mbps", + "valueInMbps": 200 + }, + { + "offerName": "500Mbps", + "valueInMbps": 500 + }, + { + "offerName": "1Gbps", + "valueInMbps": 1000 + }, + { + "offerName": "2Gbps", + "valueInMbps": 2000 + }, + { + "offerName": "5Gbps", + "valueInMbps": 5000 + }, + { + "offerName": "10Gbps", + "valueInMbps": 10000 + } + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionDelete.json new file mode 100644 index 000000000000..21b9be0dfbb8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionGet.json new file mode 100644 index 000000000000..932f09281bfa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionList.json new file mode 100644 index 000000000000..156c919954d7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + }, + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionPut.json new file mode 100644 index 000000000000..8a91d0ff750b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/HubVirtualNetworkConnectionPut.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "hubVirtualNetworkConnectionParameters": { + "properties": { + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + }, + "201": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/vnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleCreate.json new file mode 100644 index 000000000000..509ea57bdf1a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleCreate.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1"}, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableTcpReset": true, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleDelete.json new file mode 100644 index 000000000000..35058eec8fb8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleGet.json new file mode 100644 index 000000000000..410f19765519 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleList.json new file mode 100644 index 000000000000..c3d52a4c9e49 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InboundNatRuleList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json new file mode 100644 index 000000000000..a95ab3fb56a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointCreate.json @@ -0,0 +1,67 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe", + "parameters": { + "properties": { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "provisioningState": "Succeded", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + }, + "201" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointDelete.json new file mode 100644 index 000000000000..9971ab004bb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId", + "resourceGroupName": "rg1", + "interfaceEndpointName": "testIe" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointGet.json new file mode 100644 index 000000000000..7bcf263217c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointGet.json @@ -0,0 +1,34 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "interfaceEndpointName" : "testIe" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testIe", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/testIe", + "type" : "Microsoft.Network/interfaceEndpoints", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testIe.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointList.json new file mode 100644 index 000000000000..e7f3a033c6ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointList.json @@ -0,0 +1,59 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointListAll.json new file mode 100644 index 000000000000..3ca0ed68eef9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/InterfaceEndpointListAll.json @@ -0,0 +1,80 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "uniqueIdentifier.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie1.nic.abcd1234" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/interfaceEndpoints/ie2", + "name": "ie2", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "alsoUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/otherResourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/ie2.nic.zyxw9876" + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/interfaceEndpoints/ie1", + "name": "ie1", + "type": "Microsoft.Network/interfaceEndpoints", + "location": "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "fqdn": "stillVeryUnique.fqdn.windows.net", + "owner": "User", + "endpointService": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Provider/resourceType/resourceName" + }, + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/ie1.nic.efgh5463" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolGet.json new file mode 100644 index 000000000000..7f2831e8480c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolList.json new file mode 100644 index 000000000000..9b109ad146a1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerBackendAddressPoolList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreate.json new file mode 100644 index 000000000000..72ad33843b52 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreate.json @@ -0,0 +1,338 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateStandardSku.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateStandardSku.json new file mode 100644 index 000000000000..7a951554f403 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateStandardSku.json @@ -0,0 +1,335 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithInboundNatPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithInboundNatPool.json new file mode 100644 index 000000000000..0e404ceb7d70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithInboundNatPool.json @@ -0,0 +1,168 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "properties": { + "serviceEndpoints": [], + "resourceNavigationLinks": [] + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + } + }, + "name": "test", + "zones": [], + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [ + { + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + }, + "protocol": "Tcp", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "enableTcpReset": true + }, + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ], + "outboundRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithZones.json new file mode 100644 index 000000000000..4ec9e4f697da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerCreateWithZones.json @@ -0,0 +1,335 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + }, + "zones": [ "1" ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": { + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "zones": [ "1" ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerDelete.json new file mode 100644 index 000000000000..dce1923dabbc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationGet.json new file mode 100644 index 000000000000..93b7282d8098 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "frontendIPConfigurationName": "frontend", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationList.json new file mode 100644 index 000000000000..83ac26c824f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerFrontendIPConfigurationList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerGet.json new file mode 100644 index 000000000000..673ba161cc30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerGet.json @@ -0,0 +1,127 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb" + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerList.json new file mode 100644 index 000000000000..7c07913ff7e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerList.json @@ -0,0 +1,142 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerListAll.json new file mode 100644 index 000000000000..5280177210fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerListAll.json @@ -0,0 +1,141 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration":{ + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleGet.json new file mode 100644 index 000000000000..4583b0ec944a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rule1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleList.json new file mode 100644 index 000000000000..b46dad6a65d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerLoadBalancingRuleList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListSimple.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListSimple.json new file mode 100644 index 000000000000..b91bc004556d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListSimple.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mynic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inbound1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListVmss.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListVmss.json new file mode 100644 index 000000000000..c1ecbd8199ce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerNetworkInterfaceListVmss.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules":[ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleGet.json new file mode 100644 index 000000000000..587b096df1e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "outboundRuleName": "rule1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleList.json new file mode 100644 index 000000000000..ba4e3d098a67 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerOutboundRuleList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeGet.json new file mode 100644 index 000000000000..ed93d4353a8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "probeName": "probe1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeList.json new file mode 100644 index 000000000000..e84cd03d01fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerProbeList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerUpdateTags.json new file mode 100644 index 000000000000..90f7be97cb4d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LoadBalancerUpdateTags.json @@ -0,0 +1,132 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "loadBalancerName" : "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayCreate.json new file mode 100644 index 000000000000..7edc4d839f6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayCreate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw", + "parameters": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + }, + "location": "Central US" + } + }, + "responses" : { + "201" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + }, + "200" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayDelete.json new file mode 100644 index 000000000000..02705fa8e9ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayGet.json new file mode 100644 index 000000000000..14ac26915f80 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName" : "localgw" + }, + "responses" : { + "200" : { + "body" : { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayList.json new file mode 100644 index 000000000000..fc9d1294bb91 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "localgw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + }, + { + "name": "localgw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.2.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..238e094e1918 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/LocalNetworkGatewayUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceCreate.json new file mode 100644 index 000000000000..fe05f9e153ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceCreate.json @@ -0,0 +1,98 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + }, + "201" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceDelete.json new file mode 100644 index 000000000000..763d215dd0d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveNSGList.json new file mode 100644 index 000000000000..c7009a65c3ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association" : { + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules" : [ + { + "name" : "securityRules/rule1", + "protocol" : "Tcp", + "sourcePortRange" : "456-456", + "destinationPortRange" : "6579-6579", + "sourceAddressPrefix" : "0.0.0.0/32", + "destinationAddressPrefix" : "0.0.0.0/32", + "access" : "Allow", + "priority" : 234, + "direction" : "Inbound" + }, + { + "name" : "securityRules/default-allow-rdp", + "protocol" : "Tcp", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "3389-3389", + "sourceAddressPrefix" : "1.1.1.1/32", + "destinationAddressPrefix" : "0.0.0.0/0", + "access" : "Allow", + "priority" : 1000, + "direction" : "Inbound" + }, + { + "name" : "defaultSecurityRules/AllowInternetOutBound", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "0.0.0.0/0", + "destinationAddressPrefix" : "Internet", + "expandedDestinationAddressPrefix" : [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access" : "Allow", + "priority" : 65001, + "direction" : "Outbound" + } + ] + } + ] + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveRouteTableList.json new file mode 100644 index 000000000000..25ab47adfa09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceGet.json new file mode 100644 index 000000000000..307b283b5265 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceGet.json @@ -0,0 +1,55 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [ + { + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationGet.json new file mode 100644 index 000000000000..4537af7af88c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "ipConfigurationName": "ipconfig1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ], + "virtualNetworkTaps": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP1" + }, + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationList.json new file mode 100644 index 000000000000..4172b7e387fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceIPConfigurationList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet12/subnets/subnet12" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceList.json new file mode 100644 index 000000000000..632b79fcb195 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceList.json @@ -0,0 +1,90 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceListAll.json new file mode 100644 index 000000000000..358dba9481a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceListAll.json @@ -0,0 +1,89 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "test.bx.internal.cloudapp.net" + }, + "macAddress" : "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type" : "Microsoft.Network/networkInterfaces" + }, + { + "name" : "test-nic2", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location" : "eastus", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceLoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceLoadBalancerList.json new file mode 100644 index 000000000000..2d8cb370cf56 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceLoadBalancerList.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lbname1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "frontendIPConfigurations": [ + { + "name": "lbfrontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/myDynamicPublicIP" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "bepool1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1" + } + } + } + ], + "probes": [ + { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inbound1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json new file mode 100644 index 000000000000..80a4059ebd3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2018-10-01", + "tapConfigurationParameters": { + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + }, + "201" : { + "body" : { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationDelete.json new file mode 100644 index 000000000000..b7dc270489bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-networkinterface", + "tapConfigurationName": "test-tapconfiguration" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json new file mode 100644 index 000000000000..219eb0907821 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": + { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json new file mode 100644 index 000000000000..a982d6013bba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceTapConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "mynic" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceUpdateTags.json new file mode 100644 index 000000000000..297d626b6203 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkInterfaceUpdateTags.json @@ -0,0 +1,55 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-nic", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [{ + "name" : "ipconfig1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "172.20.2.4", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4" + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [] + }, + "enableAcceleratedNetworking" : true, + "enableIPForwarding" : false + }, + "type" : "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileCreateConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileCreateConfigOnly.json new file mode 100644 index 000000000000..9f82c3361808 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileCreateConfigOnly.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1", + "location": "westus", + "parameters": { + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + }, + "201": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileDelete.json new file mode 100644 index 000000000000..faf1981ac845 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetConfigOnly.json new file mode 100644 index 000000000000..5cd7472d9d30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetConfigOnly.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetWithContainerNic.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetWithContainerNic.json new file mode 100644 index 000000000000..77d274e2bb12 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileGetWithContainerNic.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [ + { + "name": "containerGroup1_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup1_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileList.json new file mode 100644 index 000000000000..df4608d364c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileList.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileListAll.json new file mode 100644 index 000000000000..6412e8bf0a7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileListAll.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileUpdateTags.json new file mode 100644 index 000000000000..3f3749987da6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkProfileUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "test-np", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-np", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-np", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreate.json new file mode 100644 index 000000000000..15a499c4c26f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreate.json @@ -0,0 +1,231 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreateWithRule.json new file mode 100644 index 000000000000..a66afd7aa2fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -0,0 +1,281 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupDelete.json new file mode 100644 index 000000000000..dc966a14aa81 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupGet.json new file mode 100644 index 000000000000..0f12b945940e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupGet.json @@ -0,0 +1,136 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupList.json new file mode 100644 index 000000000000..86300849ca7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupList.json @@ -0,0 +1,231 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupListAll.json new file mode 100644 index 000000000000..b7717d1bbed3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupListAll.json @@ -0,0 +1,230 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleCreate.json new file mode 100644 index 000000000000..7d374e60d1b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleDelete.json new file mode 100644 index 000000000000..eba72d107013 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleGet.json new file mode 100644 index 000000000000..e474cf2325cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "securityRuleName": "rule1" + }, + "responses" : { + "200" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleList.json new file mode 100644 index 000000000000..c826dd29e8e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupRuleList.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..2eb4ca5aa22a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkSecurityGroupUpdateTags.json @@ -0,0 +1,130 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkSecurityGroupName" : "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAvailableProvidersListGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAvailableProvidersListGet.json new file mode 100644 index 000000000000..70055f048ba4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAvailableProvidersListGet.json @@ -0,0 +1,66 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "azureLocations" : [ "West US" ], + "country" : "United States", + "state" : "washington", + "city" : "seattle" + } + }, + "responses" : { + "200" : { + "body" : { + "countries" : [ + { + "countryName" : "United States", + "states" : [ + { + "stateName" : "washington", + "cities" : [ + { + "cityName" : "seattle", + "providers" : [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + }, + "202" : { + "body" : { + "countries" : [ + { + "countryName" : "United States", + "states" : [ + { + "stateName" : "washington", + "cities" : [ + { + "cityName" : "seattle", + "providers" : [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAzureReachabilityReportGet.json new file mode 100644 index 000000000000..e973170adf35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -0,0 +1,82 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "providers" : [ + "Frontier Communications of America, Inc. - ASN 5650" + ], + "azureLocations" : [ + "West US" + ], + "startTime": "2017-09-07T00:00:00Z", + "endTime": "2017-09-10T00:00:00Z" + } + }, + "responses" : { + "200" : { + "body" : { + "aggregationLevel" : "State", + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "reachabilityReport" : [ + { + "provider" : "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + }, + "202" : { + "body" : { + "aggregationLevel" : "State", + "providerLocation" : { + "country" : "United States", + "state" : "washington" + }, + "reachabilityReport" : [ + { + "provider" : "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorCreate.json new file mode 100644 index 000000000000..7fdba50f00fc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorCreate.json @@ -0,0 +1,70 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1", + "location": "centraluseuap", + "parameters" : { + "properties": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60 + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties" : { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties" : { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorDelete.json new file mode 100644 index 000000000000..3d62cd280728 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "204" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorGet.json new file mode 100644 index 000000000000..06f6b9bf9279 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorGet.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorList.json new file mode 100644 index 000000000000..1e1c20644618 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorList.json @@ -0,0 +1,60 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "cm1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + }, + { + "name" : "cm2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm2", + "port": 0 + }, + "destination": { + "address": "google.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 30, + "autoStart": true, + "startTime": "2018-01-08T05:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorQuery.json new file mode 100644 index 000000000000..39f7faa1d36b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorQuery.json @@ -0,0 +1,77 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : { + "body" : { + "sourceStatus": "Active", + "states" : [ + { + "connectionState" : "Reachable", + "startTime" : "2018-01-08T03:42:33.3387305Z", + "endTime" : "2018-01-08T05:12:41.5265438Z", + "evaluationState" : "Completed", + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ] + } + ] + } + }, + "202" : { + "body" : { + "sourceStatus": "Active", + "states" : [ + { + "connectionState" : "Reachable", + "startTime" : "2018-01-08T03:42:33.3387305Z", + "endTime" : "2018-01-08T05:12:41.5265438Z", + "evaluationState" : "Completed", + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStart.json new file mode 100644 index 000000000000..55c9152ea922 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStart.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStop.json new file mode 100644 index 000000000000..55c9152ea922 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectionMonitorStop.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "connectionMonitorName" : "cm1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json new file mode 100644 index 000000000000..e98fb4c19f8c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json @@ -0,0 +1,79 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "source" : { + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination" : { + "address" : "192.168.100.4", + "port" : 3389 + } + } + }, + "responses" : { + "200" : { + "body" : { + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwork", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ], + "connectionStatus" : "Connected", + "avgLatencyInMs" : 1, + "minLatencyInMs" : 1, + "maxLatencyInMs" : 4, + "probesSent" : 100, + "probesFailed" : 0 + } + }, + "202" : { + "body" : { + "hops" : [ + { + "type" : "Source", + "id" : "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address" : "10.1.1.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds" : [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues" : [] + }, + { + "type" : "VirtualNetwor", + "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", + "address" : "192.168.100.4", + "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds" : [], + "issues" : [] + } + ], + "connectionStatus" : "Connected", + "avgLatencyInMs" : 1, + "minLatencyInMs" : 1, + "maxLatencyInMs" : 4, + "probesSent" : 100, + "probesFailed" : 0 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherCreate.json new file mode 100644 index 000000000000..8e5476283996 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherCreate.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "location" : "eastus", + "properties" : { + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + }, + "201" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherDelete.json new file mode 100644 index 000000000000..8fb8cc72c346 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherDelete.json @@ -0,0 +1,12 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "202" : {}, + "204" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogConfigure.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogConfigure.json new file mode 100644 index 000000000000..9307ecc1d838 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogConfigure.json @@ -0,0 +1,35 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "responses" : { + "200" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "202" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogStatusQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogStatusQuery.json new file mode 100644 index 000000000000..9cd2a1885b26 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherFlowLogStatusQuery.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + } + }, + "responses" : { + "200" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + }, + "202" : { + "body" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled" : true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherGet.json new file mode 100644 index 000000000000..5369a3b49f88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherGet.json @@ -0,0 +1,23 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherIpFlowVerify.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherIpFlowVerify.json new file mode 100644 index 000000000000..9443f66c3870 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherIpFlowVerify.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "direction" : "Outbound", + "protocol" : "TCP", + "localPort" : "80", + "remotePort" : "80", + "localIPAddress" : "10.2.0.4", + "remoteIPAddress" : "121.10.1.1" + } + }, + "responses" : { + "200" : { + "body" : { + "access" : "Allow", + "ruleName" : "Rule1" + } + }, + "202" : { + "body" : { + "access" : "Allow", + "ruleName" : "Rule1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherList.json new file mode 100644 index 000000000000..ee32cf597a9f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherList.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + }, + { + "name" : "nw2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherListAll.json new file mode 100644 index 000000000000..cb54fd69652d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherListAll.json @@ -0,0 +1,36 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + }, + { + "name" : "nw2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "westus", + "tags" : {}, + "properties" : { + "provisioningState" : "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json new file mode 100644 index 000000000000..0b72b2ae717b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -0,0 +1,198 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "profiles": [ + { + "direction" : "Inbound", + "protocol" : "TCP", + "source" : "10.1.0.4", + "destination" : "12.11.12.14", + "destinationPort" : "12100" + } + ] + } + }, + "responses" : { + "200" : { + "body" : { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + }, + "202" : { + "body" : { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNextHopGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNextHopGet.json new file mode 100644 index 000000000000..379400685900 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherNextHopGet.json @@ -0,0 +1,30 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "sourceIPAddress" : "10.0.0.5", + "destinationIPAddress" : "10.0.0.10", + "targetNicResourceId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "responses" : { + "200" : { + "body" : { + "nextHopType" : "VnetLocal", + "nextHopIpAddress" : "10.0.0.1", + "routeTableId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + }, + "202" : { + "body" : { + "nextHopType" : "VnetLocal", + "nextHopIpAddress" : "10.0.0.1", + "routeTableId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureCreate.json new file mode 100644 index 000000000000..41a938a2a8a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -0,0 +1,56 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1", + "parameters" : { + "properties" : { + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + }, + "responses" : { + "201" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureDelete.json new file mode 100644 index 000000000000..d81b76f643ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "204" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureGet.json new file mode 100644 index 000000000000..be2d0ae85589 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureGet.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureQueryStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureQueryStatus.json new file mode 100644 index 000000000000..69e4de09381b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureQueryStatus.json @@ -0,0 +1,31 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime" : "2016-09-07T12:35:24Z", + "packetCaptureStatus" : "Stopped", + "stopReason" : "TimeExceeded", + "packetCaptureError" : [] + } + }, + "202" : { + "body" : { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime" : "2016-09-07T12:35:24Z", + "packetCaptureStatus" : "Stopped", + "stopReason" : "TimeExceeded", + "packetCaptureError" : [] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureStop.json new file mode 100644 index 000000000000..79cf86b5ec35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCaptureStop.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "packetCaptureName" : "pc1" + }, + "responses" : { + "200" : {}, + "202" : {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCapturesList.json new file mode 100644 index 000000000000..1ca28b0f10a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherPacketCapturesList.json @@ -0,0 +1,58 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "pc1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Updating", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath" : "D:\\capture\\pc1.cap" + }, + "filters" : [ + { + "protocol" : "TCP", + "localIPAddress" : "10.0.0.4", + "localPort" : "80" + } + ] + } + }, + { + "name" : "pc2", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc2", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, + "storageLocation" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", + "filePath" : "D:\\capture\\pc2.cap" + }, + "filters" : [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherSecurityGroupViewGet.json new file mode 100644 index 000000000000..db754075d8c0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -0,0 +1,141 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses" : { + "200" : { + "body" : { + "networkInterfaces" : [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations" : { + "subnetAssociation" : { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules" : [ + { + "name" : "fe_rule", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow Frontend", + "protocol" : "Tcp", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "10.1.0.0/24", + "destinationAddressPrefix" : "*", + "access" : "Allow", + "priority" : 100, + "direction" : "Inbound" + } + } + ] + }, + "defaultSecurityRules" : [ + { + "name" : "AllowVnetInBound", + "id" : "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow inbound traffic from all VMs in VNET", + "protocol" : "*", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "VirtualNetwork", + "destinationAddressPrefix" : "VirtualNetwork", + "access" : "Allow", + "priority" : 65000, + "direction" : "Inbound" + } + } + ], + "effectiveSecurityRules" : [ + { + "name" : "DefaultOutboundDenyAll", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "*", + "destinationAddressPrefix" : "*", + "access" : "Deny", + "priority" : 65500, + "direction" : "Outbound" + } + ] + } + } + ] + } + }, + "202" : { + "body" : { + "networkInterfaces": [ + { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations" : { + "subnetAssociation" : { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules" : [ + { + "name" : "fe_rule", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow Frontend", + "protocol" : "Tcp", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "10.1.0.0/24", + "destinationAddressPrefix" : "*", + "access" : "Allow", + "priority" : 100, + "direction" : "Inbound" + } + } + ] + }, + "defaultSecurityRules" : [ + { + "name" : "AllowVnetInBound", + "id" : "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties" : { + "provisioningState" : "Succeeded", + "description" : "Allow inbound traffic from all VMs in VNET", + "protocol" : "*", + "sourcePortRange" : "*", + "destinationPortRange" : "*", + "sourceAddressPrefix" : "VirtualNetwork", + "destinationAddressPrefix" : "VirtualNetwork", + "access" : "Allow", + "priority" : 65000, + "direction" : "Inbound" + } + } + ], + "effectiveSecurityRules" : [ + { + "name" : "DefaultOutboundDenyAll", + "protocol" : "All", + "sourcePortRange" : "0-65535", + "destinationPortRange" : "0-65535", + "sourceAddressPrefix" : "*", + "destinationAddressPrefix" : "*", + "access" : "Deny", + "priority" : 65500, + "direction" : "Outbound" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTopologyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTopologyGet.json new file mode 100644 index 000000000000..2876c96ab8fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTopologyGet.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceGroupName": "rg2" + } + }, + "responses" : { + "200" : { + "body" : { + "id" : "ce592f46-8164-4bf2-ad36-b8e4acf6fb68", + "createdDateTime" : "2017-08-02T19:31:55.9461781Z", + "lastModified" : "2017-05-27T00:00:13.2005337Z", + "resources" : [ + { + "name" : "MultiTierApp0", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/MultiTierApp0", + "location" : "westus", + "associations" : [ + { + "name" : "appNic0", + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic0", + "associationType" : "Contains" + }, + { + "name" : "appNic10", + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic10", + "associationType" : "Contains" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootGet.json new file mode 100644 index 000000000000..37e0bb416d16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootGet.json @@ -0,0 +1,71 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "properties" : { + "storageId" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "storagePath" : "https://st1.blob.core.windows.net/cn1" + } + } + }, + "responses" : { + "200" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootResultQuery.json new file mode 100644 index 000000000000..38e7f5550dda --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -0,0 +1,67 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "targetResourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses" : { + "200" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id": "000000", + "reasonType" : "VipUnResponsive", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "contact support" + } + ] + } + ] + } + }, + "202" : { + "body" : { + "startTime" : "2017-01-12T00:19:47.0442834Z", + "endTime" : "2017-01-12T00:20:09.914Z", + "code" : "UnHealthy", + "results" : [ + { + "id" : "000000", + "reasonType" : "VipUnResponsive", + "summary" : "We are sorry, your VPN gateway is unreachable from the Internet", + "detail" : "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions" : [ + { + "actionText" : "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri" : "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText" : "Verify" + }, + { + "actionText" : "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri" : "http://azure.microsoft.com/support", + "actionUriText" : "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherUpdateTags.json new file mode 100644 index 000000000000..78ceaf56fd8b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkWatcherName" : "nw1", + "parameters" : { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "nw1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag" : "W/\"00000000-0000-0000-0000-000000000000\"", + "type" : "Microsoft.Network/networkWatchers", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/OperationList.json new file mode 100644 index 000000000000..0e14f825a26a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/OperationList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayDelete.json new file mode 100644 index 000000000000..012de164ad34 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..c66e89ab13c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGenerateVpnProfile.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName" : "p2sVpnGateway1", + "parameters": { + "authenticationMethod": "EAPTLS" + } + }, + "responses" : { + "202" : { + }, + "200" : { + "body" : "" + } + } +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGet.json new file mode 100644 index 000000000000..818272775fab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayList.json new file mode 100644 index 000000000000..5c36c6dc7722 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayList.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.4.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..5c36c6dc7722 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayListByResourceGroup.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.4.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayPut.json new file mode 100644 index 000000000000..9630c0190f31 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayPut.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1 + } + } + }, + "responses": { + "200": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } + } + }, + "201": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayUpdateTags.json new file mode 100644 index 000000000000..23de045f660b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnGatewayUpdateTags.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + }, + "201": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "p2SVpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1" + }, + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + }, + "vpnGatewayScaleUnit": 1, + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred":2000, + "totalEgressBytesTransferred":3000 + } + } + } + } +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationDelete.json new file mode 100644 index 000000000000..2be7e4b82c3a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1", + "virtualWanName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationGet.json new file mode 100644 index 000000000000..3635242ece7f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationGet.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "virtualWanName": "virtualWan1", + "p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "name": "p2sVpnServerConfiguration1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [{ + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + }], + "p2SVpnServerConfigVpnClientRootCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusServerRootCer1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCer1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + }], + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationList.json new file mode 100644 index 000000000000..38f4e7ab66cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationList.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "virtualWanName": "virtualWan1", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "p2sVpnServerConfiguration1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [{ + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + }], + "p2SVpnServerConfigVpnClientRootCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/VpnClientRevokedCert2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusServerRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + }], + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationPut.json new file mode 100644 index 000000000000..2122e23687ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/P2SVpnServerConfigurationPut.json @@ -0,0 +1,182 @@ +{ + "parameters": { + "virtualWanName": "virtualWan1", + "p2SVpnServerConfigurationName": "p2sVpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "p2SVpnServerConfigurationParameters": { + "properties": { + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [{ + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + }], + "p2SVpnServerConfigVpnClientRootCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRootCert1", + "properties": { + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "properties": { + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusServerRootCert1", + "properties": { + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + }], + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "properties": { + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + }] + } + } + }, + "responses": { + "200": { + "name": "p2sVpnServerConfiguration1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [{ + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + }], + "p2SVpnServerConfigVpnClientRootCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusServerRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + }], + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + }, + "201": { + "name": "p2sVpnServerConfiguration1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations//p2sVpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [{ + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + }], + "p2SVpnServerConfigVpnClientRootCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRootCertificates/p2sVpnServerConfigVpnClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRootCertificates" + }], + "p2SVpnServerConfigVpnClientRevokedCertificates": [{ + "name": "p2sVpnServerConfigVpnClientRevokedCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigVpnClientRevokedCertificates/p2sVpnServerConfigVpnClientRevokedCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigVpnClientRevokedCertificates" + }], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret":"123_abc", + "p2SVpnServerConfigRadiusServerRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusServerRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusServerRootCertificates/p2sVpnServerConfigRadiusServerRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusServerRootCertificates" + }], + "p2SVpnServerConfigRadiusClientRootCertificates": [{ + "name": "p2sVpnServerConfigRadiusClientRootCert1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1/p2sVpnServerConfigurations/p2sVpnServerConfiguration1/p2sVpnServerConfigRadiusClientRootCertificates/p2sVpnServerConfigRadiusClientRootCert1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "Thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations/p2sVpnServerConfigRadiusClientRootCertificates" + }] + }, + "type": "Microsoft.Network/virtualWans/p2sVpnServerConfigurations" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateCustomizedValues.json new file mode 100644 index 000000000000..09a229b45d92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -0,0 +1,63 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ "1" ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + }, + "sku": { + "name": "Standard" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDefaults.json new file mode 100644 index 000000000000..d379024890d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDefaults.json @@ -0,0 +1,51 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDns.json new file mode 100644 index 000000000000..484fd6c31132 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressCreateDns.json @@ -0,0 +1,59 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + }, + "201" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "dnslbl", + "fqdn" : "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressDelete.json new file mode 100644 index 000000000000..efa1b1599ed6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressGet.json new file mode 100644 index 000000000000..7554e6bdfe40 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressGet.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + }, + { + "ipTagType" : "FirstPartyUsage", + "tag" : "Storage" + } + ] + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressList.json new file mode 100644 index 000000000000..f0081bdc5ea7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressList.json @@ -0,0 +1,60 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + }, + { + "ipTagType" : "FirstPartyUsage", + "tag" : "Storage" + } + ] + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip03", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressListAll.json new file mode 100644 index 000000000000..4a2b20926040 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressListAll.json @@ -0,0 +1,49 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + }, + { + "name" : "ip01", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipAddress" : "40.85.154.247", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Dynamic", + "idleTimeoutInMinutes" : 4, + "dnsSettings" : { + "domainNameLabel" : "testlbl", + "fqdn" : "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressUpdateTags.json new file mode 100644 index 000000000000..17f3153b0e3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpAddressUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testDNS-ip", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "publicIPAllocationMethod" : "Static", + "idleTimeoutInMinutes" : 10, + "ipConfiguration" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type" : "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..42acbd8f2a80 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateCustomizedValues.json @@ -0,0 +1,54 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "zones": [ "1" ], + "parameters": { + "properties": { + "publicIPAddressVersion": "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + }, + "201" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", + "location" : "westus", + "zones": [ "1" ], + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateDefaults.json new file mode 100644 index 000000000000..0dbc837b7bae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixCreateDefaults.json @@ -0,0 +1,43 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + }, + "201" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "sku": { + "name": "Standard" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixDelete.json new file mode 100644 index 000000000000..aeadc0cf9acc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixGet.json new file mode 100644 index 000000000000..e86f40b107fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixGet.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"192.168.254.2/30", + "ipTags" : [ + ], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + } + } + } + \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixList.json new file mode 100644 index 000000000000..2c7de50e1116 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixList.json @@ -0,0 +1,45 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"40.85.154.2/30", + "ipTags" : [ + { + "ipTagType" : "FirstPartyUsage", + "tag" : "SQL" + } + ] + }, + "type" : "Microsoft.Network/publicIPPrefixes" + }, + { + "name" : "ipprefix03", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":31, + "ipPrefix" : "40.85.153.2/31" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixListAll.json new file mode 100644 index 000000000000..2448a35992f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixListAll.json @@ -0,0 +1,44 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30, + "ipPrefix":"41.85.154.247/30", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "type" : "Microsoft.Network/publicIPPrefixes" + }, + { + "name" : "ipprefix01", + "id" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "ipPrefix" : "40.85.154.247/30", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + ] + } + } + } + } + \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixUpdateTags.json new file mode 100644 index 000000000000..72025dc2648e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/PublicIpPrefixUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-ipprefix", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "publicIPAddressVersion" : "IPv4", + "prefixLength":30 + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type" : "Microsoft.Network/publicIPPrefixes" + } + } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterCreate.json new file mode 100644 index 000000000000..46c2f56fb020 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterCreate.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterDelete.json new file mode 100644 index 000000000000..37d35d9a8828 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterGet.json new file mode 100644 index 000000000000..d4d9b830e81f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterList.json new file mode 100644 index 000000000000..111b22cbc571 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterListByResourceGroup.json new file mode 100644 index 000000000000..542357e8343b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleCreate.json new file mode 100644 index 000000000000..73cb284cb3f7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleDelete.json new file mode 100644 index 000000000000..18b3de1f479b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleGet.json new file mode 100644 index 000000000000..120ae8000bf9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "ruleName": "filterName", + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleListByRouteFilter.json new file mode 100644 index 000000000000..bbe13e0e8ba4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleListByRouteFilter.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "routeFilterName": "filterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleUpdate.json new file mode 100644 index 000000000000..06561b4386ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterRuleUpdate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterUpdate.json new file mode 100644 index 000000000000..71a5f8798252 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteFilterUpdate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsofot.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreate.json new file mode 100644 index 000000000000..5be9a18bdcd8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreate.json @@ -0,0 +1,37 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ], + "disableBgpRoutePropagation": true + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreateWithRoute.json new file mode 100644 index 000000000000..0b7cf91fd652 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableCreateWithRoute.json @@ -0,0 +1,69 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "properties": { + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableDelete.json new file mode 100644 index 000000000000..e6ea55357948 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableGet.json new file mode 100644 index 000000000000..5362445d2403 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableGet.json @@ -0,0 +1,33 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": false, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableList.json new file mode 100644 index 000000000000..9eda77567526 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableList.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "disableBgpRoutePropagation": true, + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableListAll.json new file mode 100644 index 000000000000..4e3290c2a460 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableListAll.json @@ -0,0 +1,44 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteCreate.json new file mode 100644 index 000000000000..956e7c892af0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteCreate.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteDelete.json new file mode 100644 index 000000000000..33214971bb9b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteGet.json new file mode 100644 index 000000000000..8844c1043ed5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteGet.json @@ -0,0 +1,22 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "routeName": "route1" + }, + "responses" : { + "200" : { + "body" : { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteList.json new file mode 100644 index 000000000000..65d0b46e6753 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableRouteList.json @@ -0,0 +1,34 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableUpdateTags.json new file mode 100644 index 000000000000..5727f5b60a4d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/RouteTableUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "routeTableName" : "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceCommunityList.json new file mode 100644 index 000000000000..52ead1da8715 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceCommunityList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsofot.Network/bgpServiceCommunities/skype", + "name": "skype", + "type": "Microsofot.Network/bgpServiceCommunities", + "properties": { + "serviceName" : "skype", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Skype For Business Online", + "communityValue": "12076:5030", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup" : "O365" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsofot.Network/bgpServiceCommunities/exchange", + "name": "exchange", + "type": "Microsofot.Network/bgpServiceCommunities", + "properties": { + "serviceName" : "exchange", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Exchange Online", + "communityValue": "12076:5040", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup" : "O365" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreate.json new file mode 100644 index 000000000000..5bd0235df309 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreate.json @@ -0,0 +1,41 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy", + "parameters": {} + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreateWithDefinition.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreateWithDefinition.json new file mode 100644 index 000000000000..d33d15656a5d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyCreateWithDefinition.json @@ -0,0 +1,84 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy", + "parameters": { + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201" : { + "body" : { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionCreate.json new file mode 100644 index 000000000000..2fd36e70661b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionCreate.json @@ -0,0 +1,52 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition", + "ServiceEndpointPolicyDefinitions": { + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testDefinition", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "201" : { + "body" : { + "name": "rule1", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionDelete.json new file mode 100644 index 000000000000..7134cfc8fda8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionGet.json new file mode 100644 index 000000000000..827711f03f43 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionGet.json @@ -0,0 +1,26 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses" : { + "200" : { + "body" : { + "name": "testDefinition", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionList.json new file mode 100644 index 000000000000..cb1bdaee1cb5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDefinitionList.json @@ -0,0 +1,29 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "serviceEndpointPolicyName" : "testPolicy" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testDef", + "id":"/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDelete.json new file mode 100644 index 000000000000..963734519467 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "serviceEndpointPolicy1" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyGet.json new file mode 100644 index 000000000000..019b68c710d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyGet.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy" + }, + "responses" : { + "200" : { + "body" : { + "name" : "testServiceEndpointPolicy", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location" : "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} + diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyList.json new file mode 100644 index 000000000000..825c39b443ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyList.json @@ -0,0 +1,65 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value" : [ + { + "name" : "testServiceEndpointPolicy", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "location" : "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name" : "testServiceEndpointPolicy1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1", + "location" : "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyListAll.json new file mode 100644 index 000000000000..064d3c48ec25 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyListAll.json @@ -0,0 +1,66 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy2", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": + { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition2", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [ ], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyUpdateTags.json new file mode 100644 index 000000000000..1b1db2b8a000 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ServiceEndpointPolicyUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "testServiceEndpointPolicy", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreate.json new file mode 100644 index 000000000000..709e1ca68e1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateServiceEndpoint.json new file mode 100644 index 000000000000..75dba7d4f639 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateServiceEndpoint.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { "service": "Microsoft.Storage" } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [{ + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + }], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateWithDelegation.json new file mode 100644 index 000000000000..6bb2dcdbc3d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetCreateWithDelegation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetDelete.json new file mode 100644 index 000000000000..5a1da7e742ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGet.json new file mode 100644 index 000000000000..9a3dd26844a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGetWithDelegation.json new file mode 100644 index 000000000000..053db3a9f9f5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetGetWithDelegation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetList.json new file mode 100644 index 000000000000..2f4e0fb203f2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/SubnetList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageList.json new file mode 100644 index 000000000000..1642dc05f670 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageList.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/outboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "outboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageListSpacedLocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageListSpacedLocation.json new file mode 100644 index 000000000000..e34a1ebf5714 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/UsageListSpacedLocation.json @@ -0,0 +1,335 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIpPrefixes", + "limit": 2147483647.0, + "name": { + "localizedValue": "Public Ip Prefixes", + "value": "PublicIpPrefixes" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkInterfaces", + "limit": 24000.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 5.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PacketCaptures", + "limit": 100.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationSecurityGroups", + "limit": 500.0, + "name": { + "localizedValue": "Application Security Groups.", + "value": "ApplicationSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DdosProtectionPlans", + "limit": 1.0, + "name": { + "localizedValue": "DDoS Protection Plans.", + "value": "DdosProtectionPlans" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ServiceEndpointPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Service Endpoint Policies", + "value": "ServiceEndpointPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkIntentPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Network Intent Policies", + "value": "NetworkIntentPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/IPConfigurationsPerVirtualNetwork", + "limit": 16384.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PeeringsPerVirtualNetwork", + "limit": 50.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 1000.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Security rules per Network Intent Policy", + "value": "SecurityRulesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Network Intent Policy", + "value": "RoutesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/OutboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "OutboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerRouteTable", + "limit": 400.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubDelete.json new file mode 100644 index 000000000000..b19d04982404 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubGet.json new file mode 100644 index 000000000000..aac3312b02e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ ], + "addressPrefix": "10.10.1.0/24" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubList.json new file mode 100644 index 000000000000..d98beaa9fbe5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/SpokeVnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "10.10.1.0/24" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualNetworks/SpokeVnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "210.10.1.0/24" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubListByResourceGroup.json new file mode 100644 index 000000000000..4e55be4e8880 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualNetworks/SpokeVnet1" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "10.10.1.0/24" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsofot.Network/virtualHubs/virtualHub2/hubVirtualNetworkConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsofot.Network/virtualNetworks/SpokeVnet2" + }, + "allowHubToRemoteVnetTransit": true, + "allowRemoteVnetToUseHubVnetGateways": false + } + } + ], + "addressPrefix": "210.10.1.0/24" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubPut.json new file mode 100644 index 000000000000..fed3dacd1c30 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubPut.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "addressPrefix": "10.168.0.0/24" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubUpdateTags.json new file mode 100644 index 000000000000..08c451ecddfc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualHubUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualNetworkConnections": [ ], + "addressPrefix": "10.168.0.0/24" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCheckIPAddressAvailability.json new file mode 100644 index 000000000000..abb9481eacba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "ipAddress": "10.0.1.4" + }, + "responses" : { + "200" : { + "body" : { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreate.json new file mode 100644 index 000000000000..b03b3df20882 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreate.json @@ -0,0 +1,56 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + } + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json new file mode 100644 index 000000000000..4c1156614be1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json @@ -0,0 +1,120 @@ +{ + "parameters" : { + "api-version": "2018-06-01", + "subscriptionId" : "subid", + "resourceGroupName" : "vnetTest", + "virtualNetworkName" : "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpoints.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpoints.json new file mode 100644 index 000000000000..57c8147a1c6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateServiceEndpoints.json @@ -0,0 +1,110 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "vnetTest", + "virtualNetworkName" : "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "vnet1", + "id" : "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnet.json new file mode 100644 index 000000000000..4ebca4192223 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnet.json @@ -0,0 +1,81 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json new file mode 100644 index 000000000000..07e7b2e43d1e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json @@ -0,0 +1,90 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.1.0.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithDelegation.json new file mode 100644 index 000000000000..14dfb31b7844 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -0,0 +1,113 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subId", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Provider/resourceType" + } + } + ] + } + } + ] + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + }, + "201" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkDelete.json new file mode 100644 index 000000000000..b2617b86f467 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionCreate.json new file mode 100644 index 000000000000..826ecba4e4a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S", + "parameters": { + "properties": { + "virtualNetworkGateway1": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus", + "tags": {} + }, + "localNetworkGateway2": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "location": "centralus", + "tags": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [] + }, + "location": "centralus" + } + }, + "responses" : { + "201" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + }, + "200" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionDelete.json new file mode 100644 index 000000000000..6cb430d91047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "conn1" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGet.json new file mode 100644 index 000000000000..76baff2b1fea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S" + }, + "responses" : { + "200" : { + "body" : { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Connecting", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json new file mode 100644 index 000000000000..c1ee6d72bdbb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S" + }, + "responses" : { + "200" : { + "body" : { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json new file mode 100644 index 000000000000..773518767381 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "conn1", + "parameters": { + "keyLength": 128 + } + }, + "responses" : { + "200" : { + "body" : { + "keyLength": 128 + } + }, + "202" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json new file mode 100644 index 000000000000..76be5aaeb387 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "connS2S", + "parameters": { + "value": "AzureAbc123" + } + }, + "responses" : { + "200" : { + "body" : { + "value": "AzureAbc123" + } + }, + "201" : { + "body" : { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json new file mode 100644 index 000000000000..dd54347009b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -0,0 +1,49 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionsList.json new file mode 100644 index 000000000000..78c4d54ab192 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv1", + "routingWeight": 0, + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + }, + { + "name": "conn2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "properties": {} + }, + "localNetworkGateway2": { + "properties": {}, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2" + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayDelete.json new file mode 100644 index 000000000000..fc7364680d1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json new file mode 100644 index 000000000000..2469693e3866 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + } + }, + "responses" : { + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..351f64bf4ad9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": {} + }, + "responses" : { + "202" : { + }, + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGet.json new file mode 100644 index 000000000000..f293abfba98e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGet.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json new file mode 100644 index 000000000000..bfd5fa4698bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "peer": "test" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json new file mode 100644 index 000000000000..c23f3532111c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..78dbaa93c5d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json new file mode 100644 index 000000000000..22e9a4a9fccc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayLearnedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayLearnedRoutes.json new file mode 100644 index 000000000000..bb0e9d718408 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayLearnedRoutes.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : {}, + "200" : { + "body" : { + + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayList.json new file mode 100644 index 000000000000..4c1b50d2169a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayList.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "vpngw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw1-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.14", + "peerWeight": 0 + } + } + }, + { + "name": "vpngw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc2", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw2-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.1.0.46", + "peerWeight": 0 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayReset.json new file mode 100644 index 000000000000..024dbe04760a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayReset.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json new file mode 100644 index 000000000000..bbfa2e30d402 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "202" : { }, + "200" : { } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..e26a51d31b3f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "vpnclientIpsecParams": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + }, + "responses" : { + "202" : { + }, + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json new file mode 100644 index 000000000000..0a66cfe543ba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw" + }, + "responses" : { + "200" : { + "body" : "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdate.json new file mode 100644 index 000000000000..690050f17327 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdate.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "resourceGuid": "00000000-0000-0000-0000-000000000000" + }, + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus" + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "SSTP", + "IkeV2" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + }, + "201" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "SSTP", + "IkeV2" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..33b538184b42 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -0,0 +1,62 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkGatewayName" : "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json new file mode 100644 index 000000000000..bf0cead3a878 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName" : "vpngw", + "parameters": { + "vendor": "Cisco", + "deviceFamily": "ISR", + "firmwareVersion": "IOS 15.1 (Preview)" + } + }, + "responses" : { + "200" : { + "body" : "! Microsoft Corporation\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Sample VPN tunnel configuration template for IOS-based devices\r\n!\r\n! This configuration template applies to Cisco VPN devices running IOS 15.1 or beyond (ISR or ASR)\r\n!\r\n\r\n\r\n\t\t\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! ACL rules\r\n!\r\n! Some VPN devices require explicit ACL rules to allow cross-premises traffic:\r\n!\r\n! 1. Allow traffic between on premises address ranges and VNet address ranges\r\n! 2. Allow IKE traffic (UDP:500) between on premises VPN devices and Azure VPN gateway\r\n! 3. Allow IPsec traffic (Proto:ESP) between on premises VPN devices and Azure VPN gateway\r\n!\r\n\t\t\r\naccess-list 101 permit ip 10.1.0.0 0.0.255.255 10.0.0.0 0.0.255.255\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Internet Key Exchange (IKE) configuration\r\n!\r\n! This section specifies the authentication, encryption, hashing, and Diffie-Hellman group parameters for IKE\r\n! main mode or phase 1\r\n!\r\n\r\ncrypto ikev2 proposal SwaggerS2S-proposal\r\n encryption DES3\r\n integrity SHA384\r\n group DHGroup24\r\n lifetime 3600\r\n exit\r\n\r\ncrypto ikev2 policy SwaggerS2S-policy\r\n proposal SwaggerS2S-proposal\r\n exit\r\n\r\ncrypto ikev2 keyring SwaggerBranch-keyring\r\n\t\t\r\n\t\tpeer 52.173.199.254\r\n\t\taddress 52.173.199.254\r\n\t\tpre-shared-key lALEHuppeopJmA94exRNiRr2QzuZ6lOsvzu5IlJUEA6LthbTc8g5MTT86MCsGNMzGkTAaLuLnEJoD1Cn4cIlr94qKZm9drsgllzWvsPNezS71stAkaW1Bb7h6GBnDlDP\r\n exit\r\n\r\ncrypto ikev2 profile SwaggerS2S-profile\r\n match address local 10.3.0.0\r\n\tmatch identity remote address 52.173.199.254 255.255.255.255\r\n\t\t\r\n authentication remote pre-share\r\n authentication local pre-share\r\n keyring SwaggerBranch-keyring\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! IPsec configuration\r\n!\r\n! This section specifies encryption, authentication, tunnel mode properties for the Phase 2 negotiation\r\n!\r\ncrypto ipsec transform-set SwaggerS2S-TransformSet DES3 DES3\r\n mode tunnel\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Crypto map configuration\r\n!\r\n! This section defines a crypto profile that binds the cross-premises network traffic to the IPsec and IKE\r\n! policy profiles for this connection. Then defines the VTI (virtual tunnel interface) with the crypto\r\n! profile. A random interface number (tunnel 1) was used with a random link local address (169.254.0.1/28)\r\n! for the tunnel interface. If either selection is already used in the VPN device, please select another\r\n! interface number or address. The only requirement is that they must not overlap with another interface\r\n! on the same VPN device.\r\n!\r\ncrypto ipsec profile SwaggerS2S-IPsecProfile\r\n set transform-set SwaggerS2S-TransformSet\r\n set ikev2-profile SwaggerS2S-profile\r\n set pfs None\r\n set security-association lifetime 3600\r\n exit\r\n\r\n\r\nint tunnel 52.173.199.254\r\n ip address 169.254.0.1 255.255.255.252\r\n ip tcp adjust-mss 1350\r\n tunnel source 10.3.0.0\r\n tunnel mode ipsec ipv4\r\n tunnel destination 52.173.199.254\r\n tunnel protection ipsec profile SwaggerS2S-IPsecProfile\r\n exit\r\n\r\n\tip route 10.0.0.0 255.255.0.0 tunnel 52.173.199.254 " + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaysListConnections.json new file mode 100644 index 000000000000..a327c5d72b27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGatewaysListConnections.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "virtualNetworkGatewayName": "test-vpn-gateway-1", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vpn-connection", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1" + }, + "virtualNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2" + }, + "connectionType": "Vnet2Vnet", + "routingWeight": 22, + "enableBgp": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGet.json new file mode 100644 index 000000000000..692ce77518b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGet.json @@ -0,0 +1,40 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet" + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [{ + "name" : "subnet1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties" : { + "provisioningState" : "Succeeded", + "addressPrefix" : "10.0.1.0/24", + "ipConfigurations" : [{ + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithServiceAssociationLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithServiceAssociationLink.json new file mode 100644 index 000000000000..bf5213bd2bfb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithServiceAssociationLink.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.214.0/24", + "ipConfigurationProfiles": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1" + } + ], + "serviceAssociationLinks": [ + { + "name": "serviceAssociationLink1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/serviceAssociationLinks/serviceAssociationLink1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Provider/resourceType" + } + } + ], + "serviceEndpoints": [], + "delegations": [ + { + "name": "aciDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/aciDelegation", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/virtualNetworks/subnets/action" + ] + } + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithSubnetDelegation.json new file mode 100644 index 000000000000..ad30a87dbbc6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [{ + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [{ + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + }], + "delegations": [{ + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + }], + "purpose": "" + } + }], + "virtualNetworkPeerings": [] + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkList.json new file mode 100644 index 000000000000..4e777685cd05 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkList.json @@ -0,0 +1,64 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListAll.json new file mode 100644 index 000000000000..5d410117a848 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListAll.json @@ -0,0 +1,63 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListUsage.json new file mode 100644 index 000000000000..ad45f19d697c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkListUsage.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkName": "vnetName", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": -1.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet", + "limit": -1.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet", + "limit": 3.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringCreate.json new file mode 100644 index 000000000000..a1ad73d5b5e8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..c13b160b7e6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringGet.json new file mode 100644 index 000000000000..6b8b7b6282e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringList.json new file mode 100644 index 000000000000..26ab566b7c09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkPeeringList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json new file mode 100644 index 000000000000..56d8e18ab711 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapCreate.json @@ -0,0 +1,62 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "parameters": { + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/ipconfig1" + } + }, + "location": "centraluseuap" + } + }, + "responses" : { + "200" : { + "body" : { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + }, + "201" : { + "body" : { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapDelete.json new file mode 100644 index 000000000000..2754188c22a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapDelete.json @@ -0,0 +1,13 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap" + }, + "responses" : { + "200" : { }, + "202" : { }, + "204" : { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json new file mode 100644 index 000000000000..7dbee26fdd46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapGet.json @@ -0,0 +1,32 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "tapName" : "testvtap" + }, + "responses" : { + "200" : { + "body" : { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json new file mode 100644 index 000000000000..0215ca43f1a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapList.json @@ -0,0 +1,55 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json new file mode 100644 index 000000000000..9cb69a1de457 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapListAll.json @@ -0,0 +1,54 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json new file mode 100644 index 000000000000..cee390b2ec00 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkTapUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "tapParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vtap", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/test-vtap", + "location" : "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + }, + "type" : "Microsoft.Network/virtualNetworkTaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkUpdateTags.json new file mode 100644 index 000000000000..76b1195b9ad2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualNetworkUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2018-10-01", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualNetworkName" : "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses" : { + "200" : { + "body" : { + "name" : "test-vnet", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type" : "Microsoft.Network/virtualNetworks", + "location" : "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties" : { + "provisioningState" : "Succeeded", + "addressSpace" : { + "addressPrefixes" : [ + "10.0.0.0/16" + ] + }, + "subnets" : [], + "virtualNetworkPeerings" : [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANDelete.json new file mode 100644 index 000000000000..0ff56e8f8d8a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "VirtualWANName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANGet.json new file mode 100644 index 000000000000..ec00cc7f1c88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANList.json new file mode 100644 index 000000000000..50bd8b8ece43 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANListByResourceGroup.json new file mode 100644 index 000000000000..34e18fad08df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANListByResourceGroup.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANPut.json new file mode 100644 index 000000000000..7f0d300e8350 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANPut.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "WANParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "disableVpnEncryption": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANUpdateTags.json new file mode 100644 index 000000000000..d5fdd45751b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWANUpdateTags.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "WANParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWanSupportedSecurityProviders.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWanSupportedSecurityProviders.json new file mode 100644 index 000000000000..f1a5c949fd48 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VirtualWanSupportedSecurityProviders.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "supportedProviders": [ + { + "name": "Zscaler", + "url": "", + "type": "External" + }, + { + "name": "AzureFirewall", + "url": "", + "type": "Native" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceGet.json new file mode 100644 index 000000000000..de8b2d4a7ec5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceGet.json @@ -0,0 +1,65 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "networkInterfaceName" : "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "name" : "nic1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties" : { + "provisioningState" : "Succeeded", + "ipConfigurations" : [ + { + "name" : "ip1", + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties" : { + "provisioningState" : "Succeeded", + "privateIPAddress" : "10.0.0.5", + "privateIPAllocationMethod" : "Dynamic", + "publicIPAddress" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary" : true, + "privateIPAddressVersion" : "IPv4", + "loadBalancerBackendAddressPools" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules" : [ + { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings" : { + "dnsServers" : [], + "appliedDnsServers" : [], + "internalDomainNameSuffix" : "dns.cdmx.internal.cloudapp.net" + }, + "macAddress" : "00-00-00-00-00-00", + "enableAcceleratedNetworking" : false, + "enableIPForwarding" : false, + "networkSecurityGroup" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary" : true, + "virtualMachine" : { + "id" : "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigGet.json new file mode 100644 index 000000000000..445dae399b7d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -0,0 +1,39 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses" : { + "200" : { + "body" : { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigList.json new file mode 100644 index 000000000000..1758de1ee444 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -0,0 +1,42 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceList.json new file mode 100644 index 000000000000..aa3be3aba845 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssNetworkInterfaceList.json @@ -0,0 +1,118 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpGet.json new file mode 100644 index 000000000000..3601aa554519 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpListAll.json new file mode 100644 index 000000000000..2371537ba644 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssPublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmNetworkInterfaceList.json new file mode 100644 index 000000000000..e44ecaa437fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmNetworkInterfaceList.json @@ -0,0 +1,68 @@ +{ + "parameters" : { + "api-version": "2017-03-30", + "subscriptionId" : "subid", + "resourceGroupName" : "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses" : { + "200" : { + "body" : { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmPublicIpList.json new file mode 100644 index 000000000000..5df78ff0a7d1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VmssVmPublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2017-03-30", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionDelete.json new file mode 100644 index 000000000000..77b520f899ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionGet.json new file mode 100644 index 000000000000..70ae32660006 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "vpnConnectionProtocolType": "IKEv2", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionList.json new file mode 100644 index 000000000000..295c5e3ae42c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "vpnConnectionProtocolType": "IKEv1", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionPut.json new file mode 100644 index 000000000000..2aee918654d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnConnectionPut.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "VpnConnectionParameters": { + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnConnectionProtocolType" : "IKEv1", + "sharedKey": "key" + } + } + }, + "responses": { + "200": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "vpnConnectionProtocolType": "IKEv1", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + }, + "201": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "vpnConnectionProtocolType": "IKEv1", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayDelete.json new file mode 100644 index 000000000000..b77e10133905 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayGet.json new file mode 100644 index 000000000000..2230d0942d92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayList.json new file mode 100644 index 000000000000..7d706c1173ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayList.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..188968fb52cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayListByResourceGroup.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayPut.json new file mode 100644 index 000000000000..07cdcbe8cccd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayPut.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "sharedKey": "key" + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + }, + "responses": { + "200": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + }, + "201": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayUpdateTags.json new file mode 100644 index 000000000000..a240c16f3900 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnGatewayUpdateTags.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidthInMbps": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + }, + "201": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidthInMbps": 100, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [ ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "policies": { + "allowBranchToBranchTraffic": true, + "allowVnetToVnetTraffic": false + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteDelete.json new file mode 100644 index 000000000000..26377bd64438 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { }, + "202": { }, + "204": { } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteGet.json new file mode 100644 index 000000000000..8a096bc64653 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } + } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteList.json new file mode 100644 index 000000000000..0b2168c5da0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteListByResourceGroup.json new file mode 100644 index 000000000000..b9f2e55018a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitePut.json new file mode 100644 index 000000000000..9a1a868cf478 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitePut.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/VirtualWans/virtualWan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteUpdateTags.json new file mode 100644 index 000000000000..9404743cad3b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSiteUpdateTags.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitesConfigurationDownload.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitesConfigurationDownload.json new file mode 100644 index 000000000000..e937addcef10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/VpnSitesConfigurationDownload.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "virtualWANName": "wan1", + "request": { + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json new file mode 100644 index 000000000000..c0baa6dae2a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json @@ -0,0 +1,1951 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "Parameters supplied to the create or update express route circuit authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_List", + "description": "Gets all authorizations in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.", + "schema": { + "$ref": "#/definitions/AuthorizationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Delete", + "description": "Deletes the specified peering from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Get", + "description": "Gets the specified peering for the express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Peering": { "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "Parameters supplied to the create or update express route circuit peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_List", + "description": "Gets all peerings in a specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples":{ + "List ExpressRouteCircuit Peerings": { "$ref": "./examples/ExpressRouteCircuitPeeringList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Delete", + "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Get", + "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionGet": { + "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", + "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "name": "expressRouteCircuitConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionCreate": { + "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { + "delete": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Delete", + "description": "Deletes the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Disabling' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Get", + "description": "Gets information about the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_CreateOrUpdate", + "description": "Creates or updates an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "Parameters supplied to the create or update express route circuit operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create ExpressRouteCircuit": { "$ref": "./examples/ExpressRouteCircuitCreate.json" } + } + }, + "patch": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_UpdateTags", + "description": "Updates an express route circuit tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route circuit tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + } + }, + "x-ms-examples": { + "Update Express Route Circuit Tags": { + "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitArpTable" + ], + "operationId": "ExpressRouteCircuits_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsArpTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List ARP Table": { "$ref": "./examples/ExpressRouteCircuitARPTableList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTable" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRouteTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Route Tables": { "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTableSummary" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", + "description": "Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "List Route Table Summary": { "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetStats", + "description": "Gets all the stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitStats.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetPeeringStats", + "description": "Gets all stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Peering Traffic Stats": { "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_List", + "description": "Gets all the express route circuits in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a resource group": { "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_ListAll", + "description": "Gets all the express route circuits in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuit resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a subscription": { "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { + "get": { + "tags": [ + "ExpressRouteServiceProviders" + ], + "operationId": "ExpressRouteServiceProviders_List", + "description": "Gets all the available express route service providers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteServiceProviderListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoute providers": { "$ref": "./examples/ExpressRouteProviderList.json" } + } + } + } + }, + "definitions": { + "AuthorizationPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "type": "string", + "description": "AuthorizationUseStatus. Possible values are: 'Available' and 'InUse'.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "AuthorizationUseStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteCircuitAuthorization": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authorization in an ExpressRouteCircuit resource." + }, + "AuthorizationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The authorizations in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPeeringConfig": { + "properties": { + "advertisedPublicPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reference of AdvertisedPublicPrefixes." + }, + "advertisedCommunities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The communities of bgp peering. Spepcified for microsoft peering" + }, + "advertisedPublicPrefixesState": { + "type": "string", + "description": "AdvertisedPublicPrefixState of the Peering resource. Possible values are 'NotConfigured', 'Configuring', 'Configured', and 'ValidationNeeded'.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", + "modelAsString": true + } + }, + "legacyMode": { + "type": "integer", + "format": "int32", + "description": "The legacy mode of the peering." + }, + "customerASN": { + "type": "integer", + "format": "int32", + "description": "The CustomerASN of the peering." + }, + "routingRegistryName": { + "type": "string", + "description": "The RoutingRegistryName of the configuration." + } + }, + "description": "Specifies the peering configuration." + }, + "Ipv6ExpressRouteCircuitPeeringConfig": { + "properties": { + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "routeFilter": { + "$ref": "./routeFilter.json#/definitions/RouteFilter", + "description": "The reference of the RouteFilter resource." + }, + "state": { + "type": "string", + "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringState", + "modelAsString": true + } + } + }, + "description": "Contains IPv6 peering config." + }, + "ExpressRouteCircuitStats": { + "properties": { + "primarybytesIn": { + "type": "integer", + "format": "int64", + "description": "Gets BytesIn of the peering." + }, + "primarybytesOut": { + "type": "integer", + "format": "int64", + "description": "Gets BytesOut of the peering." + }, + "secondarybytesIn": { + "type": "integer", + "format": "int64", + "description": "Gets BytesIn of the peering." + }, + "secondarybytesOut": { + "type": "integer", + "format": "int64", + "description": "Gets BytesOut of the peering." + } + }, + "description": "Contains stats associated with the peering." + }, + "ExpressRouteCircuitPeeringPropertiesFormat": { + "properties": { + "peeringType": { + "$ref": "#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "stats": { + "$ref": "#/definitions/ExpressRouteCircuitStats", + "description": "Gets peering stats." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets whether the provider or the customer last modified the peering." + }, + "routeFilter": { + "$ref": "./routeFilter.json#/definitions/RouteFilter", + "description": "The reference of the RouteFilter resource." + }, + "ipv6PeeringConfig": { + "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + }, + "expressRouteConnection" : { + "$ref": "./expressRouteGateway.json#/definitions/ExpressRouteConnectionId", + "description": "The ExpressRoute connection." + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The list of circuit connections associated with Azure Private Peering for this circuit." + } + } + }, + "ExpressRouteCircuitPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The peerings in an express route circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit." + }, + "ExpressRoutePeeringType": { + "type": "string", + "description": "The PeeringType. Possible values are: 'AzurePublicPeering', 'AzurePrivatePeering', and 'MicrosoftPeering'.", + "enum": [ + "AzurePublicPeering", + "AzurePrivatePeering", + "MicrosoftPeering" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringType", + "modelAsString": true + } + }, + "ExpressRoutePeeringState": { + "type": "string", + "description": "The state of peering. Possible values are: 'Disabled' and 'Enabled'", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringState", + "modelAsString": true + } + }, + "ExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "circuitConnectionStatus": { + "type": "string", + "description": "Express Route Circuit Connection State. Possible values are: 'Connected' and 'Disconnected'.", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "readOnly": true, + "x-ms-enum": { + "name": "circuitConnectionStatus", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "ExpressRouteCircuitSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "description": "The tier of the SKU. Possible values are 'Standard', 'Premium' or 'Basic'.", + "enum": [ + "Standard", + "Premium", + "Basic" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuTier", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The family of the SKU. Possible values are: 'UnlimitedData' and 'MeteredData'.", + "enum": [ + "UnlimitedData", + "MeteredData" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuFamily", + "modelAsString": true + } + } + }, + "description": "Contains SKU in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitServiceProviderProperties": { + "properties": { + "serviceProviderName": { + "type": "string", + "description": "The serviceProviderName." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The BandwidthInMbps." + } + }, + "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPropertiesFormat": { + "properties": { + "allowClassicOperations": { + "type": "boolean", + "description": "Allow classic operations" + }, + "circuitProvisioningState": { + "type": "string", + "description": "The CircuitProvisioningState state of the resource." + }, + "serviceProviderProvisioningState": { + "type": "string", + "description": "The ServiceProviderProvisioningState state of the resource. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned', and 'Deprovisioning'.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The list of authorizations." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The list of peerings." + }, + "serviceKey": { + "type": "string", + "description": "The ServiceKey." + }, + "serviceProviderNotes": { + "type": "string", + "description": "The ServiceProviderNotes." + }, + "serviceProviderProperties": { + "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", + "description": "The ServiceProviderProperties." + }, + "expressRoutePort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." + }, + "bandwidthInGbps": { + "type": "number", + "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." + }, + "stag": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "allowGlobalReach": { + "type": "boolean", + "description": "Flag to enable Global Reach on the circuit." + } + }, + "description": "Properties of ExpressRouteCircuit." + }, + "ExpressRouteCircuit": { + "properties": { + "sku": { + "$ref": "#/definitions/ExpressRouteCircuitSku", + "description": "The SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCircuit resource" + }, + "ExpressRouteCircuitArpTable": { + "properties": { + "age": { + "type": "integer", + "format": "int32", + "description": "Entry age in minutes" + }, + "interface": { + "type": "string", + "description": "Interface address" + }, + "ipAddress": { + "type": "string", + "description": "The IP address." + }, + "macAddress": { + "type": "string", + "description": "The MAC address." + } + }, + "description": "The ARP table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsArpTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitArpTable" + }, + "description": "Gets list of the ARP table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListArpTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTable": { + "properties": { + "network": { + "type": "string", + "description": "IP address of a network entity" + }, + "nextHop": { + "type": "string", + "description": "NextHop address" + }, + "locPrf": { + "type": "string", + "description": "Local preference value as set with the set local-preference route-map configuration command" + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "Route Weight." + }, + "path": { + "type": "string", + "description": "Autonomous system paths to the destination network." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit" + }, + "ExpressRouteCircuitsRoutesTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" + }, + "description": "The list of routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of the neighbor." + }, + "v": { + "type": "integer", + "format": "int32", + "description": "BGP version number spoken to the neighbor." + }, + "as": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "statePfxRcd": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "A list of ExpressRouteCircuits in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCircuit API service call." + }, + "ExpressRouteServiceProviderBandwidthsOffered": { + "properties": { + "offerName": { + "type": "string", + "description": "The OfferName." + }, + "valueInMbps": { + "type": "integer", + "format": "int32", + "description": "The ValueInMbps." + } + }, + "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources." + }, + "ExpressRouteServiceProviderPropertiesFormat": { + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Get a list of peering locations." + }, + "bandwidthsOffered": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" + }, + "description": "Gets bandwidths offered." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the resource." + } + }, + "description": "Properties of ExpressRouteServiceProvider." + }, + "ExpressRouteServiceProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A ExpressRouteResourceProvider object." + }, + "ExpressRouteServiceProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProvider" + }, + "description": "A list of ExpressRouteResourceProvider resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListExpressRouteServiceProvider API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json new file mode 100644 index 000000000000..4baf23a87757 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json @@ -0,0 +1,922 @@ +{ + "swagger": "2.0", + "info": { + "title": "ExpressRouteCrossConnection REST APIs", + "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit. ", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_List", + "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionList": { + "$ref": "./examples/ExpressRouteCrossConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", + "description": "Retrieves all the ExpressRouteCrossConnections in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no crossconnection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionListByResourceGroup": { + "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_Get", + "description": "Gets details about the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group (peering location of the circuit)." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection (service key of the circuit)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", + "description": "Update the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "Parameters supplied to the update express route crossConnection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_UpdateTags", + "description": "Updates an express route cross connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cross connection." + }, + { + "name": "crossConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route cross connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnectionTags": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_List", + "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringList": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Delete", + "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Get", + "description": "Gets the specified peering for the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringCreate": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionArpTable" + ], + "operationId": "ExpressRouteCrossConnections_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsArpTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsArpTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTableSummary" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", + "description": "Gets the route table summary associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTableSummary": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTable" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "ExpressRouteCrossConnectionRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of Neighbor router" + }, + "asn": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "stateOrPrefixesReceived": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Cross Connections." + }, + "ExpressRouteCircuitReference": { + "properties": { + "id": { + "type":"string", + "description": "Corresponding Express Route Circuit Id." + } + } + }, + "ExpressRouteCrossConnectionProperties": { + "properties": { + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "sTag": { + "readOnly": true, + "type": "integer", + "description": "The identifier of the circuit traffic." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location of the ExpressRoute circuit." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The circuit bandwidth In Mbps." + }, + "expressRouteCircuit": { + "$ref": "#/definitions/ExpressRouteCircuitReference", + "description": "The ExpressRouteCircuit" + }, + "serviceProviderProvisioningState": { + "type": "string", + "description": "The provisioning state of the circuit in the connectivity provider system. Possible values are 'NotProvisioned', 'Provisioning', 'Provisioned'.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + }, + "serviceProviderNotes": { + "type": "string", + "description": "Additional read only notes set by the connectivity provider." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The list of peerings." + } + }, + "description": "Properties of ExpressRouteCrossConnection." + }, + "ExpressRouteCrossConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCrossConnection resource" + }, + "ExpressRouteCrossConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "A list of ExpressRouteCrossConnection resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCrossConnection API service call." + }, + "ExpressRouteCrossConnectionPeeringProperties": { + "properties": { + "peeringType": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "type": "string", + "description": "Gets whether the provider or the customer last modified the peering." + }, + "ipv6PeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + } + } + }, + "ExpressRouteCrossConnectionPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties" + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRoute Cross Connection resource." + }, + "ExpressRouteCrossConnectionPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The peerings in an express route cross connection." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteGateway.json new file mode 100644 index 000000000000..c2f32e2e1e57 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteGateway.json @@ -0,0 +1,648 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListBySubscription", + "x-ms-examples": { + "ExpressRouteGatewayListBySubscription": { + "$ref": "./examples/ExpressRouteGatewayListBySubscription.json" + } + }, + "description": "Lists ExpressRoute gateways under a given subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListByResourceGroup", + "x-ms-examples": { + "ExpressRouteGatewayListByResourceGroup": { + "$ref": "./examples/ExpressRouteGatewayListByResourceGroup.json" + } + }, + "description": "Lists ExpressRoute gateways in a given resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}": { + "put": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteGatewayCreate": { + "$ref": "./examples/ExpressRouteGatewayCreate.json" + } + }, + "description": "Creates or updates a ExpressRoute gateway in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "putExpressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "Parameters required in an ExpressRoute gateway PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Get", + "x-ms-examples": { + "ExpressRouteGatewayGet": { + "$ref": "./examples/ExpressRouteGatewayGet.json" + } + }, + "description": "Fetches the details of a ExpressRoute gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation succeeded. The operation returns the ExpressRoute gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Delete", + "x-ms-examples": { + "ExpressRouteGatewayDelete": { + "$ref": "./examples/ExpressRouteGatewayDelete.json" + } + }, + "description": "Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}": { + "put": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteConnectionCreate": { + "$ref": "./examples/ExpressRouteConnectionCreate.json" + } + }, + "description": "Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "name": "putExpressRouteConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "Parameters required in an ExpressRouteConnection PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Get", + "x-ms-examples": { + "ExpressRouteConnectionGet": { + "$ref": "./examples/ExpressRouteConnectionGet.json" + } + }, + "description": "Gets the specified ExpressRouteConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Delete", + "x-ms-examples": { + "ExpressRouteConnectionDelete": { + "$ref": "./examples/ExpressRouteConnectionDelete.json" + } + }, + "description": "Deletes a connection to a ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted, and the operation will continue asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections": { + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_List", + "x-ms-examples": { + "ExpressRouteConnectionList": { + "$ref": "./examples/ExpressRouteConnectionList.json" + } + }, + "description": "Lists ExpressRouteConnections.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnectionList" + } + } + } + } + } + }, + "definitions": { + "VirtualHubId": { + "properties": { + "id": { + "type": "string", + "description": "The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription." + } + }, + "description": "Virtual Hub identifier." + }, + "ExpressRouteCircuitPeeringId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the ExpressRoute circuit peering." + } + }, + "description": "ExpressRoute circuit peering identifier." + }, + "ExpressRouteConnectionId": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the ExpressRouteConnection." + } + }, + "description": "The ID of the ExpressRouteConnection." + }, + "ExpressRouteGatewayProperties": { + "required": [ + "virtualHub" + ], + "properties": { + "autoScaleConfiguration": { + "properties": { + "bounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum number of scale units deployed for ExpressRoute gateway." + }, + "max": { + "type": "integer", + "description": "Maximum number of scale units deployed for ExpressRoute gateway." + } + }, + "description": "Minimum and maximum number of scale units to deploy." + } + }, + "description": "Configuration for auto scaling." + }, + "expressRouteConnections": { + "type": "array", + "readOnly": true, + "description": "List of ExpressRoute connections to the ExpressRoute gateway.", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource.", + "enum":[ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "virtualHub": { + "$ref": "#/definitions/VirtualHubId", + "description": "The Virtual Hub where the ExpressRoute gateway is or will be deployed." + } + }, + "description": "ExpressRoute gateway resource properties." + }, + "ExpressRouteGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteGatewayProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRoute gateway resource." + }, + "ExpressRouteGatewayList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "List of ExpressRoute gateways." + } + }, + "description": "List of ExpressRoute gateways." + }, + "ExpressRouteConnectionProperties": { + "required": [ + "expressRouteCircuitPeering" + ], + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource.", + "enum":[ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "expressRouteCircuitPeering": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringId", + "description": "The ExpressRoute circuit peering." + }, + "authorizationKey": { + "type": "string", + "description": "Authorization key to establish the connection." + }, + "routingWeight": { + "type": "integer", + "description": "The routing weight associated to the connection." + } + }, + "description": "Properties of the ExpressRouteConnection subresource." + }, + "ExpressRouteConnection": { + "required": [ + "name" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteConnectionProperties" + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ExpressRouteConnection resource." + }, + "ExpressRouteConnectionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "The list of ExpressRoute connections" + } + }, + "description": "ExpressRouteConnection list" + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json new file mode 100644 index 000000000000..ff96bc44fa0b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRoutePort.json @@ -0,0 +1,747 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_List", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retriving a specific peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all ExpressRoutePort peering locations.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortsLocationList": { "$ref": "./examples/ExpressRoutePortsLocationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_Get", + "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the requested ExpressRoutePort peering location." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort peering location.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortsLocationGet": { "$ref": "./examples/ExpressRoutePortsLocationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { + "delete": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Delete", + "description": "Deletes the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortDelete": { "$ref": "./examples/ExpressRoutePortDelete.json" } + } + }, + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Get", + "description": "Retrieves the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortGet": { "$ref": "./examples/ExpressRoutePortGet.json" } + } + }, + "put": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_CreateOrUpdate", + "description": "Creates or updates the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "Parameters supplied to the create ExpressRoutePort operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortCreate": { "$ref": "./examples/ExpressRoutePortCreate.json" }, + "ExpressRoutePortUpdateLink": { "$ref": "./examples/ExpressRoutePortUpdateLink.json" } + } + }, + "patch": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_UpdateTags", + "description": "Update ExpressRoutePort tags", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ExpressRoutePort resource tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ExpressRoutePortUpdateTags": { "$ref": "./examples/ExpressRoutePortUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_ListByResourceGroup", + "description": "List all the ExpressRoutePort resources in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortListByResourceGroup": { "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_List", + "description": "List all the ExpressRoutePort resources in the specified subscription", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortList": { "$ref": "./examples/ExpressRoutePortList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_Get", + "description": "Retrieves the specified ExpressRouteLink resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteLink resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRouteLink resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteLink" + } + } + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_List", + "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteLinkListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { "$ref": "./examples/ExpressRouteLinkList.json" } + } + } + } + }, + "definitions": { + "ExpressRoutePortsLocationBandwidths": { + "title": "ExpressRoutePorts Location Bandwidths", + "description" : "Real-time inventory of available ExpressRoute port bandwidths.", + "properties": { + "offerName": { + "type": "string", + "readOnly": true, + "description": "Bandwidth descriptive name" + }, + "valueInGbps": { + "type": "integer", + "readOnly": true, + "description": "Bandwidth value in Gbps" + } + } + }, + "ExpressRoutePortsLocationPropertiesFormat": { + "title": "ExpressRoutePorts Location Properties", + "description" : "Properties specific to ExpressRoutePorts peering location resources.", + "properties": { + "address": { + "type": "string", + "readOnly": true, + "description": "Address of peering location." + }, + "contact": { + "type": "string", + "readOnly": true, + "description": "Contact details of peering locations." + }, + "availableBandwidths": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" + }, + "description": "The inventory of available ExpressRoutePort bandwidths." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRoutePortLocation resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRoutePortsLocation": { + "title": "ExpressRoutePorts Peering Location", + "description": "Definition of the ExpressRoutePorts peering location resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", + "description": "ExpressRoutePort peering location properties" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortsLocationListResult": { + "title": "ExpressRoutePorts Location List Result", + "description": "Response for ListExpressRoutePortsLocations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + }, + "description": "The list of all ExpressRoutePort peering locations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRouteLinkPropertiesFormat": { + "title": "ExpressRouteLink Resource Properties", + "description": "Properties specific to ExpressRouteLink resources.", + "properties": { + "routerName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router associated with physical port." + }, + "interfaceName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router interface." + }, + "patchPanelId": { + "readOnly": true, + "type": "string", + "description": "Mapping between physical port to patch panel port." + }, + "rackId": { + "readOnly": true, + "type": "string", + "description": "Mapping of physical patch panel to rack." + }, + "connectorType": { + "readOnly": true, + "type": "string", + "description": "Physical fiber port type.", + "enum": [ + "LC", + "SC" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkConnectorType", + "modelAsString": true + } + }, + "adminState": { + "type": "string", + "description": "Administrative state of the physical port", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkAdminState", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRouteLink resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + } + } + }, + "ExpressRouteLink": { + "title" : "ExpressRouteLink", + "description": "ExpressRouteLink child resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", + "description": "ExpressRouteLink properties" + }, + "name": { + "type": "string", + "description": "Name of child port resource that is unique among child port resources of the parent." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRouteLinkListResult": { + "title": "ExpressRouteLink List Result", + "description": "Response for ListExpressRouteLinks API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + }, + "description": "The list of ExpressRouteLink sub-resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRoutePortPropertiesFormat": { + "title": "ExpressRoutePort Properties", + "description" : "Properties specific to ExpressRoutePort resources.", + "properties": { + "peeringLocation": { + "type": "string", + "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." + }, + "bandwidthInGbps": { + "type": "integer", + "description": "Bandwidth of procured ports in Gbps" + }, + "provisionedBandwidthInGbps": { + "readOnly": true, + "type": "number", + "description": "Aggregate Gbps of associated circuit bandwidths." + }, + "mtu": { + "readOnly": true, + "type": "string", + "description": "Maximum transmission unit of the physical port pair(s)" + }, + "encapsulation": { + "type": "string", + "description": "Encapsulation method on physical ports.", + "enum": [ + "Dot1Q", + "QinQ" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsEncapsulation", + "modelAsString": true + } + }, + "etherType": { + "readOnly": true, + "type": "string", + "description": "Ethertype of the physical port." + }, + "allocationDate": { + "readOnly": true, + "type": "string", + "description": "Date of the physical port allocation to be used in Letter of Authorization." + }, + "links": { + "title" : "ExpressRouteLink Sub-Resources", + "description" : "The set of physical links of the ExpressRoutePort resource", + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "circuits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the ExpressRoutePort resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the ExpressRoutePort resource." + } + } + }, + "ExpressRoutePort": { + "title": "ExpressRoute Port", + "description": "ExpressRoutePort resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", + "description": "ExpressRoutePort properties" + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortListResult": { + "title": "ExpressRoute Port List Result", + "description": "Response for ListExpressRoutePorts API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "A list of ExpressRoutePort resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json new file mode 100644 index 000000000000..c6e77e32e8cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json @@ -0,0 +1,338 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints/{interfaceEndpointName}": { + "delete": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Delete", + "description": "Deletes the specified interface endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete interface endpoint": { "$ref": "./examples/InterfaceEndpointDelete.json" } + } + }, + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_Get", + "description": "Gets the specified interface endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-examples": { + "Get interface endpoint": { "$ref": "./examples/InterfaceEndpointGet.json" } + } + }, + "put": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_CreateOrUpdate", + "description": "Creates or updates an interface endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "interfaceEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the interface endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Parameters supplied to the create or update interface endpoint operation" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting InterfaceEndpoint resource.", + "schema": { + "$ref": "#/definitions/InterfaceEndpoint" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create interface endpoint": { "$ref": "./examples/InterfaceEndpointCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_List", + "description": "Gets all interface endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List interface endpoints in resource group": { "$ref": "./examples/InterfaceEndpointList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/interfaceEndpoints": { + "get": { + "tags": [ + "InterfaceEndpoints" + ], + "operationId": "InterfaceEndpoints_ListBySubscription", + "description": "Gets all interface endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of InterfaceEndpoint resources.", + "schema": { + "$ref": "#/definitions/InterfaceEndpointListResult" + } + } + }, + "x-ms-examples": { + "List all interface endpoints": { "$ref": "./examples/InterfaceEndpointListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "InterfaceEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InterfaceEndpointProperties", + "description": "Properties of the interface endpoint." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Interface endpoint resource." + }, + "InterfaceEndpointProperties": { + "properties": { + "fqdn": { + "type": "string", + "description": "A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint." + }, + "endpointService": { + "$ref": "#/definitions/EndpointService", + "description": "A reference to the service being brought into the virtual network." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "Gets an array of references to the network interfaces created for this interface endpoint." + }, + "owner": { + "type": "string", + "readOnly": true, + "description": "A read-only property that identifies who created this interface endpoint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the interface endpoint." + }, + "EndpointService": { + "properties": { + "id": { + "type": "string", + "description": "A unique identifier of the service being referenced by the interface endpoint." + } + }, + "description": "Identifies the service being brought into the virtual network." + }, + "InterfaceEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InterfaceEndpoint" + }, + "description": "Gets a list of InterfaceEndpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListInterfaceEndpoints API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/loadBalancer.json new file mode 100644 index 000000000000..6f3b4caa4fab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/loadBalancer.json @@ -0,0 +1,1804 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "description": "Deletes the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete load balancer": { "$ref": "./examples/LoadBalancerDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "description": "Gets the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Get load balancer": { "$ref": "./examples/LoadBalancerGet.json" } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "description": "Creates or updates a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "Parameters supplied to the create or update load balancer operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Create load balancer": { "$ref": "./examples/LoadBalancerCreate.json" }, + "Create load balancer with inbound nat pool": { "$ref": "./examples/LoadBalancerCreateWithInboundNatPool.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_UpdateTags", + "description": "Updates a load balancer tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update load balancer tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + } + }, + "x-ms-examples": { + "Update load balancer tags": { "$ref": "./examples/LoadBalancerUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListAll", + "description": "Gets all the load balancers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + } + }, + "x-ms-examples": { + "List all load balancers": { "$ref": "./examples/LoadBalancerListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_List", + "description": "Gets all the load balancers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { "$ref": "./examples/LoadBalancerList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_List", + "description": "Gets all the load balancer backed address pools.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer BackendAddressPool resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerBackendAddressPoolListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolList": { "$ref": "./examples/LoadBalancerBackendAddressPoolList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_Get", + "description": "Gets load balancer backend address pool.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "backendAddressPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backend address pool." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer BackendAddressPool resource.", + "schema": { + "$ref": "#/definitions/BackendAddressPool" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolGet": { "$ref": "./examples/LoadBalancerBackendAddressPoolGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_List", + "description": "Gets all the load balancer frontend IP configurations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer FrontendIPConfiguration resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerFrontendIPConfigurationListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationList": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_Get", + "description": "Gets load balancer frontend IP configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "frontendIPConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the frontend IP configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer FrontendIPConfiguration resource.", + "schema": { + "$ref": "#/definitions/FrontendIPConfiguration" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationGet": { "$ref": "./examples/LoadBalancerFrontendIPConfigurationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_List", + "description": "Gets all the inbound nat rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer InboundNatRule resources.", + "schema": { + "$ref": "#/definitions/InboundNatRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InboundNatRuleList": { "$ref": "./examples/InboundNatRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Delete", + "description": "Deletes the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "InboundNatRuleDelete": { "$ref": "./examples/InboundNatRuleDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Get", + "description": "Gets the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + } + }, + "x-ms-examples": { + "InboundNatRuleGet": { "$ref": "./examples/InboundNatRuleGet.json" } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_CreateOrUpdate", + "description": "Creates or updates a load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "name": "inboundNatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Parameters supplied to the create or update inbound nat rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InboundNatRuleCreate": { "$ref": "./examples/InboundNatRuleCreate.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_List", + "description": "Gets all the load balancing rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer LoadBalancingRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerLoadBalancingRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleList": { "$ref": "./examples/LoadBalancerLoadBalancingRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_Get", + "description": "Gets the specified load balancer load balancing rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "loadBalancingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancing rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancingRule resource.", + "schema": { + "$ref": "#/definitions/LoadBalancingRule" + } + } + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleGet": { "$ref": "./examples/LoadBalancerLoadBalancingRuleGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_List", + "description": "Gets all the outbound rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer OutboundRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerOutboundRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleList": { "$ref": "./examples/LoadBalancerOutboundRuleList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_Get", + "description": "Gets the specified load balancer outbound rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "outboundRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting OutboundRule resource.", + "schema": { + "$ref": "#/definitions/OutboundRule" + } + } + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleGet": { "$ref": "./examples/LoadBalancerOutboundRuleGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerNetworkInterfaces_List", + "description": "Gets associated load balancer network interfaces.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerNetworkInterfaceListVmss": { "$ref": "./examples/LoadBalancerNetworkInterfaceListVmss.json" }, + "LoadBalancerNetworkInterfaceListSimple": { "$ref": "./examples/LoadBalancerNetworkInterfaceListSimple.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_List", + "description": "Gets all the load balancer probes.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer Probe resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerProbeListResult" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeList": { "$ref": "./examples/LoadBalancerProbeList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_Get", + "description": "Gets load balancer probe.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "probeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the probe." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer Probe resource.", + "schema": { + "$ref": "#/definitions/Probe" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeGet": { "$ref": "./examples/LoadBalancerProbeGet.json" } + } + } + } + }, + "definitions": { + "LoadBalancerSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a load balancer SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "LoadBalancerSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a load balancer" + }, + "FrontendIPConfigurationPropertiesFormat": { + "properties": { + "inboundNatRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Inbound rules URIs that use this frontend IP." + }, + "inboundNatPools": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Inbound pools URIs that use this frontend IP." + }, + "outboundRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Read only. Outbound rules URIs that use this frontend IP." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Gets load balancing rules URIs that use this frontend IP." + }, + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "The Private IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference of the Public IP resource." + }, + "publicIPPrefix": { + "$ref":"./network.json#/definitions/SubResource", + "description": "The reference of the Public IP Prefix resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Frontend IP Configuration of the load balancer." + }, + "FrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat", + "description": "Properties of the load balancer probe." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP address of the load balancer." + }, + "BackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Gets collection of references to IP addresses defined in network interfaces." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Gets load balancing rules that use this backend address pool." + }, + "outboundRule": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "Gets outbound rules that use this backend address pool." + }, + "provisioningState": { + "type": "string", + "description": "Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the backend address pool." + }, + "BackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendAddressPoolPropertiesFormat", + "description": "Properties of load balancer backend address pool." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Pool of backend IP addresses." + }, + "LoadBalancingRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the load balancer probe used by the load balancing rule." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "loadDistribution": { + "type": "string", + "description": "The load distribution policy for this rule. Possible values are 'Default', 'SourceIP', and 'SourceIPProtocol'.", + "enum": [ + "Default", + "SourceIP", + "SourceIPProtocol" + ], + "x-ms-enum": { + "name": "LoadDistribution", + "modelAsString": true + } + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\"" + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"" + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "disableOutboundSnat": { + "type": "boolean", + "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "frontendPort" + ], + "description": "Properties of the load balancer." + }, + "LoadBalancingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancingRulePropertiesFormat", + "description": "Properties of load balancer load balancing rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancing rule for a load balancer." + }, + "ProbePropertiesFormat": { + "properties": { + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The load balancer rules that use this probe." + }, + "protocol": { + "type": "string", + "description": "The protocol of the end point. Possible values are: 'Http', 'Tcp', or 'Https'. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", + "enum": [ + "Http", + "Tcp", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int32", + "description": "The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5." + }, + "numberOfProbes": { + "type": "integer", + "format": "int32", + "description": "The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure." + }, + "requestPath": { + "type": "string", + "description": "The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "port" + ], + "description": "Load balancer probe resource." + }, + "Probe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProbePropertiesFormat", + "description": "Properties of load balancer probe." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancer probe." + }, + "InboundNatRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendIPConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the inbound NAT rule." + }, + "InboundNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatRulePropertiesFormat", + "description": "Properties of load balancer inbound nat rule." + }, + "name": { + "type": "string", + "description": "Gets name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT rule of the load balancer." + }, + "InboundNatPoolPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol" + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "description": "The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "description": "The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "frontendPortRangeStart", + "frontendPortRangeEnd", + "backendPort" + ], + "description": "Properties of Inbound NAT pool." + }, + "InboundNatPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatPoolPropertiesFormat", + "description": "Properties of load balancer inbound nat pool." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT pool of the load balancer." + }, + "OutboundRulePropertiesFormat": { + "properties": { + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "description": "The number of outbound ports to be used for NAT." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The Frontend IP addresses of the load balancer." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "protocol": { + "type": "string", + "description": "Protocol - TCP, UDP or All", + "enum": [ + "Tcp", + "Udp", + "All" + ] + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "description": "The timeout for the TCP idle connection" + } + }, + "required": [ + "backendAddressPool", + "frontendIPConfigurations", + "protocol" + ], + "description": "Outbound pool of the load balancer." + }, + "OutboundRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OutboundRulePropertiesFormat", + "description": "Properties of load balancer outbound rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Outbound pool of the load balancer." + }, + "LoadBalancerPropertiesFormat": { + "properties": { + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "Object representing the frontend IPs to be used for the load balancer" + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "Collection of backend address pools used by a load balancer" + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "Object collection representing the load balancing rules Gets the provisioning " + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "Collection of probe objects used in the load balancer" + }, + "inboundNatRules": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "description": "Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "outboundRules": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRule" + }, + "description": "The outbound rules." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the load balancer resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the load balancer." + }, + "LoadBalancer": { + "properties": { + "sku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "The load balancer SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancerPropertiesFormat", + "description": "Properties of load balancer." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "LoadBalancer resource" + }, + "LoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "A list of load balancers in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancers API service call." + }, + "InboundNatRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "A list of inbound nat rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListInboundNatRule API service call." + }, + "LoadBalancerBackendAddressPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "A list of backend address pools in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListBackendAddressPool API service call." + }, + "LoadBalancerFrontendIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "A list of frontend IP configurations in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListFrontendIPConfiguration API service call." + }, + "LoadBalancerLoadBalancingRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "A list of load balancing rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancingRule API service call." + }, + "LoadBalancerOutboundRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRule" + }, + "description": "A list of outbound rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListOutboundRule API service call." + }, + "LoadBalancerProbeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "A list of probes in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListProbe API service call." + }, + "TransportProtocol": { + "type": "string", + "description": "The transport protocol for the endpoint. Possible values are 'Udp' or 'Tcp' or 'All'.", + "enum": [ + "Udp", + "Tcp", + "All" + ], + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/network.json new file mode 100644 index 000000000000..5cd16b55c2f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/network.json @@ -0,0 +1,213 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + }, + "definitions": { + "ErrorDetails": { + "properties": { + "code": { + "type": "string" + }, + "target": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "Error": { + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "innerError": { + "type": "string" + } + } + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "NetworkOperationStatus", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error" + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ManagedServiceIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the resource." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json new file mode 100644 index 000000000000..9cd88aca4b68 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkInterface.json @@ -0,0 +1,1393 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}": { + "delete": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Delete", + "description": "Deletes the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network interface": { "$ref": "./examples/NetworkInterfaceDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Get", + "description": "Gets information about the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Get network interface": { "$ref": "./examples/NetworkInterfaceGet.json" } + } + }, + "put": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_CreateOrUpdate", + "description": "Creates or updates a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "Parameters supplied to the create or update network interface operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Create network interface": { "$ref": "./examples/NetworkInterfaceCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_UpdateTags", + "description": "Updates a network interface tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network interface tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Update network interface tags": { "$ref": "./examples/NetworkInterfaceUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListAll", + "description": "Gets all network interfaces in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List all network interfaces": { "$ref": "./examples/NetworkInterfaceListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_List", + "description": "Gets all network interfaces in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List network interfaces in resource group": { "$ref": "./examples/NetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetEffectiveRouteTable", + "description": "Gets all route tables applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of EffectRoute resources.", + "schema": { + "$ref": "#/definitions/EffectiveRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Show network interface effective route tables": { "$ref": "./examples/NetworkInterfaceEffectiveRouteTableList.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListEffectiveNetworkSecurityGroups", + "description": "Gets all network security groups applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "List network interface effective network security groups": { "$ref": "./examples/NetworkInterfaceEffectiveNSGList.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_List", + "description": "Get all ip configurations in a network interface", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface IPConfiguration resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationList": { "$ref": "./examples/NetworkInterfaceIPConfigurationList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_Get", + "description": "Gets the specified network interface ip configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface IPConfiguration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + } + } + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationGet": { "$ref": "./examples/NetworkInterfaceIPConfigurationGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceLoadBalancers_List", + "description": "List all load balancers in a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceLoadBalancerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceLoadBalancerList": { "$ref": "./examples/NetworkInterfaceLoadBalancerList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}": { + "delete": { + "tags": [ + "Network Interfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_Delete", + "description": "Deletes the specified tap configuration from the NetworkInterface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": + { + "Delete tap configuration": { "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_Get", + "description": "Get the specified tap configuration on a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a tap configuration.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + } + }, + "x-ms-examples": + { + "Get Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" } + } + }, + "put": { + "tags": [ + "Network Interfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_CreateOrUpdate", + "description": "Creates or updates a Tap configuration in the specified NetworkInterface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "name": "tapConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "Parameters supplied to the create or update tap configuration operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Tap Configuration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Tap configuration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + } + }, + "x-ms-examples": + { + "Create Network Interface Tap Configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_List", + "description": "Get all Tap configurations in a network interface", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface TapConfiguration resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfigurationListResult" + } + } + }, + "x-ms-examples": { + "List virtual network tap configurations": { "$ref": "./examples/NetworkInterfaceTapConfigurationList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkInterfaceTapConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceTapConfigurationPropertiesFormat", + "description": "Properties of the Virtual Network Tap configuration" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Tap configuration in a Network Interface" + }, + "NetworkInterfaceTapConfigurationPropertiesFormat": { + "properties": { + "virtualNetworkTap": { + "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", + "description": "The reference of the Virtual Network Tap resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of Virtual Network Tap configuration." + }, + "NetworkInterfaceIPConfigurationPropertiesFormat": { + "properties": { + "virtualNetworkTaps": { + "type": "array", + "items": { + "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap" + }, + "description": "The reference to Virtual Network Taps." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "The reference of ApplicationGatewayBackendAddressPool resource." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/BackendAddressPool" + }, + "description": "The reference of LoadBalancerBackendAddressPool resource." + }, + "loadBalancerInboundNatRules": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/InboundNatRule" + }, + "description": "A list of references of LoadBalancerInboundNatRules." + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "Defines how a private IP address is assigned. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "Subnet bound to the IP configuration." + }, + "primary": { + "type": "boolean", + "description": "Gets whether this is a primary customer address on the network interface." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "Public IP address bound to the IP configuration." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the IP configuration is included." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration." + }, + "NetworkInterfaceIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", + "description": "Network interface IP configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IPConfiguration in a network interface." + }, + "NetworkInterfaceDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." + }, + "appliedDnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." + }, + "internalDnsNameLabel": { + "type": "string", + "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." + }, + "internalFqdn": { + "type": "string", + "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." + }, + "internalDomainNameSuffix": { + "type": "string", + "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." + } + }, + "description": "DNS settings of a network interface." + }, + "NetworkInterfacePropertiesFormat": { + "properties": { + "virtualMachine": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of a virtual machine.", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference of the NetworkSecurityGroup resource." + }, + "interfaceEndpoint": { + "readOnly": true, + "$ref": "./interfaceEndpoint.json#/definitions/InterfaceEndpoint", + "description": "A reference to the interface endpoint to which the network interface is linked." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IPConfigurations of the network interface." + }, + "tapConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of TapConfigurations of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/NetworkInterfaceDnsSettings", + "description": "The DNS settings in network interface." + }, + "macAddress": { + "type": "string", + "description": "The MAC address of the network interface." + }, + "primary": { + "type": "boolean", + "description": "Gets whether this is a primary network interface on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "If the network interface is accelerated networking enabled." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Indicates whether IP forwarding is enabled on this network interface." + }, + "hostedWorkloads": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "A list of references to linked BareMetal resources" + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "NetworkInterface properties. " + }, + "NetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfacePropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A network interface in a resource group." + }, + "NetworkInterfaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "A list of network interfaces in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListNetworkInterface API service call." + }, + "NetworkInterfaceTapConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of tap configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list tap configurations API service call." + }, + "NetworkInterfaceIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of ip configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "NetworkInterfaceLoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/LoadBalancer" + }, + "description": "A list of load balancers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "EffectiveNetworkSecurityGroup": { + "properties": { + "networkSecurityGroup": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of network security group that is applied." + }, + "association": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", + "description": "Associated resources." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "A collection of effective security rules." + }, + "tagMap": { + "type": "string", + "additionalProperties": { + "type":"array", + "items": { + "type": "string" + }, + "description": "List of IP Addresses within the tag (key)" + }, + "description": "Mapping of tags to list of IP Addresses included within the tag." + } + }, + "description": "Effective network security group." + }, + "EffectiveNetworkSecurityGroupAssociation": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the subnet if assigned." + }, + "networkInterface": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the network interface if assigned." + } + }, + "description": "The effective network security group association." + }, + "EffectiveNetworkSecurityRule": { + "properties": { + "name": { + "type": "string", + "description": "The name of the security rule specified by the user (if created by the user)." + }, + "protocol": { + "type": "string", + "description": "The network protocol this rule applies to. Possible values are: 'Tcp', 'Udp', and 'All'.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "EffectiveSecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)" + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as seperator (e.g. 100-400), or an asterix (*)" + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix." + }, + "sourceAddressPrefixes" : { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + }, + "destinationAddressPrefixes" : { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AureLoadBalancer, Internet), System Tags, and the asterix (*)." + }, + "expandedSourceAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The expanded source address prefix." + }, + "expandedDestinationAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expanded destination address prefix." + }, + "access": { + "type": "string", + "description": "Whether network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule." + }, + "direction": { + "type": "string", + "description": "The direction of the rule. Possible values are: 'Inbound and Outbound'.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + } + }, + "description": "Effective network security rules." + }, + "EffectiveNetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroup" + }, + "description": "A list of effective network security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective network security groups API service call." + }, + "EffectiveRoute": { + "properties": { + "name": { + "type": "string", + "description": "The name of the user defined route. This is optional." + }, + "source": { + "type": "string", + "description": "Who created the route. Possible values are: 'Unknown', 'User', 'VirtualNetworkGateway', and 'Default'.", + "enum": [ + "Unknown", + "User", + "VirtualNetworkGateway", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveRouteSource", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The value of effective route. Possible values are: 'Active' and 'Invalid'.", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "name": "EffectiveRouteState", + "modelAsString": true + } + }, + "addressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The address prefixes of the effective routes in CIDR notation." + }, + "nextHopIpAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP address of the next hop of the effective route." + }, + "nextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'.", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + } + }, + "description": "Effective Route" + }, + "EffectiveRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRoute" + }, + "description": "A list of effective routes." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective route API service call." + }, + "IPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "The private IP allocation method. Possible values are 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference of the public IP resource." + }, + "provisioningState": { + "type": "string", + "description": "Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of IP configuration." + }, + "IPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationPropertiesFormat", + "description": "Properties of the IP configuration" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json new file mode 100644 index 000000000000..a544279ff225 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkProfile.json @@ -0,0 +1,575 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}": { + "delete": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Delete", + "description": "Deletes the specified network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NetworkProfile." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network profile": { + "$ref": "./examples/NetworkProfileDelete.json" + } + }, + "x-ms-long-running-operation": false + }, + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Get", + "description": "Gets the specified network profile in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIPPrefx." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + } + }, + "x-ms-examples": { + "Get network profile": { + "$ref": "./examples/NetworkProfileGetConfigOnly.json" + }, + "Get network profile with container network interfaces": { + "$ref": "./examples/NetworkProfileGetWithContainerNic.json" + } + } + }, + "put": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_CreateOrUpdate", + "description": "Creates or updates a network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "Parameters supplied to the create or update network profile operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + } + }, + "x-ms-examples": { + "Create network profile defaults": { + "$ref": "./examples/NetworkProfileCreateConfigOnly.json" + } + }, + "x-ms-long-running-operation": false + }, + "patch": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_UpdateTags", + "description": "Updates network profile tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network profile tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + } + }, + "x-ms-examples": { + "Update network profile tags": { + "$ref": "./examples/NetworkProfileUpdateTags.json" + } + }, + "x-ms-long-running-operation": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_ListAll", + "description": "Gets all the network profiles in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + } + }, + "x-ms-examples": { + "List all network profilees": { + "$ref": "./examples/NetworkProfileListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_List", + "description": "Gets all network profiles in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + } + }, + "x-ms-examples": { + "List resource group network profilees": { + "$ref": "./examples/NetworkProfileList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkProfilePropertiesFormat": { + "properties": { + "containerNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterface" + }, + "description": "List of child container network interfaces." + }, + "containerNetworkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration" + }, + "description": "List of chid container network interface configurations." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Network profile properties." + }, + "NetworkProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProfilePropertiesFormat", + "description": "Network profile properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network profile resource." + }, + "NetworkProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "A list of network profiles that exist in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkProfiles API service call." + }, + "ContainerNetworkInterfacePropertiesFormat": { + "properties": { + "containerNetworkInterfaceConfiguration": { + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration", + "description": "Container network interface configuration from which this container network interface is created." + }, + "container": { + "$ref": "#/definitions/Container", + "description": "Reference to the conatinaer to which this container network interface is attached." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfiguration" + }, + "description": "Reference to the ip configuration on this container nic." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + } + }, + "ContainerNetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfacePropertiesFormat", + "description": "Container network interface properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface child resource." + }, + "ContainerNetworkInterfaceConfigurationPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationProfile" + }, + "description": "A list of ip configurations of the container network interface configuration." + }, + "containerNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A list of container network interfaces created from this container network interface configuration." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Container network interface configuration properties." + }, + "ContainerNetworkInterfaceConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfigurationPropertiesFormat", + "description": "Container network interface configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface configruation child resource." + }, + "IPConfigurationProfilePropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference of the subnet resource to create a contatainer network interface ip configruation." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "IP configruation profile properties." + }, + "IPConfigurationProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationProfilePropertiesFormat", + "description": "Properties of the IP configuration profile." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration profile child resource." + }, + "Container": { + "properties": { }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Reference to container resource in remote resource provider." + }, + "ContainerNetworkInterfaceIpConfigurationPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of the container network interface IP configuration." + }, + "ContainerNetworkInterfaceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", + "description": "Properties of the container network interface IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "The ip configuration for a container network interface." + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json new file mode 100644 index 000000000000..40f9da06d593 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json @@ -0,0 +1,848 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}": { + "delete": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Delete", + "description": "Deletes the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-examples": { + "Delete network security group": { "$ref": "./examples/NetworkSecurityGroupDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Get", + "description": "Gets the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Get network security group": { "$ref": "./examples/NetworkSecurityGroupGet.json" } + } + }, + "put": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "Parameters supplied to the create or update network security group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Create network security group": { "$ref": "./examples/NetworkSecurityGroupCreate.json" }, + "Create network security group with rule": { "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_UpdateTags", + "description": "Updates a network security group tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_ListAll", + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List all network security groups": { "$ref": "./examples/NetworkSecurityGroupListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_List", + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { "$ref": "./examples/NetworkSecurityGroupList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "delete": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Delete", + "description": "Deletes the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete network security rule from network security group": { "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Get", + "description": "Get the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleGet.json" } + } + }, + "put": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_CreateOrUpdate", + "description": "Creates or updates a security rule in the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "name": "securityRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "Parameters supplied to the create or update network security rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "Create security rule": { "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_List", + "description": "Gets all security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { "$ref": "./examples/NetworkSecurityGroupRuleList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_List", + "description": "Gets all default security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleList": { "$ref": "./examples/DefaultSecurityRuleList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}" : { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_Get", + "description": "Get the specified default network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "defaultSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the default security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleGet": { "$ref": "./examples/DefaultSecurityRuleGet.json" } + } + } + } + }, + "definitions": { + "SecurityRulePropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', and '*'.", + "enum": [ + "Tcp", + "Udp", + "*" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range. Integer or range between 0 and 65535. Asterix '*' can also be used to match all ports." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. " + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "sourceApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as source." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterix '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "destinationApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as destination." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are: 'Allow' and 'Deny'.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic. Possible values are: 'Inbound' and 'Outbound'.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "protocol", + "access", + "direction" + ], + "description": "Security rule resource." + }, + "SecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityRulePropertiesFormat", + "description": "Properties of the security rule" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network security rule." + }, + "SecurityRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The security rules in a network security group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." + }, + "NetworkSecurityGroupPropertiesFormat": { + "properties": { + "securityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "A collection of security rules of the network security group." + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The default security rules of network security group." + }, + "networkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "A collection of references to network interfaces." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the network security group resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Network Security Group resource." + }, + "NetworkSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", + "description": "Properties of the network security group" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkSecurityGroup resource." + }, + "NetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "A list of NetworkSecurityGroup resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkSecurityGroups API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json new file mode 100644 index 000000000000..8d4190a3b8d7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json @@ -0,0 +1,3648 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}": { + "put": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CreateOrUpdate", + "description": "Creates or updates a network watcher in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "Parameters that define the network watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network watcher": { "$ref": "./examples/NetworkWatcherCreate.json" } + } + }, + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Get", + "description": "Gets the specified network watcher by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network watcher": { "$ref": "./examples/NetworkWatcherGet.json" } + } + }, + "delete": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified network watcher resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network watcher": { "$ref": "./examples/NetworkWatcherDelete.json" } + } + }, + "patch": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_UpdateTags", + "description": "Updates a network watcher tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network watcher tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network watcher tags": { "$ref": "./examples/NetworkWatcherUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_List", + "description": "Gets all network watchers by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List network watchers": { "$ref": "./examples/NetworkWatcherList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAll", + "description": "Gets all network watchers by subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List all network watchers": { "$ref": "./examples/NetworkWatcherListAll.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTopology", + "description": "Gets the current network topology by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TopologyParameters" + }, + "description": "Parameters that define the representation of topology." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the topology of resource group.", + "schema": { + "$ref": "#/definitions/Topology" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Topology": { + "$ref": "./examples/NetworkWatcherTopologyGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_VerifyIPFlow", + "x-ms-long-running-operation": true, + "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VerificationIPFlowParameters" + }, + "description": "Parameters that define the IP flow to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of IP flow verification.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ip flow verify": { "$ref": "./examples/NetworkWatcherIpFlowVerify.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNextHop", + "x-ms-long-running-operation": true, + "description": "Gets the next hop from the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NextHopParameters" + }, + "description": "Parameters that define the source and destination endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the next hop from the VM.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get next hop": { "$ref": "./examples/NetworkWatcherNextHopGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetVMSecurityRules", + "x-ms-long-running-operation": true, + "description": "Gets the configured and effective security group rules on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityGroupViewParameters" + }, + "description": "Parameters that define the VM to check security groups for." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns security group rules on the VM.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get security group view": { "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { + "put": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Create", + "x-ms-long-running-operation": true, + "description": "Create and start a packet capture on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCapture" + }, + "description": "Parameters that define the create packet capture operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" } + } + }, + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Get", + "description": "Gets a packet capture session by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" } + } + }, + "delete": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Stop", + "x-ms-long-running-operation": true, + "description": "Stops a specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the packet capture session." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop packet capture": { "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_GetStatus", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Query the status of a running packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of packet capture status.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "202": { + "description": "Accepted query status of packet capture.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query packet capture status": { "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_List", + "description": "Lists all packet capture sessions within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful packet capture enumeration request.", + "schema": { + "$ref": "#/definitions/PacketCaptureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List packet captures": { "$ref": "./examples/NetworkWatcherPacketCapturesList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshooting", + "x-ms-long-running-operation": true, + "description": "Initiate troubleshooting on a specified resource", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TroubleshootingParameters" + }, + "description": "Parameters that define the resource to troubleshoot." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful troubleshooting request", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshooting": { "$ref": "./examples/NetworkWatcherTroubleshootGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshootingResult", + "x-ms-long-running-operation": true, + "description": "Get the last completed troubleshooting result on a specified resource", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTroubleshootingParameters" + }, + "description": "Parameters that define the resource to query the troubleshooting result." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful get troubleshooting result request", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshoot result": { "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_SetFlowLogConfiguration", + "x-ms-long-running-operation": true, + "description": "Configures flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogInformation" + }, + "description": "Parameters that define the configuration of flow log." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Configure flow log": { "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_GetFlowLogStatus", + "x-ms-long-running-operation": true, + "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogStatusParameters" + }, + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for query flow log and traffic analytics (optional) status.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log status": { "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CheckConnectivity", + "x-ms-long-running-operation": true, + "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityParameters" + }, + "description": "Parameters that determine how the connectivity check will be performed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for checking connectivity.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check connectivity": { "$ref": "./examples/NetworkWatcherConnectivityCheck.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetAzureReachabilityReport", + "x-ms-long-running-operation": true, + "description": "Gets the relative latency score for internet service providers from a specified location to Azure regions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureReachabilityReportParameters" + }, + "description": "Parameters that determine Azure reachability report configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for Azure reachability report.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Reachability Report": { + "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAvailableProviders", + "x-ms-long-running-operation": true, + "description": "Lists all available internet service providers for a specified Azure region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableProvidersListParameters" + }, + "description": "Parameters that scope the list of available providers." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for list of available providers.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Available Providers List": { + "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { + "put": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Create or update a connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitor" + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" } + } + }, + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Get", + "description": "Gets a connection monitor by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" } + } + }, + "delete": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Stop", + "x-ms-long-running-operation": true, + "description": "Stops the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/start": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Start", + "x-ms-long-running-operation": true, + "description": "Starts the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorStart.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/query": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Query", + "x-ms-long-running-operation": true, + "description": "Query a snapshot of the most recent connection states.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "202": { + "description": "Accepted query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query connection monitor": { "$ref": "./examples/NetworkWatcherConnectionMonitorQuery.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_List", + "description": "Lists all connection monitors for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful connection monitor enumeration request.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List connection monitors": { "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Get network configuration diagnostic.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticParameters" + }, + "description": "Parameters to get network configuration diagnostic." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of network condifuration diagnostic.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Network configuration diagnostic": { "$ref": "./examples/NetworkWatcherNetworkConfigurationDiagnostic.json" } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "The error object.", + "properties": { + "error": { + "title": "Error", + "$ref": "./network.json#/definitions/ErrorDetails" + } + } + }, + "NetworkWatcher": { + "properties": { + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkWatcherPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network watcher in a resource group." + }, + "NetworkWatcherPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the resource." + } + }, + "description": "The network watcher properties." + }, + "NetworkWatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkWatcher" + } + } + }, + "description": "List of network watcher resources." + }, + "TopologyParameters": { + "properties": { + "targetResourceGroupName": { + "type": "string", + "description": "The name of the target resource group to perform topology on." + }, + "targetVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the Virtual Network resource." + }, + "targetSubnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the Subnet resource." + } + }, + "description": "Parameters that define the representation of topology." + }, + "Topology": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "GUID representing the operation id." + }, + "createdDateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was initially created for the resource group." + }, + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was last modified." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopologyResource" + } + } + }, + "description": "Topology of the specified resource group." + }, + "TopologyResource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource." + }, + "id": { + "type": "string", + "description": "ID of the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "associations": { + "type": "array", + "description": "Holds the associations the resource has with other resources in the resource group.", + "items": { + "$ref": "#/definitions/TopologyAssociation" + } + } + }, + "description": "The network resource topology information for the given resource group." + }, + "TopologyAssociation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is associated with the parent resource." + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource that is associated with the parent resource." + }, + "associationType": { + "type": "string", + "enum": [ + "Associated", + "Contains" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + }, + "description": "The association type of the child resource to the parent resource." + } + }, + "description": "Resources that have an association with the parent resource." + }, + "VerificationIPFlowParameters": { + "description": "Parameters that define the IP flow to be verified.", + "required": [ + "targetResourceId", + "direction", + "protocol", + "localPort", + "remotePort", + "localIPAddress", + "remoteIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform next-hop on." + }, + "direction": { + "type": "string", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + }, + "description": "The direction of the packet represented as a 5-tuple." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "IpFlowProtocol", + "modelAsString": true + }, + "description": "Protocol to be verified on." + }, + "localPort": { + "type": "string", + "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "remotePort": { + "type": "string", + "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "localIPAddress": { + "type": "string", + "description": "The local IP address. Acceptable values are valid IPv4 addresses." + }, + "remoteIPAddress": { + "type": "string", + "description": "The remote IP address. Acceptable values are valid IPv4 addresses." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." + } + } + }, + "VerificationIPFlowResult": { + "description": "Results of IP flow verification on the target resource.", + "properties": { + "access": { + "type": "string", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + }, + "description": "Indicates whether the traffic is allowed or denied." + }, + "ruleName": { + "type": "string", + "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." + } + } + }, + "NextHopParameters": { + "description": "Parameters that define the source and destination endpoint.", + "required": [ + "targetResourceId", + "sourceIPAddress", + "destinationIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The resource identifier of the target resource against which the action is to be performed." + }, + "sourceIPAddress": { + "type": "string", + "description": "The source IP address." + }, + "destinationIPAddress": { + "type": "string", + "description": "The destination IP address." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." + } + } + }, + "NextHopResult": { + "description": "The information about next hop from the specified VM.", + "properties": { + "nextHopType": { + "type": "string", + "enum": [ + "Internet", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal", + "HyperNetGateway", + "None" + ], + "x-ms-enum": { + "name": "NextHopType", + "modelAsString": true + }, + "description": "Next hop type." + }, + "nextHopIpAddress": { + "type": "string", + "description": "Next hop IP Address" + }, + "routeTableId": { + "type": "string", + "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." + } + } + }, + "SecurityGroupViewParameters": { + "description": "Parameters that define the VM to check security groups for.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "ID of the target VM." + } + } + }, + "SecurityGroupViewResult": { + "description": "The information about security rules applied to the specified VM.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "List of network interfaces on the specified VM.", + "items": { + "$ref": "#/definitions/SecurityGroupNetworkInterface" + } + } + } + }, + "SecurityGroupNetworkInterface": { + "description": "Network interface and all its associated security rules.", + "properties": { + "id": { + "type": "string", + "description": "ID of the network interface." + }, + "securityRuleAssociations": { + "$ref": "#/definitions/SecurityRuleAssociations" + } + } + }, + "SecurityRuleAssociations": { + "description": "All security rules associated with the network interface.", + "properties": { + "networkInterfaceAssociation": { + "$ref": "#/definitions/NetworkInterfaceAssociation" + }, + "subnetAssociation": { + "$ref": "#/definitions/SubnetAssociation" + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + }, + "description": "Collection of default security rules of the network security group." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "Collection of effective security rules." + } + } + }, + "NetworkInterfaceAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Network interface ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "SubnetAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Subnet ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "PacketCapture": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureParameters" + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureParameters": { + "properties": { + "target": { + "type": "string", + "description": "The ID of the targeted resource, only VM is currently supported." + }, + "bytesToCapturePerPacket": { + "type": "integer", + "default": 0, + "description": "Number of bytes captured per packet, the remaining bytes are truncated." + }, + "totalBytesPerSession": { + "type": "integer", + "default": 1073741824, + "description": "Maximum size of the capture output." + }, + "timeLimitInSeconds": { + "type": "integer", + "default": 18000, + "description": "Maximum duration of the capture session in seconds." + }, + "storageLocation": { + "$ref": "#/definitions/PacketCaptureStorageLocation" + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureFilter" + } + } + }, + "required": [ + "target", + "storageLocation" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureStorageLocation": { + "properties": { + "storageId": { + "type": "string", + "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." + }, + "storagePath": { + "type": "string", + "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." + }, + "filePath": { + "type": "string", + "description": "A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + } + }, + "description": "Describes the storage location for a packet capture session." + }, + "PacketCaptureFilter": { + "properties": { + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "Any" + ], + "x-ms-enum": { + "name": "PcProtocol", + "modelAsString": true + }, + "default": "Any", + "description": "Protocol to be filtered on." + }, + "localIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remoteIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "localPort": { + "type": "string", + "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remotePort": { + "type": "string", + "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + } + }, + "description": "Filter that is applied to packet capture request. Multiple filters can be applied." + }, + "PacketCaptureListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureResult" + }, + "description": "Information about packet capture sessions." + } + }, + "description": "List of packet capture sessions." + }, + "PacketCaptureResult": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the packet capture session." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the packet capture operation." + }, + "etag": { + "type": "string", + "default": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureResultProperties" + } + }, + "description": "Information about packet capture session." + }, + "PacketCaptureResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the packet capture session." + } + }, + "allOf": [ + { + "$ref": "#/definitions/PacketCaptureParameters" + } + ], + "description": "Describes the properties of a packet capture session." + }, + "PacketCaptureQueryStatusResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the packet capture resource." + }, + "id": { + "type": "string", + "description": "The ID of the packet capture resource." + }, + "captureStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the packet capture session." + }, + "packetCaptureStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Stopped", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "PcStatus", + "modelAsString": true + }, + "description": "The status of the packet capture session." + }, + "stopReason": { + "type": "string", + "description": "The reason the current packet capture session was stopped." + }, + "packetCaptureError": { + "type": "array", + "description": "List of errors of packet capture session.", + "items": { + "type": "string", + "enum": [ + "InternalError", + "AgentStopped", + "CaptureFailed", + "LocalFileFailed", + "StorageFailed" + ], + "x-ms-enum": { + "name": "PcError", + "modelAsString": true + } + } + } + }, + "description": "Status of packet capture session." + }, + "TroubleshootingParameters": { + "description": "Parameters that define the resource to troubleshoot.", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The target resource to troubleshoot.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TroubleshootingProperties" + } + } + }, + "QueryTroubleshootingParameters": { + "description": "Parameters that define the resource to query the troubleshooting result.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource ID to query the troubleshooting result.", + "type": "string" + } + } + }, + "TroubleshootingProperties": { + "description": "Storage location provided for troubleshoot.", + "required": [ + "storageId", + "storagePath" + ], + "properties": { + "storageId": { + "description": "The ID for the storage account to save the troubleshoot result.", + "type": "string" + }, + "storagePath": { + "description": "The path to the blob to save the troubleshoot result in.", + "type": "string" + } + } + }, + "TroubleshootingResult": { + "description": "Troubleshooting information gained from specified resource.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the troubleshooting." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the troubleshooting." + }, + "code": { + "type": "string", + "description": "The result code of the troubleshooting." + }, + "results": { + "type": "array", + "description": "Information from troubleshooting.", + "items": { + "$ref": "#/definitions/TroubleshootingDetails" + } + } + } + }, + "TroubleshootingDetails": { + "description": "Information gained from troubleshooting of specified resource.", + "properties": { + "id": { + "type": "string", + "description": "The id of the get troubleshoot operation." + }, + "reasonType": { + "type": "string", + "description": "Reason type of failure." + }, + "summary": { + "type": "string", + "description": "A summary of troubleshooting." + }, + "detail": { + "type": "string", + "description": "Details on troubleshooting results." + }, + "recommendedActions": { + "type": "array", + "description": "List of recommended actions.", + "items": { + "$ref": "#/definitions/TroubleshootingRecommendedActions" + } + } + } + }, + "TroubleshootingRecommendedActions": { + "description": "Recommended actions based on discovered issues.", + "properties": { + "actionId": { + "description": "ID of the recommended action.", + "type": "string" + }, + "actionText": { + "description": "Description of recommended actions.", + "type": "string" + }, + "actionUri": { + "description": "The uri linking to a documentation for the recommended troubleshooting actions.", + "type": "string" + }, + "actionUriText": { + "description": "The information from the URI for the recommended troubleshooting actions.", + "type": "string" + } + } + }, + "FlowLogProperties": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "storageId", + "enabled" + ], + "properties": { + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters" + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters" + } + } + }, + "FlowLogStatusParameters": { + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource where getting the flow log and traffic analytics (optional) status.", + "type": "string" + } + } + }, + "RetentionPolicyParameters": { + "description": "Parameters that define the retention policy for flow log.", + "properties": { + "days": { + "description": "Number of days to retain flow log records.", + "type": "integer", + "default": 0 + }, + "enabled": { + "description": "Flag to enable/disable retention.", + "type": "boolean", + "default": false + } + } + }, + "FlowLogFormatParameters": { + "description": "Parameters that define the flow log format.", + "properties": { + "type": { + "type": "string", + "description": "The file type of flow log.", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "FlowLogFormatType", + "modelAsString": true + } + }, + "version": { + "description": "The version (revision) of the flow log.", + "type": "integer", + "default": 0 + } + } + }, + "FlowLogInformation": { + "description": "Information on the configuration of flow log and traffic analytics (optional) .", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogProperties" + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties" + } + } + }, + "TrafficAnalyticsProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "required": [ + "networkWatcherFlowAnalyticsConfiguration" + ], + "properties": { + "networkWatcherFlowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties" + } + } + }, + "TrafficAnalyticsConfigurationProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "required": [ + "enabled", + "workspaceId", + "workspaceRegion", + "workspaceResourceId" + ], + "properties": { + "enabled": { + "description": "Flag to enable/disable traffic analytics.", + "type": "boolean" + }, + "workspaceId": { + "description": "The resource guid of the attached workspace", + "type": "string" + }, + "workspaceRegion": { + "description": "The location of the attached workspace", + "type": "string" + }, + "workspaceResourceId": { + "description": "Resource Id of the attached workspace ", + "type": "string" + }, + "trafficAnalyticsInterval": { + "description": "The interval in minutes which would decide how frequently TA service should do flow analytics", + "type": "integer" + } + } + }, + "ConnectivityParameters": { + "description": "Parameters that determine how the connectivity check will be performed.", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "$ref": "#/definitions/ConnectivitySource" + }, + "destination": { + "$ref": "#/definitions/ConnectivityDestination" + }, + "protocol": { + "type": "string", + "description": "Network protocol.", + "enum": [ + "Tcp", + "Http", + "Https", + "Icmp" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "$ref": "#/definitions/ProtocolConfiguration" + } + } + }, + "ConnectivitySource": { + "description": "Parameters that define the source of the connection.", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "description": "The ID of the resource from which a connectivity check will be initiated.", + "type": "string" + }, + "port": { + "description": "The source port from which a connectivity check will be performed.", + "type": "integer" + } + } + }, + "ConnectivityDestination": { + "description": "Parameters that define destination of connection.", + "properties": { + "resourceId": { + "description": "The ID of the resource to which a connection attempt will be made.", + "type": "string" + }, + "address": { + "description": "The IP address or URI the resource to which a connection attempt will be made.", + "type": "string" + }, + "port": { + "description": "Port on which check connectivity will be performed.", + "type": "integer" + } + } + }, + "ConnectivityInformation": { + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "ProtocolConfiguration": { + "description": "Configuration of the protocol.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/HTTPConfiguration" + } + } + }, + "HTTPConfiguration": { + "properties": { + "method": { + "type": "string", + "description": "HTTP method.", + "enum": [ + "Get" + ], + "x-ms-enum": { + "name": "HTTPMethod", + "modelAsString": true + } + }, + "headers": { + "type": "array", + "description": "List of HTTP headers.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Valid status codes." + } + }, + "description": "HTTP configuration of the connectivity check." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The name in HTTP header." + }, + "value": { + "type": "string", + "description": "The value in HTTP header." + } + }, + "description": "Describes the HTTP header." + }, + "AzureReachabilityReportParameters": { + "properties": { + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation" + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Internet service providers." + }, + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional Azure regions to scope the query to." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the Azure reachability report." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the Azure reachability report." + } + }, + "required": [ + "providerLocation", + "startTime", + "endTime" + ], + "description": "Geographic and time constraints for Azure reachability report." + }, + "AzureReachabilityReportLocation": { + "properties": { + "country": { + "type": "string", + "description": "The name of the country." + }, + "state": { + "type": "string", + "description": "The name of the state." + }, + "city": { + "type": "string", + "description": "The name of the city or town." + } + }, + "required": [ + "country" + ], + "description": "Parameters that define a geographic location." + }, + "AzureReachabilityReport": { + "properties": { + "aggregationLevel": { + "type": "string", + "description": "The aggregation level of Azure reachability report. Can be Country, State or City." + }, + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation" + }, + "reachabilityReport": { + "type": "array", + "description": "List of Azure reachability report items.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportItem" + } + } + }, + "required": [ + "aggregationLevel", + "providerLocation", + "reachabilityReport" + ], + "description": "Azure reachability report details." + }, + "AzureReachabilityReportItem": { + "properties": { + "provider": { + "type": "string", + "description": "The Internet service provider." + }, + "azureLocation": { + "type": "string", + "description": "The Azure region." + }, + "latencies": { + "type": "array", + "description": "List of latency details for each of the time series.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" + } + } + }, + "description": "Azure reachability report details for a given provider location." + }, + "AzureReachabilityReportLatencyInfo": { + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The time stamp." + }, + "score": { + "type": "integer", + "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", + "minimum": 1, + "maximum": 100 + } + }, + "description": "Details on latency for a time series." + }, + "AvailableProvidersListParameters": { + "properties": { + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Azure regions." + }, + "country": { + "type": "string", + "description": "The country for available providers list." + }, + "state": { + "type": "string", + "description": "The state for available providers list." + }, + "city": { + "type": "string", + "description": "The city or town for available providers list." + } + }, + "description": "Constraints that determine the list of available Internet service providers." + }, + "AvailableProvidersList": { + "properties": { + "countries": { + "type": "array", + "description": "List of available countries.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCountry" + } + } + }, + "required": [ + "countries" + ], + "description": "List of available countries with details." + }, + "AvailableProvidersListCountry": { + "properties": { + "countryName": { + "type": "string", + "description": "The country name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "states": { + "type": "array", + "description": "List of available states in the country.", + "items": { + "$ref": "#/definitions/AvailableProvidersListState" + } + } + }, + "description": "Country details." + }, + "AvailableProvidersListState": { + "properties": { + "stateName": { + "type": "string", + "description": "The state name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "cities": { + "type": "array", + "description": "List of available cities or towns in the state.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCity" + } + } + }, + "description": "State details." + }, + "AvailableProvidersListCity": { + "properties": { + "cityName": { + "type": "string", + "description": "The city or town name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + } + }, + "description": "City or town details." + }, + "ConnectionMonitor": { + "properties": { + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorParameters" + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ConnectionMonitorSource" + }, + "destination": { + "$ref": "#/definitions/ConnectionMonitorDestination" + }, + "autoStart": { + "type": "boolean", + "default": true, + "description": "Determines if the connection monitor will start automatically once created." + }, + "monitoringIntervalInSeconds": { + "type": "integer", + "default": 60, + "description": "Monitoring interval in seconds." + } + }, + "required": [ + "source", + "destination" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorSource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the source by connection monitor." + }, + "port": { + "type": "integer", + "description": "The source port used by connection monitor." + } + }, + "required": [ + "resourceId" + ], + "description": "Describes the source of connection monitor." + }, + "ConnectionMonitorDestination": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the destination by connection monitor." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor destination (IP or domain name)." + }, + "port": { + "type": "integer", + "description": "The destination port used by connection monitor." + } + }, + "description": "Describes the destination of connection monitor." + }, + "ConnectionMonitorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorResult" + }, + "description": "Information about connection monitors." + } + }, + "description": "List of connection monitors." + }, + "ConnectionMonitorResult": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the connection monitor." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the connection monitor." + }, + "etag": { + "type": "string", + "default": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Connection monitor type." + }, + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorResultProperties" + } + }, + "description": "Information about the connection monitor." + }, + "ConnectionMonitorResultProperties": { + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "The provisioning state of the connection monitor." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The date and time when the connection monitor was started." + }, + "monitoringStatus": { + "type": "string", + "description": "The monitoring status of the connection monitor." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionMonitorParameters" + } + ], + "description": "Describes the properties of a connection monitor." + }, + "ConnectionMonitorQueryResult": { + "properties": { + "sourceStatus": { + "type": "string", + "enum": [ + "Uknown", + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ConnectionMonitorSourceStatus", + "modelAsString": true + }, + "description": "Status of connection monitor source." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionStateSnapshot" + }, + "description": "Information about connection states." + } + }, + "description": "List of connection states snaphots." + }, + "ConnectionStateSnapshot": { + "properties": { + "connectionState": { + "type": "string", + "enum": [ + "Reachable", + "Unreachable", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + }, + "description": "The connection state." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the connection snapshot." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the connection snapshot." + }, + "evaluationState": { + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "EvaluationState", + "modelAsString": true + }, + "description": "Connectivity analysis evaluation state." + }, + "avgLatencyInMs": { + "type": "integer", + "description": "Average latency in ms." + }, + "minLatencyInMs": { + "type": "integer", + "description": "Minimum latency in ms." + }, + "maxLatencyInMs": { + "type": "integer", + "description": "Maximum latency in ms." + }, + "probesSent": { + "type": "integer", + "description": "The number of sent probes." + }, + "probesFailed": { + "type": "integer", + "description": "The number of failed probes." + }, + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + } + }, + "description": "Connection state snapshot." + }, + "NetworkConfigurationDiagnosticParameters": { + "description": "Parameters to get network configuration diagnostic.", + "required": [ + "targetResourceId", + "profiles" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." + }, + "verbosityLevel": { + "type": "string", + "enum": [ + "Normal", + "Minimum", + "Full" + ], + "x-ms-enum": { + "name": "VerbosityLevel", + "modelAsString": true + }, + "description": "Verbosity level. Accepted values are 'Normal', 'Minimum', 'Full'." + }, + "profiles": { + "type": "array", + "description": "List of network configuration diagnostic profiles.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + } + } + } + }, + "NetworkConfigurationDiagnosticProfile": { + "description": "Parameters to compare with network configuration.", + "required": [ + "direction", + "protocol", + "source", + "destination", + "destinationPort" + ], + "properties": { + "direction": { + "type": "string", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + }, + "description": "The direction of the traffic. Accepted values are 'Inbound' and 'Outbound'." + }, + "protocol": { + "type": "string", + "description": "Protocol to be verified on. Accepted values are '*', TCP, UDP." + }, + "source": { + "type": "string", + "description": "Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag." + }, + "destination": { + "type": "string", + "description": "Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag." + }, + "destinationPort": { + "type": "string", + "description": "Traffice destination port. Accepted values are '*', port (for example, 3389) and port range (for example, 80-100)." + } + } + }, + "NetworkConfigurationDiagnosticResponse": { + "description": "Results of network configuration diagnostic on the target resource.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "description": "List of network configuration diagnostic results.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResult" + } + } + } + }, + "NetworkConfigurationDiagnosticResult": { + "description": "Network configuration diagnostic result corresponded to provided traffic query.", + "properties": { + "profile": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + }, + "networkSecurityGroupResult": { + "$ref": "#/definitions/NetworkSecurityGroupResult" + } + } + }, + "NetworkSecurityGroupResult": { + "description": "Network configuration diagnostic result corresponded provided traffic query.", + "properties": { + "securityRuleAccessResult": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "evaluatedNetworkSecurityGroups": { + "readOnly": true, + "type": "array", + "description": "List of results network security groups diagnostic.", + "items": { + "$ref": "#/definitions/EvaluatedNetworkSecurityGroup" + } + } + } + }, + "EvaluatedNetworkSecurityGroup": { + "description": "Results of network security group evaluation.", + "properties": { + "networkSecurityGroupId": { + "type": "string", + "description": "Network security group ID." + }, + "appliedTo": { + "type": "string", + "description": "Resource ID of nic or subnet to which network security group is applied." + }, + "matchedRule": { + "$ref": "#/definitions/MatchedRule" + }, + "rulesEvaluationResult": { + "readOnly": true, + "type": "array", + "description": "List of network security rules evaluation results.", + "items": { + "$ref": "#/definitions/NetworkSecurityRulesEvaluationResult" + } + } + } + }, + "MatchedRule": { + "description": "Matched rule.", + "properties": { + "ruleName": { + "type": "string", + "description": "Name of the matched network security rule." + }, + "action": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." + } + } + }, + "NetworkSecurityRulesEvaluationResult": { + "description": "Network security rules evaluation result.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network security rule." + }, + "protocolMatched": { + "type": "boolean", + "description": "Value indicating whether protocol is matched." + }, + "sourceMatched": { + "type": "boolean", + "description": "Value indicating whether source is matched." + }, + "sourcePortMatched": { + "type": "boolean", + "description": "Value indicating whether source port is matched." + }, + "destinationMatched": { + "type": "boolean", + "description": "Value indicating whether destination is matched." + }, + "destinationPortMatched": { + "type": "boolean", + "description": "Value indicating whether destination port is matched." + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/operation.json new file mode 100644 index 000000000000..19a292f2185a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/operation.json @@ -0,0 +1,263 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { "$ref": "./examples/OperationList.json" } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpAddress.json new file mode 100644 index 000000000000..25065542d42a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpAddress.json @@ -0,0 +1,469 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}": { + "delete": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Delete", + "description": "Deletes the specified public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete public IP address": { "$ref": "./examples/PublicIpAddressDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Get", + "description": "Gets the specified public IP address in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Get public IP address": { "$ref": "./examples/PublicIpAddressGet.json" } + } + }, + "put": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "Parameters supplied to the create or update public IP address operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Create public IP address defaults": { "$ref": "./examples/PublicIpAddressCreateDefaults.json" }, + "Create public IP address allocation method": { "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" }, + "Create public IP address DNS": { "$ref": "./examples/PublicIpAddressCreateDns.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_UpdateTags", + "description": "Updates public IP address tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP address tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { "$ref": "./examples/PublicIpAddressUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ListAll", + "description": "Gets all the public IP addresses in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "List all public IP addresses": { "$ref": "./examples/PublicIpAddressListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_List", + "description": "Gets all public IP addresses in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "List resource group public IP addresses": { "$ref": "./examples/PublicIpAddressList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP address SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP address" + }, + "PublicIPAddressPropertiesFormat": { + "properties": { + "publicIPAllocationMethod": { + "type": "string", + "description": "The public IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "publicIPAddressVersion": { + "type": "string", + "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "ipConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/IPConfiguration", + "description": "The IP configuration associated with the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/PublicIPAddressDnsSettings", + "description": "The FQDN of the DNS record associated with the public IP address." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address associated with the public IP address resource." + }, + "publicIPPrefix": { + "$ref":"./network.json#/definitions/SubResource", + "description": "The Public IP Prefix this Public IP Address should be allocated from." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the public IP resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Public IP address properties." + }, + "PublicIPAddress": { + "properties": { + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "The public IP address SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPAddressPropertiesFormat", + "description": "Public IP address properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP address resource." + }, + "PublicIPAddressListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "A list of public IP addresses that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpAddresses API service call." + }, + "PublicIPAddressDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." + }, + "fqdn": { + "type": "string", + "description": "Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." + }, + "reverseFqdn": { + "type": "string", + "description": "Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. " + } + }, + "description": "Contains FQDN of the DNS record associated with the public IP address" + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "Gets or sets the ipTag type: Example FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc" + } + }, + "description": "Contains the IpTag associated with the object" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json new file mode 100644 index 000000000000..89700bd2fc1c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/publicIpPrefix.json @@ -0,0 +1,440 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}": { + "delete": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Delete", + "description": "Deletes the specified public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete public IP prefix": { "$ref": "./examples/PublicIpPrefixDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Get", + "description": "Gets the specified public IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIPPrefx." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + } + }, + "x-ms-examples": { + "Get public IP prefix": { "$ref": "./examples/PublicIpPrefixGet.json" } + } + }, + "put": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "Parameters supplied to the create or update public IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + } + }, + "x-ms-examples": { + "Create public IP prefix defaults": { "$ref": "./examples/PublicIpPrefixCreateDefaults.json" }, + "Create public IP prefix allocation method": { "$ref": "./examples/PublicIpPrefixCreateCustomizedValues.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_UpdateTags", + "description": "Updates public IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + } + }, + "x-ms-examples": { + "Update public IP prefix tags": { "$ref": "./examples/PublicIpPrefixUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_ListAll", + "description": "Gets all the public IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + } + }, + "x-ms-examples": { + "List all public IP prefixes": { "$ref": "./examples/PublicIpPrefixListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_List", + "description": "Gets all public IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + } + }, + "x-ms-examples": { + "List resource group public IP prefixes": { "$ref": "./examples/PublicIpPrefixList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPPrefixSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP prefix SKU.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP prefix" + }, + "PublicIPPrefixPropertiesFormat": { + "properties": { + "publicIPAddressVersion": { + "type": "string", + "description": "The public IP address version. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP prefix." + }, + "prefixLength": { + "type": "integer", + "format":"int32", + "description": "The Length of the Public IP Prefix." + }, + "ipPrefix" : { + "type":"string", + "description": "The allocated Prefix" + }, + "publicIPAddresses": { + "type":"array", + "items":{ + "$ref": "#/definitions/ReferencedPublicIpAddress" + }, + "description":"The list of all referenced PublicIPAddresses" + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the public IP prefix resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the Public IP prefix resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Public IP prefix properties." + }, + "PublicIPPrefix": { + "properties": { + "sku": { + "$ref": "#/definitions/PublicIPPrefixSku", + "description": "The public IP prefix SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPPrefixPropertiesFormat", + "description": "Public IP prefix properties." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP prefix resource." + }, + "PublicIPPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "A list of public IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpPrefixes API service call." + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "Gets or sets the ipTag type: Example FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "Gets or sets value of the IpTag associated with the public IP. Example SQL, Storage etc" + } + }, + "description": "Contains the IpTag associated with the object" + }, + "ReferencedPublicIpAddress":{ + "properties":{ + "id":{ + "type":"string", + "description":"The PublicIPAddress Reference" + } + } + } + } +} \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeFilter.json new file mode 100644 index 000000000000..12833a5d26c9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeFilter.json @@ -0,0 +1,783 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}": { + "delete": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Delete", + "x-ms-examples": { + "RouteFilterDelete": { "$ref": "./examples/RouteFilterDelete.json" } + }, + "description": "Deletes the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Get", + "x-ms-examples": { + "RouteFilterGet": { "$ref": "./examples/RouteFilterGet.json" } + }, + "description": "Gets the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced express route bgp peering resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + } + }, + "put": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterCreate": { "$ref": "./examples/RouteFilterCreate.json" } + }, + "description": "Creates or updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Parameters supplied to the create or update route filter operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Update", + "x-ms-examples": { + "RouteFilterUpdate": { "$ref": "./examples/RouteFilterUpdate.json" } + }, + "description": "Updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRouteFilter" + }, + "description": "Parameters supplied to the update route filter operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_ListByResourceGroup", + "x-ms-examples": { + "RouteFilterListByResourceGroup": { "$ref": "./examples/RouteFilterListByResourceGroup.json" } + }, + "description": "Gets all route filters in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_List", + "x-ms-examples": { + "RouteFilterList": { "$ref": "./examples/RouteFilterList.json" } + }, + "description": "Gets all route filters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { + "delete": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Delete", + "x-ms-examples": { + "RouteFilterRuleDelete": { "$ref": "./examples/RouteFilterRuleDelete.json" } + }, + "description": "Deletes the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Rule was deleted or not found." + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Get", + "x-ms-examples": { + "RouteFilterRuleGet": { "$ref": "./examples/RouteFilterRuleGet.json" } + }, + "description": "Gets the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + } + }, + "put": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterRuleCreate": { "$ref": "./examples/RouteFilterRuleCreate.json" } + }, + "description": "Creates or updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Parameters supplied to the create or update route filter rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Update", + "x-ms-examples": { + "RouteFilterRuleUpdate": { "$ref": "./examples/RouteFilterRuleUpdate.json" } + }, + "description": "Updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PatchRouteFilterRule" + }, + "description": "Parameters supplied to the update route filter rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_ListByRouteFilter", + "x-ms-examples": { + "RouteFilterRuleListByRouteFilter": { "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" } + }, + "description": "Gets all RouteFilterRules in a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter Rule resources.", + "schema": { + "$ref": "#/definitions/RouteFilterRuleListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "RouteFilterRulePropertiesFormat": { + "required": [ + "access", + "routeFilterRuleType", + "communities" + ], + "properties": { + "access": { + "type": "string", + "description": "The access type of the rule. Valid values are: 'Allow', 'Deny'", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + } + }, + "routeFilterRuleType": { + "type": "string", + "description": "The rule type of the rule. Valid value is: 'Community'", + "enum": [ + "Community" + ], + "x-ms-enum": { + "name": "RouteFilterRuleType", + "modelAsString": true + } + }, + "communities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'." + } + }, + "description": "Route Filter Rule Resource" + }, + "RouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource" + }, + "PatchRouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource" + }, + "RouteFilterPropertiesFormat": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Collection of RouteFilterRules contained within a route filter." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit peerings." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', 'Succeeded' and 'Failed'." + } + }, + "description": "Route Filter Resource" + }, + "RouteFilter": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route Filter Resource." + }, + "PatchRouteFilter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Resource." + }, + "RouteFilterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Gets a list of route filters in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilters API service call." + }, + "RouteFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Gets a list of RouteFilterRules in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilterRules API service call" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeTable.json new file mode 100644 index 000000000000..f0cc0b56325b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/routeTable.json @@ -0,0 +1,654 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": { + "delete": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Delete", + "description": "Deletes the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Request successful. Operation to delete was accepted." + }, + "202": { + "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete route table": { "$ref": "./examples/RouteTableDelete.json" } + } + }, + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Get", + "description": "Gets the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Get route table": { "$ref": "./examples/RouteTableGet.json" } + } + }, + "put": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_CreateOrUpdate", + "description": "Create or updates a route table in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Parameters supplied to the create or update route table operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Create route table": { "$ref": "./examples/RouteTableCreate.json" }, + "Create route table with route": { "$ref": "./examples/RouteTableCreateWithRoute.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_UpdateTags", + "description": "Updates a route table tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route table tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + } + }, + "x-ms-examples": { + "Update route table tags": { "$ref": "./examples/RouteTableUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_List", + "description": "Gets all route tables in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + } + }, + "x-ms-examples": { + "List route tables in resource group": { "$ref": "./examples/RouteTableList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_ListAll", + "description": "Gets all route tables in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + } + }, + "x-ms-examples": { + "List all route tables": { "$ref": "./examples/RouteTableListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { + "delete": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Delete", + "description": "Deletes the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Route was deleted or not found." + } + }, + "x-ms-examples": { + "Delete route": { "$ref": "./examples/RouteTableRouteDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Get", + "description": "Gets the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + } + }, + "x-ms-examples": { + "Get route": { "$ref": "./examples/RouteTableRouteGet.json" } + } + }, + "put": { + "tags": [ + "Routes" + ], + "operationId": "Routes_CreateOrUpdate", + "description": "Creates or updates a route in the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "name": "routeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + }, + "description": "Parameters supplied to the create or update route operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + } + }, + "x-ms-examples": { + "Create route": { "$ref": "./examples/RouteTableRouteCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_List", + "description": "Gets all routes in a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route resources.", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routes": { "$ref": "./examples/RouteTableRouteList.json" } + } + } + } + }, + "definitions": { + "RoutePropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to. Possible values are: 'VirtualNetworkGateway', 'VnetLocal', 'Internet', 'VirtualAppliance', and 'None'", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "nextHopType" + ], + "description": "Route resource" + }, + "Route": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutePropertiesFormat", + "description": "Properties of the route." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route resource" + }, + "RouteTablePropertiesFormat": { + "properties": { + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Collection of routes contained within a route table." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "Gets or sets whether to disable the routes learned by BGP on that route table. True means disable." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Route Table resource" + }, + "RouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteTablePropertiesFormat", + "description": "Properties of the route table." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route table resource." + }, + "RouteTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Gets a list of route tables in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteTable API service call." + }, + "RouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Gets a list of routes in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRoute API service call" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceCommunity.json new file mode 100644 index 000000000000..44294c85891a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceCommunity.json @@ -0,0 +1,149 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities": { + "get": { + "tags": [ + "BgpServiceCommunities" + ], + "operationId": "BgpServiceCommunities_List", + "x-ms-examples": { + "ServiceCommunityList": { "$ref": "./examples/ServiceCommunityList.json" } + }, + "description": "Gets all the available bgp service communities.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of BgpServiceCommunity resources.", + "schema": { + "$ref": "#/definitions/BgpServiceCommunityListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BGPCommunity": { + "properties": { + "serviceSupportedRegion": { + "type": "string", + "description": "The region which the service support. e.g. For O365, region is Global." + }, + "communityName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "communityValue": { + "type": "string", + "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." + }, + "communityPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The prefixes that the bgp community contains." + }, + "isAuthorizedToUse": { + "type": "boolean", + "description": "Customer is authorized to use bgp community or not." + }, + "serviceGroup": { + "type": "string", + "description": "The service group of the bgp community contains." + } + }, + "description": "Contains bgp community information offered in Service Community resources." + }, + "BgpServiceCommunityPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "bgpCommunities": { + "type": "array", + "items": { + "$ref": "#/definitions/BGPCommunity" + }, + "description": "Get a list of bgp communities." + } + }, + "description": "Properties of Service Community." + }, + "BgpServiceCommunity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service Community Properties." + }, + "BgpServiceCommunityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpServiceCommunity" + }, + "description": "A list of service community resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListServiceCommunity API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json new file mode 100644 index 000000000000..6a49211e0458 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json @@ -0,0 +1,647 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Delete", + "description": "Deletes the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-examples": { + "Delete service endpoint Policys": { "$ref": "./examples/ServiceEndpointPolicyDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Get", + "description": "Gets the specified service Endpoint Policies in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + } + }, + "x-ms-examples": { + "Get service endPoint Policy": { "$ref": "./examples/ServiceEndpointPolicyGet.json" } + } + }, + "put": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_CreateOrUpdate", + "description": "Creates or updates a service Endpoint Policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyCreate.json" }, + "Create service endpoint policy with definition": { "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Update", + "description": "Updates service Endpoint Policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update service endpoint policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + } + }, + "x-ms-examples": { + "Update service endpoint policy tags": { "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_List", + "description": "Gets all the service endpoint policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + } + }, + "x-ms-examples": { + "List all service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": { + "get": { + "tags": [ + "serviceEndpointPolicies" + ], + "operationId": "serviceEndpointPolicies_ListByResourceGroup", + "description": "Gets all service endpoint Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + } + }, + "x-ms-examples": { + "List resource group service endpoint policies": { "$ref": "./examples/ServiceEndpointPolicyList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Delete", + "description": "Deletes the specified ServiceEndpoint policy definitions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Service Endpoint Policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "Delete service endpoint policy definitions from service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Get", + "description": "Get the specified service endpoint policy definitions from service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + } + }, + "x-ms-examples": { + "Get service endpoint definition in service endpoint policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" } + } + }, + "put": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", + "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "name": "ServiceEndpointPolicyDefinitions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy definition": { "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { + "get": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", + "description": "Gets all service endpoint policy definitions in a service end point policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" + } + } + }, + "x-ms-examples": { + "List service endpoint definitions in service end point policy": { "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceEndpointPolicyDefinitionPropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "service": { + "type": "string", + "description": "service endpoint name." + }, + "serviceResources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of service resources." + }, + "provisioningState": { + "readOnly" : true, + "type": "string", + "description": "The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Service Endpoint policy definition resource." + }, + "ServiceEndpointPolicyDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat", + "description": "Properties of the service endpoint policy definition" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Service Endpoint policy definitions." + }, + "ServiceEndpointPolicyDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "The service endpoint policy definition in a service endpoint policy." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy." + }, + "ServiceEndpointPolicyPropertiesFormat": { + "properties": { + "serviceEndpointPolicyDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "A collection of service endpoint policy definitions of the service endpoint policy." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the service endpoint policy resource." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Service Endpoint Policy resource." + }, + "ServiceEndpointPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat", + "description": "Properties of the service end point policy" + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service End point policy resource." + }, + "ServiceEndpointPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "A list of ServiceEndpointPolicy resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicies API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/usage.json new file mode 100644 index 000000000000..9c310d499b70 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/usage.json @@ -0,0 +1,150 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "List network usages for a subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location where resource usage is queried.", + "pattern": "^[-\\w\\._ ]+$" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Usage resources.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + }, + "x-ms-examples": { + "List usages": { "$ref": "./examples/UsageList.json" }, + "List usages spaced location": { "$ref": "./examples/UsageListSpacedLocation.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes network resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list network resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetwork.json new file mode 100644 index 000000000000..b6d40c1c3ef9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetwork.json @@ -0,0 +1,1381 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}": { + "delete": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Delete", + "description": "Deletes the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete virtual network": { "$ref": "./examples/VirtualNetworkDelete.json" } + } + }, + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Get", + "description": "Gets the specified virtual network by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-examples": { + "Get virtual network": { "$ref": "./examples/VirtualNetworkGet.json" }, + "Get virtual network with a delegated subnet": { "$ref": "./examples/VirtualNetworkGetWithSubnetDelegation.json" }, + "Get virtual network with service association links": { "$ref": "./examples/VirtualNetworkGetWithServiceAssociationLink.json" } + } + }, + "put": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_CreateOrUpdate", + "description": "Creates or updates a virtual network in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Parameters supplied to the create or update virtual network operation" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create virtual network": { "$ref": "./examples/VirtualNetworkCreate.json" }, + "Create virtual network with subnet": { "$ref": "./examples/VirtualNetworkCreateSubnet.json" }, + "Create virtual network with subnet containing address prefixes": { "$ref": "./examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json" }, + "Create virtual network with service endpoints": { "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" }, + "Create virtual network with delegated subnets": { "$ref": "./examples/VirtualNetworkCreateSubnetWithDelegation.json" } + } + }, + "patch": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_UpdateTags", + "description": "Updates a virtual network tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update virtual network tags": { "$ref": "./examples/VirtualNetworkUpdateTags.json" } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_ListAll", + "description": "Gets all virtual networks in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + } + }, + "x-ms-examples": { + "List all virtual networks": { "$ref": "./examples/VirtualNetworkListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_List", + "description": "Gets all virtual networks in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + } + }, + "x-ms-examples": { + "List virtual networks in resource group": { "$ref": "./examples/VirtualNetworkList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { + "delete": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Delete", + "description": "Deletes the specified subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete subnet": { "$ref": "./examples/SubnetDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Get", + "description": "Gets the specified subnet by virtual network and resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + } + }, + "x-ms-examples": { + "Get subnet": { "$ref": "./examples/SubnetGet.json" }, + "Get subnet with a delegation": { "$ref": "./examples/SubnetGetWithDelegation.json" } + } + }, + "put": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_CreateOrUpdate", + "description": "Creates or updates a subnet in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "subnetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Subnet" + }, + "description": "Parameters supplied to the create or update subnet operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create subnet": { "$ref": "./examples/SubnetCreate.json" }, + "Create subnet with service endpoints": { "$ref": "./examples/SubnetCreateServiceEndpoint.json" }, + "Create subnet with a delegation": { "$ref": "./examples/SubnetCreateWithDelegation.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_List", + "description": "Gets all subnets in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Subnet resources.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List subnets": { "$ref": "./examples/SubnetList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { + "delete": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Delete", + "description": "Deletes the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "Delete peering": { "$ref": "./examples/VirtualNetworkPeeringDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Get", + "description": "Gets the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + } + }, + "x-ms-examples": { + "Get peering": { "$ref": "./examples/VirtualNetworkPeeringGet.json" } + } + }, + "put": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create or update virtual network peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + } + }, + "x-ms-examples": { + "Create peering": { "$ref": "./examples/VirtualNetworkPeeringCreate.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_List", + "description": "Gets all virtual network peerings in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List peerings": { "$ref": "./examples/VirtualNetworkPeeringList.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { + "get": { + "operationId": "VirtualNetworks_CheckIPAddressAvailability", + "description": "Checks whether a private IP address is available for use.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "ipAddress", + "in": "query", + "required": true, + "type": "string", + "description": "The private IP address to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private IP address availability and list of other free addresses if the requested one is not available.", + "schema": { + "$ref": "#/definitions/IPAddressAvailabilityResult" + } + } + }, + "x-ms-examples": { + "Check IP address availability": { "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { + "get": { + "operationId": "VirtualNetworks_ListUsage", + "description": "Lists usage stats.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Usage stats for vnet.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListUsageResult" + } + } + }, + "x-ms-examples": { + "VnetGetUsage": { "$ref": "./examples/VirtualNetworkListUsage.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceAssociationLinkPropertiesFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the ServiceAssociationLink resource." + } + }, + "description": "Properties of ServiceAssociationLink." + }, + "ServiceAssociationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceAssociationLinkPropertiesFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ServiceAssociationLink resource." + }, + "ResourceNavigationLinkFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the ResourceNavigationLink resource." + } + }, + "description": "Properties of ResourceNavigationLink." + }, + "ResourceNavigationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceNavigationLinkFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ResourceNavigationLink resource." + }, + "ServiceDelegationPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)" + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Describes the actions permitted to the service upon delegation" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of a service delegation." + }, + "Delegation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceDelegationPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a subnet. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Details the service to which the subnet is delegated." + }, + "SubnetPropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of address prefixes for the subnet." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference of the NetworkSecurityGroup resource." + }, + "routeTable": { + "$ref": "./routeTable.json#/definitions/RouteTable", + "description": "The reference of the RouteTable resource." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPropertiesFormat" + }, + "description": "An array of service endpoints." + }, + "serviceEndpointPolicies": { + "type": "array", + "items": { + "$ref": "./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy" + }, + "description": "An array of service endpoint policies." + }, + "interfaceEndpoints": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./interfaceEndpoint.json#/definitions/InterfaceEndpoint" + }, + "description": "An array of references to interface endpoints " + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/IPConfiguration" + }, + "description": "Gets an array of references to the network interface IP configurations using subnet." + }, + "ipConfigurationProfiles": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkProfile.json#/definitions/IPConfigurationProfile" + }, + "description": "Array of IP configuration profiles which reference this subnet." + }, + "resourceNavigationLinks": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "Gets an array of references to the external resources using subnet." + }, + "serviceAssociationLinks": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "Gets an array of references to services injecting into this subnet." + }, + "delegations": { + "type": "array", + "items": { + "$ref": "#/definitions/Delegation" + }, + "description": "Gets an array of references to the delegations on the subnet." + }, + "purpose": { + "type": "string", + "readOnly": true, + "description": "A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of the subnet." + }, + "ServiceEndpointPropertiesFormat": { + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "The service endpoint properties." + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the linked virtual network space would be able to access all the VMs in local Virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the remote virtual network will be allowed/disallowed." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference of the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering. Possible values are 'Initiated', 'Connected', and 'Disconnected'.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringState", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource." + } + }, + "description": "Properties of the virtual network peering." + }, + "Subnet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubnetPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Subnet in a virtual network resource." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "Properties of the virtual network peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peerings in a virtual network resource." + }, + "SubnetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "The subnets in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network" + }, + "VirtualNetworkPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "The peerings in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." + }, + "VirtualNetworkPropertiesFormat": { + "properties": { + "addressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." + }, + "dhcpOptions": { + "$ref": "#/definitions/DhcpOptions", + "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "A list of subnets in a Virtual Network." + }, + "virtualNetworkPeerings": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "A list of peerings in a Virtual Network." + }, + "resourceGuid": { + "type": "string", + "description": "The resourceGuid property of the Virtual Network resource." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "enableDdosProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." + }, + "enableVmProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." + }, + "ddosProtectionPlan": { + "$ref": "./network.json#/definitions/SubResource", + "default": null, + "description": "The DDoS protection plan associated with the virtual network." + } + }, + "description": "Properties of the virtual network." + }, + "VirtualNetwork": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPropertiesFormat", + "description": "Properties of the virtual network." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network resource." + }, + "VirtualNetworkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Gets a list of VirtualNetwork resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworks API service call." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + }, + "DhcpOptions": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of DNS servers IP addresses." + } + }, + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." + }, + "IPAddressAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Private IP address availability." + }, + "availableIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Contains other available private IP addresses if the asked for address is taken." + } + }, + "description": "Response for CheckIPAddressAvailability API service call" + }, + "VirtualNetworkListUsageResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VirtualNetworkUsage" + }, + "description": "VirtualNetwork usage stats." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the virtual networks GetUsage API service call." + }, + "VirtualNetworkUsage": { + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates number of IPs used from the Subnet." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Subnet identifier." + }, + "limit": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates the size of the subnet." + }, + "name": { + "$ref": "#/definitions/VirtualNetworkUsageName", + "readOnly": true, + "description": "The name containing common and localized value for usage." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Usage units. Returns 'Count'" + } + }, + "description": "Usage details for subnet." + }, + "VirtualNetworkUsageName": { + "properties": { + "localizedValue": { + "type": "string", + "readOnly": true, + "description": "Localized subnet size and usage string." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Subnet size and usage string." + } + }, + "description": "Usage strings container." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json new file mode 100644 index 000000000000..924e019d8969 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json @@ -0,0 +1,2817 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { + "put": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Parameters supplied to create or update virtual network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayUpdate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Get", + "description": "Gets the specified virtual network gateway by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayGet.json" } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Delete", + "description": "Deletes the specified virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_UpdateTags", + "description": "Updates a virtual network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayTags": { "$ref": "./examples/VirtualNetworkGatewayUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_List", + "description": "Gets all virtual network gateways by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListResult" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaysinResourceGroup": { "$ref": "./examples/VirtualNetworkGatewayList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListConnections", + "description": "Gets all the connections in a virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListConnectionsResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualNetworkGatewaysListConnections": { "$ref": "./examples/VirtualNetworkGatewaysListConnections.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Reset", + "description": "Resets the primary of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "gatewayVip", + "in": "query", + "required": false, + "type": "string", + "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation reset the primary of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGateway": { "$ref": "./examples/VirtualNetworkGatewayReset.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ResetVpnClientSharedKey", + "description": "Resets the VPN client shared key of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the vpn client shared key of the virtual network gateway." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously" + } + }, + "x-ms-examples": { + "ResetVpnClientSharedKey": { "$ref": "./examples/VirtualNetworkGatewayResetVpnClientSharedKey.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", + "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN client package URL.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "GenerateVPNClientPackage": { "$ref": "./examples/VirtualNetworkGatewayGenerateVpnClientPackage.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GenerateVirtualNetworkGatewayVPNProfile": { "$ref": "./examples/VirtualNetworkGatewayGenerateVpnProfile.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnProfilePackageUrl", + "description": "Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVPNProfilePackageURL": { "$ref": "./examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetBgpPeerStatus", + "description": "The GetBgpPeerStatus operation retrieves the status of all BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": false, + "type": "string", + "description": "The IP address of the peer to retrieve the status of." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of BGP peer statuses", + "schema": { + "$ref": "#/definitions/BgpPeerStatusListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayBGPPeerStatus": { "$ref": "./examples/VirtualNetworkGatewayGetBGPPeerStatus.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SupportedVpnDevices", + "description": "Gets a xml format representation for supported vpn devices.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for supported vpn devices.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaySupportedVPNDevices": { "$ref": "./examples/VirtualNetworkGatewaySupportedVpnDevice.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetLearnedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayLearnedRoutes": { "$ref": "./examples/VirtualNetworkGatewayLearnedRoutes.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetAdvertisedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": true, + "type": "string", + "description": "The IP address of the peer" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayAdvertisedRoutes": { "$ref": "./examples/VirtualNetworkGatewayGetAdvertisedRoutes.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SetVpnclientIpsecParameters", + "description": "The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "vpnclientIpsecParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + }, + "description": "Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation sets the specificed vpnclient ipsec parameters for P2S client of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Set VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientIpsecParameters", + "description": "The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Get VirtualNetworkGateway VpnClientIpsecParameters": { "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" } + } + + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_VpnDeviceConfigurationScript", + "description": "Gets a xml format representation for vpn device configuration script.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection for which the configuration script is generated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnDeviceScriptParameters" + }, + "description": "Parameters supplied to the generate vpn device script operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for vpn device configuration script.", + "schema": { + "type": "string" + } + } + }, + "x-ms-examples": { + "GetVPNDeviceConfigurationScript": { "$ref": "./examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Parameters supplied to the create or update virtual network gateway connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "CreateVirtualNetworkGatewayConnection_S2S": { "$ref": "./examples/VirtualNetworkGatewayConnectionCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Get", + "description": "Gets the specified virtual network gateway connection by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnection": { "$ref": "./examples/VirtualNetworkGatewayConnectionGet.json" } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Delete", + "description": "Deletes the specified virtual network Gateway connection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGatewayConnection": { "$ref": "./examples/VirtualNetworkGatewayConnectionDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_UpdateTags", + "description": "Updates a virtual network gateway connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayConnectionTags": { "$ref": "./examples/VirtualNetworkGatewayConnectionUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", + "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + }, + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + } + }, + "x-ms-examples": { + "SetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionSetSharedKey.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", + "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection shared key name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionGetSharedKey.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_List", + "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation resets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewayConnectionsinResourceGroup": { "$ref": "./examples/VirtualNetworkGatewayConnectionsList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", + "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection reset shared key Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + }, + "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + } + }, + "202": { + "description": "" + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnectionSharedKey": { "$ref": "./examples/VirtualNetworkGatewayConnectionResetSharedKey.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { + "put": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a local network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "Parameters supplied to the create or update local network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "CreateLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Get", + "description": "Gets the specified local network gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "GetLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayGet.json" } + } + }, + "delete": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Delete", + "description": "Deletes the specified local network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "DeleteLocalNetworkGateway": { "$ref": "./examples/LocalNetworkGatewayDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_UpdateTags", + "description": "Updates a local network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update local network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + } + }, + "x-ms-examples": { + "UpdateLocalNetworkGatewayTags": { "$ref": "./examples/LocalNetworkGatewayUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_List", + "description": "Gets all the local network gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/LocalNetworkGatewayListResult" + } + } + }, + "x-ms-examples": { + "ListLocalNetworkGateways": { "$ref": "./examples/LocalNetworkGatewayList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAllocationMethod": { + "type": "string", + "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of VirtualNetworkGatewayIPConfiguration" + }, + "VirtualNetworkGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the virtual network gateway ip configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration for virtual network gateway" + }, + "VirtualNetworkGatewayPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" + }, + "description": "IP configurations for virtual network gateway." + }, + "gatewayType": { + "type": "string", + "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.", + "enum": [ + "Vpn", + "ExpressRoute" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayType", + "modelAsString": true + } + }, + "vpnType": { + "type": "string", + "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.", + "enum": [ + "PolicyBased", + "RouteBased" + ], + "x-ms-enum": { + "name": "VpnType", + "modelAsString": true + } + }, + "enableBgp": { + "type": "boolean", + "description": "Whether BGP is enabled for this virtual network gateway or not." + }, + "activeActive": { + "type": "boolean", + "description": "ActiveActive flag" + }, + "gatewayDefaultSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." + }, + "sku": { + "$ref": "#/definitions/VirtualNetworkGatewaySku", + "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." + }, + "vpnClientConfiguration": { + "$ref": "#/definitions/VpnClientConfiguration", + "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Virtual network gateway's BGP speaker settings." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGateway resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "VirtualNetworkGateway properties" + }, + "VpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of SSL certificates of application gateway" + }, + "VpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of virtual network gateway" + }, + "VpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the revoked VPN client certificate of virtual network gateway." + }, + "VpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of virtual network gateway." + }, + "VpnClientConfiguration": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference of the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRootCertificate" + }, + "description": "VpnClientRootCertificate for virtual network gateway." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRevokedCertificate" + }, + "description": "VpnClientRevokedCertificate for Virtual network gateway." + }, + "vpnClientProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN client protocol enabled for the virtual network gateway.", + "enum": [ + "IkeV2", + "SSTP", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnClientProtocol", + "modelAsString": true + } + }, + "description": "VpnClientProtocols for Virtual network gateway." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for virtual network gateway P2S client." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." + } + }, + "description": "VpnClientConfiguration for P2S client." + }, + "VirtualNetworkGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Gateway SKU name.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Gateway SKU tier.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The capacity." + } + }, + "description": "VirtualNetworkGatewaySku details" + }, + "BgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + }, + "peerWeight": { + "type": "integer", + "format": "int32", + "description": "The weight added to routes learned from this BGP speaker." + } + }, + "description": "BGP settings details" + }, + "BgpPeerStatus": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The virtual network gateway's local address" + }, + "neighbor": { + "type": "string", + "readOnly": true, + "description": "The remote BGP peer" + }, + "asn": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The autonomous system number of the remote BGP peer" + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The BGP peer state", + "enum": [ + "Unknown", + "Stopped", + "Idle", + "Connecting", + "Connected" + ], + "x-ms-enum": { + "name": "BgpPeerState", + "modelAsString": true + } + }, + "connectedDuration": { + "type": "string", + "readOnly": true, + "description": "For how long the peering has been up" + }, + "routesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of routes learned from this peer" + }, + "messagesSent": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages sent" + }, + "messagesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages received" + } + }, + "description": "BGP peer status details" + }, + "GatewayRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The gateway's local address" + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix" + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop" + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from" + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from" + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence" + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight" + } + }, + "description": "Gateway routing details" + }, + "VirtualNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat", + "description": "Properties of the virtual network gateway." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VpnClientParameters": { + "properties": { + "processorArchitecture": { + "type": "string", + "description": "VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'.", + "enum": [ + "Amd64", + "X86" + ], + "x-ms-enum": { + "name": "ProcessorArchitecture", + "modelAsString": true + } + }, + "authenticationMethod": { + "type": "string", + "description": "VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'.", + "enum": [ + "EAPTLS", + "EAPMSCHAPv2" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "radiusServerAuthCertificate": { + "type": "string", + "description": "The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication." + }, + "clientRootCertificates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS." + } + }, + "description": "Vpn Client Parameters for package generation" + }, + "VirtualNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Gets a list of VirtualNetworkGateway resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGateways API service call." + }, + "BgpPeerStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpPeerStatus" + }, + "description": "List of BGP peers" + } + }, + "description": "Response for list BGP peer status API service call" + }, + "GatewayRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRoute" + }, + "description": "List of gateway routes" + } + }, + "description": "List of virtual network gateway routes" + }, + "TunnelConnectionHealth": { + "properties": { + "tunnel": { + "readOnly": true, + "type": "string", + "description": "Tunnel name." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Ingress Bytes Transferred in this connection" + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Egress Bytes Transferred in this connection" + }, + "lastConnectionEstablishedUtcTime": { + "readOnly": true, + "type": "string", + "description": "The time at which connection was established in Utc format." + } + }, + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnectionPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/LocalNetworkGateway", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "type": "string", + "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection" + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding" + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VirtualNetworkGatewayConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGatewayConnections API service call" + }, + "ConnectionResetSharedKey": { + "properties": { + "keyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The virtual network connection reset shared key length, should between 1 and 128." + } + }, + "required": [ + "keyLength" + ], + "description": "The virtual network connection reset shared key" + }, + "ConnectionSharedKey": { + "properties": { + "value": { + "type": "string", + "description": "The virtual network connection shared key value." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "value" + ], + "description": "Response for GetConnectionSharedKey API service call" + }, + "IpsecPolicy": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." + }, + "ipsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "ipsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "ikeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "ikeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "dhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "pfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec Policy configuration for a virtual network gateway connection" + }, + "ConnectionProtocol": { + "type": "string", + "description": "Gateway connection protocol. Possible values are: 'IKEv2', 'IKEv1'.", + "enum": [ + "IKEv2", + "IKEv1" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionProtocol", + "modelAsString": true + } + }, + "VpnClientIPsecParameters": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.." + }, + "ipsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "ipsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "ikeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "ikeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "dhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "pfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec parameters for a virtual network gateway P2S connection." + }, + "LocalNetworkGatewayPropertiesFormat": { + "properties": { + "localNetworkAddressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "Local network site address space." + }, + "gatewayIpAddress": { + "type": "string", + "description": "IP address of local network gateway." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the LocalNetworkGateway resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the LocalNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "LocalNetworkGateway properties" + }, + "LocalNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat", + "description": "Properties of the local network gateway." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "LocalNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "A list of local network gateways that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLocalNetworkGateways API service call." + }, + "virtualNetworkConnectionGatewayReference": { + "properties": { + "id": { + "type": "string", + "description": "The ID of VirtualNetworkGateway or LocalNetworkGateway resource." + } + }, + "required": [ + "id" + ], + "description": "A reference to VirtualNetworkGateway or LocalNetworkGateway resource." + }, + "VirtualNetworkGatewayConnectionListEntityPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/virtualNetworkConnectionGatewayReference", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "type": "string", + "description": "Gateway connection type. Possible values are: 'Ipsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection" + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "description": "Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "resourceGuid": { + "type": "string", + "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding" + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties" + }, + "VirtualNetworkGatewayConnectionListEntity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntityPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information" + }, + "VirtualNetworkGatewayListConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntity" + }, + "description": "Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the VirtualNetworkGatewayListConnections API service call" + }, + "VpnDeviceScriptParameters": { + "properties": { + "vendor": { + "type": "string", + "description": "The vendor for the vpn device." + }, + "deviceFamily": { + "type": "string", + "description": "The device family for the vpn device." + }, + "firmwareVersion": { + "type": "string", + "description": "The firmware version for the vpn device." + } + }, + "description": "Vpn device configuration script generation parameters" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json new file mode 100644 index 000000000000..08251f8557c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json @@ -0,0 +1,391 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}": { + "delete": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Delete", + "description": "Deletes the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + } + }, + "x-ms-examples": + { + "Delete Virtual Network Tap resource": { "$ref": "./examples/VirtualNetworkTapDelete.json" } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Get", + "description": "Gets information about the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + } + }, + "x-ms-examples": + { + "Get Virtual Network Tap": { "$ref": "./examples/VirtualNetworkTapGet.json" } + } + }, + "put": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_CreateOrUpdate", + "description": "Creates or updates a Virtual Network Tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "Parameters supplied to the create or update virtual network tap operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + } + }, + "x-ms-examples": + { + "Create Virtual Network Tap": { "$ref": "./examples/VirtualNetworkTapCreate.json" } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_UpdateTags", + "description": "Updates an VirtualNetworkTap tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap." + }, + { + "name": "tapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualNetworkTap tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + } + }, + "x-ms-examples": { + "Update virtual network tap tags": { "$ref": "./examples/VirtualNetworkTapUpdateTags.json" } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListAll", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + } + }, + "x-ms-examples": { + "List all virtual network taps": { "$ref": "./examples/VirtualNetworkTapListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListByResourceGroup", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + } + }, + "x-ms-examples": { + "List virtual network taps in resource group": { "$ref": "./examples/VirtualNetworkTapList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } +}, +"definitions": { + "VirtualNetworkTap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkTapPropertiesFormat", + "description": "Virtual Network Tap Properties." + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network Tap resource" + }, + "VirtualNetworkTapPropertiesFormat": { + "description": "Virtual Network Tap properties.", + "properties": { + "networkInterfaceTapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration", + "description": "The reference of the Network Interface." + }, + "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resourceGuid property of the virtual network tap." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "destinationNetworkInterfaceIPConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "The reference to the private IP Address of the collector nic that will receive the tap" + }, + "destinationLoadBalancerFrontEndIPConfiguration": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration", + "description": "The reference to the private IP address on the internal Load Balancer that will receive the tap" + }, + "destinationPort": { + "type": "integer", + "description": "The VXLAN destination port that will receive the tapped traffic." + } + } + }, + "VirtualNetworkTapListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "A list of VirtualNetworkTaps in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListVirtualNetworkTap API service call." + } +}, +"parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json new file mode 100644 index 000000000000..0c4ec22bea82 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/virtualWan.json @@ -0,0 +1,3348 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualWANAsAServiceManagementClient", + "description": "REST API for Azure VirtualWAN As a Service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { + "get": { + "operationId": "VirtualWans_Get", + "x-ms-examples": { + "VirtualWANGet": { + "$ref": "./examples/VirtualWANGet.json" + } + }, + "description": "Retrieves the details of a VirtualWAN.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN retrieved.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualWans_CreateOrUpdate", + "x-ms-examples": { + "VirtualWANCreate": { + "$ref": "./examples/VirtualWANPut.json" + } + }, + "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "Parameters supplied to create or update VirtualWAN." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN created or updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualWAN resource.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualWans_UpdateTags", + "x-ms-examples": { + "VirtualWANUpdate": { + "$ref": "./examples/VirtualWANUpdateTags.json" + } + }, + "description": "Updates a VirtualWAN tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update VirtualWAN tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualWans_Delete", + "x-ms-examples": { + "VirtualWANDelete": { + "$ref": "./examples/VirtualWANDelete.json" + } + }, + "description": "Deletes a VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualWAN deleted." + }, + "202": { + "description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualWANs exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_ListByResourceGroup", + "x-ms-examples": { + "VirtualWANListByResourceGroup": { + "$ref": "./examples/VirtualWANListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualWANs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_List", + "x-ms-examples": { + "VirtualWANList": { + "$ref": "./examples/VirtualWANList.json" + } + }, + "description": "Lists all the VirtualWANs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { + "get": { + "operationId": "VpnSites_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteGet.json" + } + }, + "description": "Retrieves the details of a VPNsite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite retrieved.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnSites_CreateOrUpdate", + "x-ms-examples": { + "VpnSiteCreate": { + "$ref": "./examples/VpnSitePut.json" + } + }, + "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnSite" + }, + "description": "Parameters supplied to create or update VpnSite." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VpnSites" + ], + "operationId": "VpnSites_UpdateTags", + "x-ms-examples": { + "VpnSiteUpdate": { + "$ref": "./examples/VpnSiteUpdateTags.json" + } + }, + "description": "Updates VpnSite tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnSite tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnSites_Delete", + "x-ms-examples": { + "VpnSiteDelete": { + "$ref": "./examples/VpnSiteDelete.json" + } + }, + "description": "Deletes a VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnSite deleted." + }, + "202": { + "description": "Request received successfully. VpnSite deletion is in progress" + }, + "204": { + "description": "No VpnSites exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_ListByResourceGroup", + "x-ms-examples": { + "VpnSiteListByResourceGroup": { + "$ref": "./examples/VpnSiteListByResourceGroup.json" + } + }, + "description": "Lists all the vpnSites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_List", + "x-ms-examples": { + "VpnSiteList": { + "$ref": "./examples/VpnSiteList.json" + } + }, + "description": "Lists all the VpnSites in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnSites in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { + "post": { + "operationId": "VpnSitesConfiguration_Download", + "x-ms-examples": { + "VpnSitesConfigurationDownload": { + "$ref": "./examples/VpnSitesConfigurationDownload.json" + } + }, + "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetVpnSitesConfigurationRequest" + }, + "description": "Parameters supplied to download vpn-sites configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": { + "get": { + "operationId": "SupportedSecurityProviders", + "x-ms-examples": { + "supportedSecurityProviders": { + "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" + } + }, + "description": "Gives the supported security providers for the virtual wan.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which supported security providers are needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the object containing supported security providers.", + "schema": { + "$ref": "#/definitions/VirtualWanSecurityProviders" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { + "get": { + "operationId": "VirtualHubs_Get", + "x-ms-examples": { + "VirtualHubGet": { + "$ref": "./examples/VirtualHubGet.json" + } + }, + "description": "Retrieves the details of a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualHubs_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubPut": { + "$ref": "./examples/VirtualHubPut.json" + } + }, + "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "Parameters supplied to create or update VirtualHub." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualHubs_UpdateTags", + "x-ms-examples": { + "VirtualHubUpdate": { + "$ref": "./examples/VirtualHubUpdateTags.json" + } + }, + "description": "Updates VirtualHub tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualHub tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VirtualHubs_Delete", + "x-ms-examples": { + "VirtualHubDelete": { + "$ref": "./examples/VirtualHubDelete.json" + } + }, + "description": "Deletes a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHub deleted." + }, + "202": { + "description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubs exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_ListByResourceGroup", + "x-ms-examples": { + "VirtualHubListByResourceGroup": { + "$ref": "./examples/VirtualHubListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualHubs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_List", + "x-ms-examples": { + "VirtualHubList": { + "$ref": "./examples/VirtualHubList.json" + } + }, + "description": "Lists all the VirtualHubs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { + "get": { + "operationId": "HubVirtualNetworkConnections_Get", + "x-ms-examples": { + "HubVirtualNetworkConnectionGet": { + "$ref": "./examples/HubVirtualNetworkConnectionGet.json" + } + }, + "description": "Retrieves the details of a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { + "get": { + "operationId": "HubVirtualNetworkConnections_List", + "x-ms-examples": { + "HubVirtualNetworkConnectionList": { + "$ref": "./examples/HubVirtualNetworkConnectionList.json" + } + }, + "description": "Retrieves the details of all HubVirtualNetworkConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { + "get": { + "operationId": "VpnGateways_Get", + "x-ms-examples": { + "VpnGatewayGet": { + "$ref": "./examples/VpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnGateways_CreateOrUpdate", + "x-ms-examples": { + "VpnGatewayPut": { + "$ref": "./examples/VpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_UpdateTags", + "x-ms-examples": { + "VpnGatewayUpdate": { + "$ref": "./examples/VpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan vpn gateway tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnGateways_Delete", + "x-ms-examples": { + "VpnGatewayDelete": { + "$ref": "./examples/VpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Gateway deleted." + }, + "202": { + "description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn gateways exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_ListByResourceGroup", + "x-ms-examples": { + "VpnGatewayListByResourceGroup": { + "$ref": "./examples/VpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the VpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_List", + "x-ms-examples": { + "VpnGatewayListBySubscription": { + "$ref": "./examples/VpnGatewayList.json" + } + }, + "description": "Lists all the VpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { + "get": { + "operationId": "VpnConnections_Get", + "x-ms-examples": { + "VpnConnectionGet": { + "$ref": "./examples/VpnConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VpnConnections_CreateOrUpdate", + "x-ms-examples": { + "VpnConnectionPut": { + "$ref": "./examples/VpnConnectionPut.json" + } + }, + "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "Parameters supplied to create or Update a VPN Connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "VpnConnections_Delete", + "x-ms-examples": { + "VpnConnectionDelete": { + "$ref": "./examples/VpnConnectionDelete.json" + } + }, + "description": "Deletes a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Connection deleted." + }, + "202": { + "description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn connections exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { + "get": { + "operationId": "VpnConnections_ListByVpnGateway", + "x-ms-examples": { + "VpnConnectionList": { + "$ref": "./examples/VpnConnectionList.json" + } + }, + "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnConnectionsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWanName}/p2sVpnServerConfigurations/{p2SVpnServerConfigurationName}": { + "get": { + "operationId": "P2sVpnServerConfigurations_Get", + "x-ms-examples": { + "P2SVpnServerConfigurationGet": { + "$ref": "./examples/P2SVpnServerConfigurationGet.json" + } + }, + "description": "Retrieves the details of a P2SVpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnServerConfiguration." + }, + { + "name": "virtualWanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWan." + }, + { + "name": "p2SVpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the P2SVpnServerConfiguration.", + "schema": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "P2sVpnServerConfigurations_CreateOrUpdate", + "x-ms-examples": { + "P2SVpnServerConfigurationPut": { + "$ref": "./examples/P2SVpnServerConfigurationPut.json" + } + }, + "description": "Creates a P2SVpnServerConfiguration to associate with a VirtualWan if it doesn't exist else updates the existing P2SVpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "virtualWanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWan." + }, + { + "name": "p2SVpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + }, + "description": "Parameters supplied to create or Update a P2SVpnServerConfiguration." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the P2SVpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + } + }, + "201": { + "description": "Request successful. Returns the details of the P2SVpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "P2sVpnServerConfigurations_Delete", + "x-ms-examples": { + "P2SVpnServerConfigurationDelete": { + "$ref": "./examples/P2SVpnServerConfigurationDelete.json" + } + }, + "description": "Deletes a P2SVpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnServerConfiguration." + }, + { + "name": "virtualWanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWan." + }, + { + "name": "p2SVpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. P2SVpnServerConfiguration deleted." + }, + "202": { + "description": "Request received successfully. P2SVpnServerConfiguration deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No P2SVpnServerConfigurations exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWanName}/p2sVpnServerConfigurations": { + "get": { + "operationId": "P2sVpnServerConfigurations_ListByVirtualWan", + "x-ms-examples": { + "P2SVpnServerConfigurationList": { + "$ref": "./examples/P2SVpnServerConfigurationList.json" + } + }, + "description": "Retrieves all P2SVpnServerConfigurations for a particular VirtualWan.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "virtualWanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all P2SVpnServerConfigurations for a VirtualWan.", + "schema": { + "$ref": "#/definitions/ListP2SVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { + "get": { + "operationId": "P2sVpnGateways_Get", + "x-ms-examples": { + "P2SVpnGatewayGet": { + "$ref": "./examples/P2SVpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "P2sVpnGateways_CreateOrUpdate", + "x-ms-examples": { + "P2SVpnGatewayPut": { + "$ref": "./examples/P2SVpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_UpdateTags", + "x-ms-examples": { + "P2SVpnGatewayUpdate": { + "$ref": "./examples/P2SVpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan p2s vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "P2sVpnGateways_Delete", + "x-ms-examples": { + "P2SVpnGatewayDelete": { + "$ref": "./examples/P2SVpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. P2SVpnGateway deleted." + }, + "202": { + "description": "Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No p2s vpn gateways exist by the name provided." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_ListByResourceGroup", + "x-ms-examples": { + "P2SVpnGatewayListByResourceGroup": { + "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the P2SVpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_List", + "x-ms-examples": { + "P2SVpnGatewayListBySubscription": { + "$ref": "./examples/P2SVpnGatewayList.json" + } + }, + "description": "Lists all the P2SVpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnProfileParameters" + }, + "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + }, + "x-ms-examples": { + "GenerateP2SVpnGatewayVPNProfile": { "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "VirtualWanProperties": { + "properties": { + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "virtualHubs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VirtualHubs in the VirtualWAN." + }, + "vpnSites": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "securityProviderName": { + "type": "string", + "description": "The Security Provider name." + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "description": "True if branch to branch traffic is allowed." + }, + "allowVnetToVnetTraffic": { + "type": "boolean", + "description": "True if Vnet to Vnet traffic is allowed." + }, + "office365LocalBreakoutCategory": { + "description": "The office local breakout category.", + "$ref": "#/definitions/OfficeTrafficCategory" + }, + "p2SVpnServerConfigurations": { + "type": "array", + "description": "list of all P2SVpnServerConfigurations associated with the virtual wan.", + "items": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VirtualWAN" + }, + "VirtualWAN": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualWanProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualWAN Resource." + }, + "ListVirtualWANsResult": { + "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "List of VirtualWANs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the vpnSite belongs" + }, + "deviceProperties": { + "description": "The device properties", + "$ref": "#/definitions/DeviceProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site." + }, + "siteKey": { + "type": "string", + "description": "The key for vpn-site that can be used for connections." + }, + "addressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges." + }, + "bgpProperties": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "isSecuritySite": { + "type": "boolean", + "description": "IsSecuritySite flag" + } + }, + "description": "Parameters for VpnSite" + }, + "VpnSite": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnSite Resource." + }, + "ListVpnSitesResult": { + "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSite" + }, + "description": "List of VpnSites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "GetVpnSitesConfigurationRequest": { + "properties": { + "vpnSites": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the configurations for vpn-sites" + } + }, + "description": "List of Vpn-Sites" + }, + "VirtualHubProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the VirtualHub belongs" + }, + "vpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnGateway associated with this VirtualHub" + }, + "p2SVpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The P2SVpnGateway associated with this VirtualHub" + }, + "expressRouteGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The expressRouteGateway associated with this VirtualHub" + }, + "virtualNetworkConnections": { + "type": "array", + "description": "list of all vnet connections with this VirtualHub.", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "addressPrefix": { + "type": "string", + "description": "Address-prefix for this VirtualHub." + }, + "routeTable": { + "$ref": "#/definitions/VirtualHubRouteTable", + "description": "The routeTable associated with this virtual hub." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VirtualHub" + }, + "VirtualHubRouteTable": { + "properties" : { + "routes": { + "type": "array", + "description": "list of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRoute" + } + } + }, + "description" : "VirtualHub route table" + }, + "VirtualHubRoute": { + "properties" : { + "addressPrefixes": { + "type": "array", + "description": "list of all addressPrefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "NextHop ip address." + } + }, + "description" : "VirtualHub route" + }, + "VirtualHub": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualHub Resource." + }, + "ListVirtualHubsResult": { + "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "List of VirtualHubs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs" + }, + "connections": { + "type": "array", + "description": "list of all vpn connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnConnection" + } + }, + "bgpSettings": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this vpn gateway." + } + }, + "description": "Parameters for VpnGateway" + }, + "VpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnGateway Resource." + }, + "ListVpnGatewaysResult": { + "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "List of VpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionProperties": { + "properties": { + "remoteVpnSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "routing weight for vpn connection." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag" + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for VpnConnection" + }, + "VpnConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnConnectionProperties" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnConnection Resource." + }, + "ListVpnConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "List of Vpn Connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubVirtualNetworkConnectionProperties": { + "properties": { + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the remote virtual network." + }, + "allowHubToRemoteVnetTransit": { + "type": "boolean", + "description": "VirtualHub to RemoteVnet transit to enabled or not." + }, + "allowRemoteVnetToUseHubVnetGateways": { + "type": "boolean", + "description": "Allow RemoteVnet to use Virtual Hub's gateways." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + } + }, + "description": "Parameters for HubVirtualNetworkConnection" + }, + "HubVirtualNetworkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "HubVirtualNetworkConnection Resource." + }, + "ListHubVirtualNetworkConnectionsResult": { + "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "List of HubVirtualNetworkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteId": { + "properties": { + "vpnSite": { + "type": "string", + "readOnly": true, + "description": "The resource-uri of the vpn-site for which config is to be fetched." + } + }, + "description": "VpnSite Resource." + }, + "DeviceProperties": { + "properties": { + "deviceVendor": { + "type": "string", + "description": "Name of the device Vendor." + }, + "deviceModel": { + "type": "string", + "description": "Model of the device." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of the device." + }, + "VirtualWanSecurityProviders": { + "properties": { + "supportedProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWanSecurityProvider" + } + } + }, + "description": "Collection of SecurityProviders." + }, + "VirtualWanSecurityProvider": { + "properties": { + "name": { + "type": "string", + "description": "Name of the security provider." + }, + "url": { + "type": "string", + "description": "Url of the security provider." + }, + "type": { + "$ref": "#/definitions/VirtualWanSecurityProviderType", + "description": "Name of the security provider." + } + }, + "description": "Collection of SecurityProviders." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisisoning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "VpnConnectionStatus": { + "type": "string", + "description": "The current state of the vpn connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "vpnConnectionStatus", + "modelAsString": true + } + }, + "TunnelConnectionStatus": { + "type": "string", + "description": "The current state of the tunnel.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "tunnelConnectionStatus", + "modelAsString": true + } + }, + "HubVirtualNetworkConnectionStatus": { + "type": "string", + "description": "The current state of the VirtualHub to vnet connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubVirtualNetworkConnectionStatus", + "modelAsString": true + } + }, + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "access": { + "type": "string", + "description": "Access to be allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "OfficeTrafficCategory": { + "type": "string", + "description": "The office traffic category.", + "readOnly": true, + "enum": [ + "Optimize", + "OptimizeAndAllow", + "All", + "None" + ], + "x-ms-enum": { + "name": "officeTrafficCategory", + "modelAsString": true + } + }, + "VirtualWanSecurityProviderType": { + "type": "string", + "description": "The virtual wan security provider type.", + "readOnly": true, + "enum": [ + "External", + "Native" + ], + "x-ms-enum": { + "name": "virtualWanSecurityProviderType", + "modelAsString": true + } + }, + "P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the P2SVpnServerConfiguration VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of VPN client root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigVpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificatePropertiesFormat", + "description": "Properties of the P2SVpnServerConfiguration VPN client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the P2SVpnServerConfiguration Radius Server root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of Radius Server root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigRadiusServerRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificatePropertiesFormat", + "description": "Properties of the P2SVpnServerConfiguration Radius Server root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "Radius Server root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the revoked VPN client certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigVpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The Radius client root certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Radius client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + } + }, + "description": "Properties of the Radius client root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigRadiusClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificatePropertiesFormat", + "description": "Properties of the Radius client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Radius client root certificate of P2SVpnServerConfiguration." + }, + "P2SVpnServerConfigurationProperties": { + "properties": { + "name": { + "type": "string", + "description": "The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name." + }, + "vpnProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN protocol enabled for the P2SVpnServerConfiguration.", + "enum": [ + "IkeV2", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnGatewayTunnelingProtocol", + "modelAsString": true + } + }, + "description": "vpnProtocols for the P2SVpnServerConfiguration." + }, + "p2SVpnServerConfigVpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnServerConfigVpnClientRootCertificate" + }, + "description": "VPN client root certificate of P2SVpnServerConfiguration." + }, + "p2SVpnServerConfigVpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnServerConfigVpnClientRevokedCertificate" + }, + "description": "VPN client revoked certificate of P2SVpnServerConfiguration." + }, + "p2SVpnServerConfigRadiusServerRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnServerConfigRadiusServerRootCertificate" + }, + "description": "Radius Server root certificate of P2SVpnServerConfiguration." + }, + "p2SVpnServerConfigRadiusClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnServerConfigRadiusClientRootCertificate" + }, + "description": "Radius client root certificate of P2SVpnServerConfiguration." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for P2SVpnServerConfiguration." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the P2SVpnServerConfiguration resource for for point to site client connection." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the P2SVpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "p2SVpnGateways": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "etag": { + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Parameters for P2SVpnServerConfiguration" + }, + "P2SVpnServerConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnServerConfigurationProperties" + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "P2SVpnServerConfiguration Resource." + }, + "ListP2SVpnServerConfigurationsResult": { + "description": "Result of the request to list all P2SVpnServerConfigurations associated to a VirtualWan. It contains a list of P2SVpnServerConfigurations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnServerConfiguration" + }, + "description": "List of P2SVpnServerConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnClientConnectionHealth": { + "properties": { + "totalIngressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection" + }, + "totalEgressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Egress Bytes Transferred in this connection" + }, + "vpnClientConnectionsCount": { + "type": "integer", + "format": "int32", + "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." + }, + "allocatedIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allocated ip addresses to the connected p2s vpn clients." + } + }, + "description": "VpnClientConnectionHealth properties" + }, + "P2SVpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "#/definitions/ProvisioningState" + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this p2s vpn gateway." + }, + "p2SVpnServerConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The P2SVpnServerConfiguration to which the p2sVpnGateway is attached to." + }, + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference of the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientConnectionHealth": { + "readOnly": true, + "$ref": "#/definitions/VpnClientConnectionHealth", + "description": "All P2S vpnclients' connection health status." + } + }, + "description": "Parameters for P2SVpnGateway" + }, + "P2SVpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnGatewayProperties" + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "P2SVpnGateway Resource." + }, + "ListP2SVpnGatewaysResult": { + "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of P2SVpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnProfileParameters": { + "properties": { + "authenticationMethod": { + "type": "string", + "description": "VPN client Authentication Method. Possible values are: 'EAPTLS' and 'EAPMSCHAPv2'.", + "enum": [ + "EAPTLS", + "EAPMSCHAPv2" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + } + }, + "description": "Vpn Client Parameters for package generation" + }, + "VpnProfileResponse": { + "properties": { + "profileUrl": { + "type": "string", + "description": "URL to the VPN profile" + } + }, + "description": "Vpn Profile Response for package generation" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json new file mode 100644 index 000000000000..b7d61ab82bb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json @@ -0,0 +1,389 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", + "description": "Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set vm network interfaces": { "$ref": "./examples/VmssVmNetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", + "description": "Gets all network interfaces in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interfaces": { "$ref": "./examples/VmssNetworkInterfaceList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", + "description": "Get the specified network interface in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { "$ref": "./examples/VmssNetworkInterfaceGet.json" } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetIpConfigurations", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfigurationListResult" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interface ip configurations": { "$ref": "./examples/VmssNetworkInterfaceIpConfigList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetIpConfiguration", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { "$ref": "./examples/VmssNetworkInterfaceIpConfigGet.json" } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json new file mode 100644 index 000000000000..d4ce2eb2ddd4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json @@ -0,0 +1,250 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2017-03-30" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { "$ref": "./examples/VmssPublicIpListAll.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses" : { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { "$ref": "./examples/VmssVmPublicIpList.json" } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { "$ref": "./examples/VmssPublicIpGet.json" } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/readme.go.md b/specification/network/resource-manager/readme.go.md index e40398aefe7f..3812c862f313 100644 --- a/specification/network/resource-manager/readme.go.md +++ b/specification/network/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-10 - tag: package-2018-08 - tag: package-2018-07 - tag: package-2018-06 @@ -33,6 +34,15 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2018-10 and go + +These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-10' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-10-01/$(namespace) +``` + ### Tag: package-2018-08 and go These settings apply only when `--tag=package-2018-08 --go` is specified on the command line. diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index bd698584a1b0..bbb8d966d9ce 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -28,15 +28,55 @@ These are the global settings for the Network API. title: NetworkManagementClient description: Network Client openapi-type: arm -tag: package-2018-08 +tag: package-2018-10 ``` +### Tag: package-2018-10 + +These settings apply only when `--tag=package-2018-10` is specified on the command line. + +```yaml $(tag) == 'package-2018-10' +input-file: + - Microsoft.Network/stable/2018-10-01/applicationGateway.json + - Microsoft.Network/stable/2018-10-01/applicationSecurityGroup.json + - Microsoft.Network/stable/2018-10-01/availableDelegations.json + - Microsoft.Network/stable/2018-10-01/azureFirewall.json + - Microsoft.Network/stable/2018-10-01/azureFirewallFqdnTag.json + - Microsoft.Network/stable/2018-10-01/checkDnsAvailability.json + - Microsoft.Network/stable/2018-10-01/ddosProtectionPlan.json + - Microsoft.Network/stable/2018-10-01/endpointService.json + - Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json + - Microsoft.Network/stable/2018-10-01/expressRouteCrossConnection.json + - Microsoft.Network/stable/2018-10-01/expressRouteGateway.json + - Microsoft.Network/stable/2018-10-01/expressRoutePort.json + - Microsoft.Network/stable/2018-10-01/interfaceEndpoint.json + - Microsoft.Network/stable/2018-10-01/loadBalancer.json + - Microsoft.Network/stable/2018-10-01/network.json + - Microsoft.Network/stable/2018-10-01/networkInterface.json + - Microsoft.Network/stable/2018-10-01/networkProfile.json + - Microsoft.Network/stable/2018-10-01/networkSecurityGroup.json + - Microsoft.Network/stable/2018-10-01/networkWatcher.json + - Microsoft.Network/stable/2018-10-01/operation.json + - Microsoft.Network/stable/2018-10-01/publicIpAddress.json + - Microsoft.Network/stable/2018-10-01/publicIpPrefix.json + - Microsoft.Network/stable/2018-10-01/routeFilter.json + - Microsoft.Network/stable/2018-10-01/routeTable.json + - Microsoft.Network/stable/2018-10-01/serviceCommunity.json + - Microsoft.Network/stable/2018-10-01/serviceEndpointPolicy.json + - Microsoft.Network/stable/2018-10-01/usage.json + - Microsoft.Network/stable/2018-10-01/virtualNetwork.json + - Microsoft.Network/stable/2018-10-01/virtualNetworkGateway.json + - Microsoft.Network/stable/2018-10-01/virtualNetworkTap.json + - Microsoft.Network/stable/2018-10-01/virtualWan.json + - Microsoft.Network/stable/2018-10-01/vmssNetworkInterface.json + - Microsoft.Network/stable/2018-10-01/vmssPublicIpAddress.json +``` ### Tag: package-2018-08 These settings apply only when `--tag=package-2018-08` is specified on the command line. -```yaml $(tag) == 'package-2018-08' +``` yaml $(tag) == 'package-2018-08' input-file: - Microsoft.Network/stable/2018-08-01/applicationGateway.json - Microsoft.Network/stable/2018-08-01/applicationSecurityGroup.json @@ -72,6 +112,7 @@ input-file: - Microsoft.Network/stable/2018-08-01/vmssNetworkInterface.json - Microsoft.Network/stable/2018-08-01/vmssPublicIpAddress.json ``` + ### Tag: package-2018-07 These settings apply only when `--tag=package-2018-07` is specified on the command line. diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index 3bda93a5a74c..11163fe1269d 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -18,6 +18,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-10 - tag: package-2018-08 - tag: package-2018-07 - tag: package-2018-06 @@ -35,6 +36,17 @@ batch: - tag: package-2015-06split ``` +### Tag: package-2018-10 and python + +These settings apply only when `--tag=package-2018-10 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-10' && $(python) +python: + namespace: azure.mgmt.network.v2018_10_01 + output-folder: $(python-sdks-folder)/azure-mgmt-network/azure/mgmt/network/v2018_10_01 +``` + ### Tag: package-2018-08 and python These settings apply only when `--tag=package-2018-08 --python` is specified on the command line. From 5bda5206ea6a22eb087812f653dfc22f79b78195 Mon Sep 17 00:00:00 2001 From: Anand <44665487+bingisbestest@users.noreply.github.com> Date: Tue, 27 Nov 2018 17:18:49 +0530 Subject: [PATCH 199/464] Change path for generated sdk (#4585) --- specification/cognitiveservices/data-plane/QnAMaker/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.md index aac4f3cd0d86..46c348f2d021 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.md @@ -47,7 +47,7 @@ csharp: license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false namespace: Microsoft.Azure.CognitiveServices.Knowledge.QnAMaker - output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Knowledge/QnAMaker/Generated + output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Knowledge/QnAMaker/QnAMaker/Generated clear-output-folder: true ``` From f8f38ccb60eb013b3e4bbdf0e6c4c6c015dba7aa Mon Sep 17 00:00:00 2001 From: mhofmann-hb <40657616+mhofmann-hb@users.noreply.github.com> Date: Tue, 27 Nov 2018 17:12:19 +0100 Subject: [PATCH 200/464] Update aliases.json (#4586) Update alias.json with an Alias for Windows Server 2019 Datacenter --- arm-compute/quickstart-templates/aliases.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/arm-compute/quickstart-templates/aliases.json b/arm-compute/quickstart-templates/aliases.json index 60d07919b422..8c6004242747 100644 --- a/arm-compute/quickstart-templates/aliases.json +++ b/arm-compute/quickstart-templates/aliases.json @@ -56,6 +56,12 @@ }, "Windows":{ + "Win2019Datacenter":{ + "publisher":"MicrosoftWindowsServer", + "offer":"WindowsServer", + "sku":"2019-Datacenter", + "version":"latest" + }, "Win2016Datacenter":{ "publisher":"MicrosoftWindowsServer", "offer":"WindowsServer", From 4636b0ca77242f5a1f5dc32bc8dd6b1bbf8be6c9 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 27 Nov 2018 09:09:15 -0800 Subject: [PATCH 201/464] Fix type-o in adhybridhealthservice model (#4587) Move Go SDK config to its own config file --- .../2014-01-01/ADHybridHealthService.json | 2 +- .../resource-manager/readme.go.md | 26 +++++++++++++++++++ .../resource-manager/readme.md | 26 +------------------ 3 files changed, 28 insertions(+), 26 deletions(-) create mode 100644 specification/adhybridhealthservice/resource-manager/readme.go.md diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json index 7ff20eec12e6..46e80b072a21 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -4587,7 +4587,7 @@ "description": "The AAD side user principal name.", "type": "string" }, - "aadDistringuishedName": { + "aadDistinguishedName": { "description": "The AAD side distinguished name for the object.", "type": "string" }, diff --git a/specification/adhybridhealthservice/resource-manager/readme.go.md b/specification/adhybridhealthservice/resource-manager/readme.go.md new file mode 100644 index 000000000000..557f9c2eb641 --- /dev/null +++ b/specification/adhybridhealthservice/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: adhybridhealthservice + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2014-01 +``` + +### Tag: package-2014-01 and go + +These settings apply only when `--tag=package-2014-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2014-01' && $(go) +output-folder: $(go-sdk-folder)/services/adhybridhealthservice/mgmt/2014-01-01/adhybridhealthservice +``` diff --git a/specification/adhybridhealthservice/resource-manager/readme.md b/specification/adhybridhealthservice/resource-manager/readme.md index 0894fbe80bdd..bf70e561423e 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.md +++ b/specification/adhybridhealthservice/resource-manager/readme.md @@ -88,31 +88,7 @@ python: ## Go -These settings apply only when `--go` is specified on the command line. - -``` yaml $(go) -go: - license-header: MICROSOFT_APACHE_NO_VERSION - namespace: adhybridhealthservice - clear-output-folder: true -``` - -### Go multi-api - -``` yaml $(go) && $(multiapi) -batch: - - tag: package-2014-01 -``` - -### Tag: package-2014-01 and go - -These settings apply only when `--tag=package-2014-01 --go` is specified on the command line. -Please also specify `--go-sdk-folder=`. - -``` yaml $(tag) == 'package-2014-01' && $(go) -output-folder: $(go-sdk-folder)/services/adhybridhealthservice/mgmt/2014-01-01/adhybridhealthservice -``` - +See configuration in [readme.go.md](./readme.go.md) ## Java From 248870d2d733dbfbdd9a623d0c5bfa14b69c3f74 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 27 Nov 2018 09:39:24 -0800 Subject: [PATCH 202/464] Add Go SDK build for sqlvirtualmachine (#4588) --- .../resource-manager/readme.go.md | 26 +++++++++++++++++++ .../resource-manager/readme.md | 5 ++++ 2 files changed, 31 insertions(+) create mode 100644 specification/sqlvirtualmachine/resource-manager/readme.go.md diff --git a/specification/sqlvirtualmachine/resource-manager/readme.go.md b/specification/sqlvirtualmachine/resource-manager/readme.go.md new file mode 100644 index 000000000000..852c633218e8 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: sqlvirtualmachine + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2017-03-01-preview +``` + +### Tag: package-2017-03-01-preview and go + +These settings apply only when `--tag=package-2017-03-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2017-03-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2017-03-01-preview/$(namespace) +``` diff --git a/specification/sqlvirtualmachine/resource-manager/readme.md b/specification/sqlvirtualmachine/resource-manager/readme.md index 1809a016ac95..e12a0c8486b6 100644 --- a/specification/sqlvirtualmachine/resource-manager/readme.md +++ b/specification/sqlvirtualmachine/resource-manager/readme.md @@ -53,6 +53,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + - repo: azure-sdk-for-go ``` @@ -99,3 +100,7 @@ python: basic-setup-py: true output-folder: $(python-sdks-folder)/azure-mgmt-sqlvirtualmachine ``` + +### Go + +See configuration in [readme.go.md](./readme.go.md) From 8bc8571d5d796f7c02b1dc8ce88effd2ba7a23e2 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 27 Nov 2018 13:45:10 -0500 Subject: [PATCH 203/464] typo: datafactory/resource-manager/Microsoft.DataF (#4573) actory - availably -> availability - Serivce -> Service - specificed -> specified - occurence -> occurrence - everytime -> every time - Double word "the" - Rrepository -> Repository - proprety -> property --- .../2017-09-01-preview/datafactory.json | 2 +- .../entityTypes/Dataset.json | 14 ++++++------- .../entityTypes/Pipeline.json | 16 +++++++-------- .../entityTypes/Trigger.json | 6 +++--- .../stable/2018-06-01/datafactory.json | 6 +++--- .../2018-06-01/entityTypes/Dataset.json | 14 ++++++------- .../2018-06-01/entityTypes/Pipeline.json | 20 +++++++++---------- .../2018-06-01/entityTypes/Trigger.json | 6 +++--- 8 files changed, 42 insertions(+), 42 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json index 13c5e57b598a..74dfdd5a010a 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/datafactory.json @@ -1055,7 +1055,7 @@ "$ref": "./examples/IntegrationRuntimes_Upgrade.json" } }, - "description": "Upgrade self-hosted integration runtime to latest version if availably.", + "description": "Upgrade self-hosted integration runtime to latest version if availability.", "parameters": [ { "$ref": "#/parameters/subscriptionId" diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json index 466c05c5a2fc..c7e447b9fc25 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Dataset.json @@ -1106,7 +1106,7 @@ }, "ConcurObjectDataset" : { "x-ms-discriminator-value": "ConcurObject", - "description": "Concur Serivce dataset.", + "description": "Concur Service dataset.", "type": "object", "allOf": [ { @@ -1202,7 +1202,7 @@ }, "HubspotObjectDataset" : { "x-ms-discriminator-value": "HubspotObject", - "description": "Hubspot Serivce dataset.", + "description": "Hubspot Service dataset.", "type": "object", "allOf": [ { @@ -1226,7 +1226,7 @@ }, "JiraObjectDataset" : { "x-ms-discriminator-value": "JiraObject", - "description": "Jira Serivce dataset.", + "description": "Jira Service dataset.", "type": "object", "allOf": [ { @@ -1274,7 +1274,7 @@ }, "PaypalObjectDataset" : { "x-ms-discriminator-value": "PaypalObject", - "description": "Paypal Serivce dataset.", + "description": "Paypal Service dataset.", "type": "object", "allOf": [ { @@ -1334,7 +1334,7 @@ }, "ShopifyObjectDataset" : { "x-ms-discriminator-value": "ShopifyObject", - "description": "Shopify Serivce dataset.", + "description": "Shopify Service dataset.", "type": "object", "allOf": [ { @@ -1358,7 +1358,7 @@ }, "SquareObjectDataset" : { "x-ms-discriminator-value": "SquareObject", - "description": "Square Serivce dataset.", + "description": "Square Service dataset.", "type": "object", "allOf": [ { @@ -1370,7 +1370,7 @@ }, "XeroObjectDataset" : { "x-ms-discriminator-value": "XeroObject", - "description": "Xero Serivce dataset.", + "description": "Xero Service dataset.", "type": "object", "allOf": [ { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json index 06cda743b02b..05876249e8ef 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json @@ -207,7 +207,7 @@ "$ref": "#/definitions/CopySink" }, "translator": { - "description": "Copy activity translator. If not specificed, tabular translator is used.", + "description": "Copy activity translator. If not specified, tabular translator is used.", "$ref": "#/definitions/CopyTranslator" }, "enableStaging": { @@ -673,7 +673,7 @@ } }, "ConcurSource": { - "description": "A copy activity Concur Serivce source.", + "description": "A copy activity Concur Service source.", "type": "object", "allOf": [ { @@ -793,7 +793,7 @@ } }, "HubspotSource": { - "description": "A copy activity Hubspot Serivce source.", + "description": "A copy activity Hubspot Service source.", "type": "object", "allOf": [ { @@ -823,7 +823,7 @@ } }, "JiraSource": { - "description": "A copy activity Jira Serivce source.", + "description": "A copy activity Jira Service source.", "type": "object", "allOf": [ { @@ -883,7 +883,7 @@ } }, "PaypalSource": { - "description": "A copy activity Paypal Serivce source.", + "description": "A copy activity Paypal Service source.", "type": "object", "allOf": [ { @@ -958,7 +958,7 @@ } }, "ShopifySource": { - "description": "A copy activity Shopify Serivce source.", + "description": "A copy activity Shopify Service source.", "type": "object", "allOf": [ { @@ -988,7 +988,7 @@ } }, "SquareSource": { - "description": "A copy activity Square Serivce source.", + "description": "A copy activity Square Service source.", "type": "object", "allOf": [ { @@ -1003,7 +1003,7 @@ } }, "XeroSource": { - "description": "A copy activity Xero Serivce source.", + "description": "A copy activity Xero Service source.", "type": "object", "allOf": [ { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json index 921b0da9c4da..0acf3d129ef0 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Trigger.json @@ -219,7 +219,7 @@ "additionalProperties": { "type": "object" }, - "description": "The recurrence schedule occurence." + "description": "The recurrence schedule occurrence." }, "DayOfWeek": { "type": "string", @@ -239,7 +239,7 @@ "description": "The days of the week." }, "BlobTrigger": { - "description": "Trigger that runs everytime the selected Blob container changes.", + "description": "Trigger that runs every time the selected Blob container changes.", "type": "object", "allOf": [ { @@ -277,7 +277,7 @@ }, "BlobEventsTrigger": { - "description": "Trigger that runs everytime a Blob event occurs.", + "description": "Trigger that runs every time a Blob event occurs.", "type": "object", "allOf": [ { 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 54f3381539eb..649a6e4a54d1 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 @@ -1133,7 +1133,7 @@ "$ref": "./examples/IntegrationRuntimes_Upgrade.json" } }, - "description": "Upgrade self-hosted integration runtime to latest version if availably.", + "description": "Upgrade self-hosted integration runtime to latest version if availability.", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2111,7 +2111,7 @@ }, { "name": "referencePipelineRunId", - "description": "The pipeline run identifier. If run ID is specified the parameters of the the specified run will be used to create a new run.", + "description": "The pipeline run identifier. If run ID is specified the parameters of the specified run will be used to create a new run.", "in": "query", "required": false, "type": "string", @@ -3486,7 +3486,7 @@ "type": "string" }, "repositoryName": { - "description": "Rrepository name.", + "description": "Repository name.", "type": "string" }, "collaborationBranch": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index 963d44ebc860..d0108dc083a4 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -1135,7 +1135,7 @@ }, "ConcurObjectDataset" : { "x-ms-discriminator-value": "ConcurObject", - "description": "Concur Serivce dataset.", + "description": "Concur Service dataset.", "type": "object", "allOf": [ { @@ -1271,7 +1271,7 @@ }, "HubspotObjectDataset" : { "x-ms-discriminator-value": "HubspotObject", - "description": "Hubspot Serivce dataset.", + "description": "Hubspot Service dataset.", "type": "object", "allOf": [ { @@ -1305,7 +1305,7 @@ }, "JiraObjectDataset" : { "x-ms-discriminator-value": "JiraObject", - "description": "Jira Serivce dataset.", + "description": "Jira Service dataset.", "type": "object", "allOf": [ { @@ -1373,7 +1373,7 @@ }, "PaypalObjectDataset" : { "x-ms-discriminator-value": "PaypalObject", - "description": "Paypal Serivce dataset.", + "description": "Paypal Service dataset.", "type": "object", "allOf": [ { @@ -1458,7 +1458,7 @@ }, "ShopifyObjectDataset" : { "x-ms-discriminator-value": "ShopifyObject", - "description": "Shopify Serivce dataset.", + "description": "Shopify Service dataset.", "type": "object", "allOf": [ { @@ -1492,7 +1492,7 @@ }, "SquareObjectDataset" : { "x-ms-discriminator-value": "SquareObject", - "description": "Square Serivce dataset.", + "description": "Square Service dataset.", "type": "object", "allOf": [ { @@ -1509,7 +1509,7 @@ }, "XeroObjectDataset" : { "x-ms-discriminator-value": "XeroObject", - "description": "Xero Serivce dataset.", + "description": "Xero Service dataset.", "type": "object", "allOf": [ { 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 d808f70f6520..14d232b10bfb 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 @@ -98,11 +98,11 @@ "type": "object", "properties": { "name": { - "description": "User proprety name.", + "description": "User property name.", "type": "string" }, "value": { - "description": "User proprety value. Type: string (or Expression with resultType string).", + "description": "User property value. Type: string (or Expression with resultType string).", "type": "object" } }, @@ -250,7 +250,7 @@ "$ref": "#/definitions/CopySink" }, "translator": { - "description": "Copy activity translator. If not specificed, tabular translator is used.", + "description": "Copy activity translator. If not specified, tabular translator is used.", "$ref": "#/definitions/CopyTranslator" }, "enableStaging": { @@ -716,7 +716,7 @@ } }, "ConcurSource": { - "description": "A copy activity Concur Serivce source.", + "description": "A copy activity Concur Service source.", "type": "object", "allOf": [ { @@ -836,7 +836,7 @@ } }, "HubspotSource": { - "description": "A copy activity Hubspot Serivce source.", + "description": "A copy activity Hubspot Service source.", "type": "object", "allOf": [ { @@ -866,7 +866,7 @@ } }, "JiraSource": { - "description": "A copy activity Jira Serivce source.", + "description": "A copy activity Jira Service source.", "type": "object", "allOf": [ { @@ -926,7 +926,7 @@ } }, "PaypalSource": { - "description": "A copy activity Paypal Serivce source.", + "description": "A copy activity Paypal Service source.", "type": "object", "allOf": [ { @@ -1001,7 +1001,7 @@ } }, "ShopifySource": { - "description": "A copy activity Shopify Serivce source.", + "description": "A copy activity Shopify Service source.", "type": "object", "allOf": [ { @@ -1031,7 +1031,7 @@ } }, "SquareSource": { - "description": "A copy activity Square Serivce source.", + "description": "A copy activity Square Service source.", "type": "object", "allOf": [ { @@ -1046,7 +1046,7 @@ } }, "XeroSource": { - "description": "A copy activity Xero Serivce source.", + "description": "A copy activity Xero Service source.", "type": "object", "allOf": [ { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json index efd7a39d3cb5..7b9b775d38da 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Trigger.json @@ -219,7 +219,7 @@ "additionalProperties": { "type": "object" }, - "description": "The recurrence schedule occurence." + "description": "The recurrence schedule occurrence." }, "DayOfWeek": { "type": "string", @@ -239,7 +239,7 @@ "description": "The days of the week." }, "BlobTrigger": { - "description": "Trigger that runs everytime the selected Blob container changes.", + "description": "Trigger that runs every time the selected Blob container changes.", "type": "object", "allOf": [ { @@ -277,7 +277,7 @@ }, "BlobEventsTrigger": { - "description": "Trigger that runs everytime a Blob event occurs.", + "description": "Trigger that runs every time a Blob event occurs.", "type": "object", "allOf": [ { From 7bf20385585be2e725bd25a16b54090ce5d0e8b1 Mon Sep 17 00:00:00 2001 From: Yugang Wang Date: Tue, 27 Nov 2018 10:46:48 -0800 Subject: [PATCH 204/464] add customKeyIdentifier to password credential (#4507) * add customKeyIdentifier to password credential * add creds in app object * custom id(thumbprint) for cert creds should be string type --- .../data-plane/stable/1.6/graphrbac.json | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json index eaedd961a2bf..e679678e640f 100644 --- a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json +++ b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json @@ -2465,7 +2465,6 @@ }, "customKeyIdentifier": { "type":"string", - "format": "byte", "description": "Custom Key Identifier" } }, @@ -2494,6 +2493,11 @@ "value": { "type": "string", "description": "Key value." + }, + "customKeyIdentifier": { + "type": "string", + "format": "byte", + "description": "Custom Key Identifier" } }, "additionalProperties": { @@ -2735,16 +2739,30 @@ "type": "string", "description": "The home page of the application." }, - "oauth2AllowImplicitFlow" : { + "oauth2AllowImplicitFlow": { "type": "boolean", "description": "Whether to allow implicit grant flow for OAuth2" }, - "requiredResourceAccess" : { + "requiredResourceAccess": { "type": "array", "items": { "$ref": "#/definitions/RequiredResourceAccess" }, "description": "Specifies resources that this application requires access to and the set of OAuth permission scopes and application roles that it needs under each of those resources. This pre-configuration of required resource access drives the consent experience." + }, + "keyCredentials": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyCredential" + }, + "description": "A collection of KeyCredential objects." + }, + "passwordCredentials": { + "type": "array", + "items": { + "$ref": "#/definitions/PasswordCredential" + }, + "description": "A collection of PasswordCredential objects" } }, "description": "Active Directory application information." From 92f4becc6899a0e0759b1fea3b12677da55cc449 Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Tue, 27 Nov 2018 11:04:22 -0800 Subject: [PATCH 205/464] Microsoft.StorageSync - Fix Issue 4559 and other known problems with preview version (#4565) * Update storagesync.json * Update storagesync.json * Fix Examples --- .../examples/RegisteredServers_Create.json | 4 +- .../examples/RegisteredServers_Get.json | 2 +- ...teredServers_ListByStorageSyncService.json | 2 +- .../preview/2018-10-01/storagesync.json | 124 +++++++++++++++++- 4 files changed, 125 insertions(+), 7 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json index 1f00b3a4a60a..2f6dd2b5a4d5 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Create.json @@ -10,7 +10,7 @@ "serverRole": "Standalone", "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", - "serverManagementtErrorCode": 0, + "serverManagementErrorCode": 0, "serverOSVersion": "10.0.14393.0", "agentVersion": "1.0.277.0" }, @@ -31,7 +31,7 @@ "properties": { "agentVersion": "3.1.5.0", "serverOSVersion": "10.0.14393.0", - "serverManagementtErrorCode": 0, + "serverManagementErrorCode": 0, "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", "provisioningState": "Succeeded", "serverRole": "Standalone", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json index 3bb5b421fcb6..c10b6ac63643 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_Get.json @@ -17,7 +17,7 @@ "properties": { "agentVersion": "3.1.5.0", "serverOSVersion": "10.0.14393.0", - "serverManagementtErrorCode": 0, + "serverManagementErrorCode": 0, "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", "provisioningState": "Succeeded", "serverRole": "Standalone", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json index a7a896e77b31..4513ae03609d 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/RegisteredServers_ListByStorageSyncService.json @@ -17,7 +17,7 @@ "properties": { "agentVersion": "3.1.5.0", "serverOSVersion": "10.0.14393.0", - "serverManagementtErrorCode": 0, + "serverManagementErrorCode": 0, "lastHeartBeat": "\"2018-06-11T21:50:40.5840543Z\"", "provisioningState": "Succeeded", "serverRole": "Standalone", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index 2f389cc66529..230434c6450a 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -3173,7 +3173,7 @@ "type": "string", "description": "Registered Server OS Version" }, - "serverManagementtErrorCode": { + "serverManagementErrorCode": { "type": "integer", "description": "Registered Server Management Error Code" }, @@ -3356,9 +3356,10 @@ "type": "string", "description": "Resource Last Operation Name" }, - "syncStatus": { + "syncStatus": { "type": "object", - "description": "Sync Health Status" + "$ref": "#/definitions/ServerEndpointHealth", + "description": "Server Endpoint properties." }, "offlineDataTransfer": { "$ref": "#/definitions/FeatureStatus", @@ -3380,6 +3381,112 @@ } } }, + "ServerEndpointHealth": { + "type": "object", + "description": "ServerEndpoint Health object.", + "properties": { + "downloadHealth": { + "$ref": "#/definitions/HealthState", + "description": "Download Health Status." + }, + "uploadHealth": { + "$ref": "#/definitions/HealthState", + "description": "Upload Health Status." + }, + "combinedHealth": { + "$ref": "#/definitions/HealthState", + "description": "Combined Health Status." + }, + "lastUpdatedTimestamp": { + "type" : "string", + "format" : "date-time", + "description": "Last Updated Timestamp" + }, + "uploadStatus": { + "$ref": "#/definitions/SyncSessionStatus", + "description": "Upload Status" + }, + "downloadStatus": { + "$ref": "#/definitions/SyncSessionStatus", + "description": "Download Status" + }, + "currentProgress": { + "$ref": "#/definitions/SyncProgressStatus", + "description": "Current progress" + } + } + }, + "SyncSessionStatus": { + "type": "object", + "description": "Sync Session status object.", + "properties": { + "lastSyncResult": { + "type": "integer", + "description": "Last sync status" + }, + "lastSyncTimestamp": { + "type" : "string", + "format" : "date-time", + "description": "Last sync timestamp" + }, + "lastSyncSuccessTimestamp": { + "type" : "string", + "format" : "date-time", + "description": "Last sync success timestamp" + }, + "lastSyncPerItemErrorCount": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Last sync per item error count." + } + } + }, + "SyncProgressStatus": { + "type": "object", + "description": "Sync Session status object.", + "properties": { + "progressTimestamp": { + "type" : "string", + "format" : "date-time", + "description": "Progress timestamp" + }, + "syncDirection": { + "$ref": "#/definitions/ProgressType", + "description": "Sync direction." + }, + "perItemErrorCount": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Per item error count" + }, + "appliedItemCount": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Applied item count." + }, + "totalItemCount": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Total item count" + }, + "appliedBytes": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Applied bytes" + }, + "totalBytes": { + "type": "integer", + "minimum": 0, + "maximum": 2147483647, + "description": "Total bytes" + } + } + }, "PhysicalPath": { "type": "string", "description": "Server folder used for data synchronization" @@ -3400,6 +3507,17 @@ "off" ] }, + "HealthState": { + "type": "string", + "description": "Type of the Health state", + "enum": [ + "Healthy", + "Error", + "SyncBlockedForRestore", + "SyncBlockedForChangeDetectionPostRestore", + "NoActivity" + ] + }, "WorkflowStatus": { "type": "string", "description": "Type of the Workflow Status", From 21f0dcbb89544101d79be7fc889a86ce0911901b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 27 Nov 2018 14:05:10 -0500 Subject: [PATCH 206/464] typo: analysisservices/resource-manager/Microsoft.AnalysisServices (#4583) - Supends -> Suspends - enableing -> enabling - availibility -> availability --- .../preview/2017-08-01-beta/analysisservices.json | 6 +++--- .../stable/2016-05-16/analysisservices.json | 4 ++-- .../stable/2017-07-14/analysisservices.json | 4 ++-- .../stable/2017-08-01/analysisservices.json | 6 +++--- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json index dcc953755ad0..f8b0cb247a87 100644 --- a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json +++ b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/preview/2017-08-01-beta/analysisservices.json @@ -209,7 +209,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend": { "post": { - "description": "Supends operation of the specified Analysis Services server instance.", + "description": "Suspends operation of the specified Analysis Services server instance.", "x-ms-examples": { "Suspend a server.": { "$ref": "./examples/suspendServer.json" } }, @@ -949,7 +949,7 @@ }, "enablePowerBIService": { "type": "string", - "description": "The indicator of enableing PBI service." + "description": "The indicator of enabling PBI service." } } }, @@ -1051,7 +1051,7 @@ } }, "CheckServerNameAvailabilityResult": { - "description": "The checking result of server name availibility.", + "description": "The checking result of server name availability.", "type": "object", "properties": { "nameAvailable": { diff --git a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json index 29d41fd3d068..2c96289d2824 100644 --- a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json +++ b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2016-05-16/analysisservices.json @@ -197,7 +197,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend": { "post": { - "description": "Supends operation of the specified Analysis Services server instance.", + "description": "Suspends operation of the specified Analysis Services server instance.", "tags": [ "Servers" ], "operationId": "Servers_Suspend", "parameters": [ @@ -732,7 +732,7 @@ } }, "CheckServerNameAvailabilityResult": { - "description": "The checking result of server name availibility.", + "description": "The checking result of server name availability.", "type": "object", "properties": { "nameAvailable": { diff --git a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json index 27e15e5ff448..1aa36ddb5c99 100644 --- a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json +++ b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-07-14/analysisservices.json @@ -197,7 +197,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend": { "post": { - "description": "Supends operation of the specified Analysis Services server instance.", + "description": "Suspends operation of the specified Analysis Services server instance.", "tags": [ "Servers" ], "operationId": "Servers_Suspend", "parameters": [ @@ -874,7 +874,7 @@ } }, "CheckServerNameAvailabilityResult": { - "description": "The checking result of server name availibility.", + "description": "The checking result of server name availability.", "type": "object", "properties": { "nameAvailable": { diff --git a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json index 966075c22cff..3a55ee7db338 100644 --- a/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json +++ b/specification/analysisservices/resource-manager/Microsoft.AnalysisServices/stable/2017-08-01/analysisservices.json @@ -209,7 +209,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend": { "post": { - "description": "Supends operation of the specified Analysis Services server instance.", + "description": "Suspends operation of the specified Analysis Services server instance.", "x-ms-examples": { "Suspend a server.": { "$ref": "./examples/suspendServer.json" } }, @@ -949,7 +949,7 @@ }, "enablePowerBIService": { "type": "string", - "description": "The indicator of enableing PBI service." + "description": "The indicator of enabling PBI service." } } }, @@ -1051,7 +1051,7 @@ } }, "CheckServerNameAvailabilityResult": { - "description": "The checking result of server name availibility.", + "description": "The checking result of server name availability.", "type": "object", "properties": { "nameAvailable": { From 2aebd7d4001ed36c8dbb9c70a336cd20c099427d Mon Sep 17 00:00:00 2001 From: Deepal Dhariwal Date: Tue, 27 Nov 2018 12:45:27 -0800 Subject: [PATCH 207/464] Add support for List Operation on global reach connections (#4589) * Adds base for updating Microsoft.Network from version stable/2018-08-01 to version 2018-10-01 * Updates readme * Updates API version in new specs and examples * [Networkwatcer] add FlowLogFormatParameters (#4374) * Update specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json [Networkwatcher] add a new field "Format" with new type"FlowLogFormat" to FlowLogProperties * Revert "Update specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/networkWatcher.json" This reverts commit f4f438af5a3d42a21936ecb6d3f661f3fa4a4442. * Update specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/networkWatcher.json [networkwatcer] add FlowLogFormatParameters * [Network wathcer] add a new field trafficAnalyticsInterval for TA (#4420) * Make NIC VM ref readonly (#4443) * Mark private IP address read-only (#4447) * change container nics property type on container nic config to resourceid (#4459) * Port fix from PR 4459 to 2018-10-01 (#4463) * Application Gateway - Adds Rewrite rule set for Header CRUD (#4331) * Adds base for updating Microsoft.Network from version stable/2018-08-01 to version 2018-10-01 * Updates readme * Updates API version in new specs and examples * Adds Rewrite rule set for Header CRUD Adds the structure of rewriteRuleSets in the applicationGatewayProperties. Adds recursively the sub structures in the rewriteRuleSet. Adds the reference to rewriteRuleSet in the requestRoutingRule for both Basic rule and Path based rule. * Adds examples for the Header CRUD in application gateway * Fix the examples; replacing rules with rewriteRules. * Fixing the properties of application Gateway rewriteRule * Revert "Fixing the properties of application Gateway rewriteRule" This reverts commit 05c9c9103af1da0162b6cc0a04c4b37b4360f66c. * Fixing the properties of application Gateway rewriteRule * Mark the provisioning state as readOnly * Mark etag as readOnly * Revert "Model ContainerNic refs under ContainerNicConfig as sub resources" (#4467) * Revert "Application Gateway - Adds Rewrite rule set for Header CRUD (#4331)" This reverts commit 633d12d5b552b102f874182b8f50266eb97fdc85. * Revert "Port fix from PR 4459 to 2018-10-01 (#4463)" This reverts commit 5ea0c7b8bcf16d992bb1f2b5f3b52208354a4391. * Revert "change container nics property type on container nic config to resourceid (#4459)" This reverts commit baf31d901254dd4bf4f1813e9faeec1c9805f775. * Fixes the missing array for the header actions (#4497) * Network py 2018-10 * add package-2018-10 to Go SDK codegen * Application gateway Identity and Keyvault support (#4387) * identity and keyvault * Capitalization comment * Ported fix from master branch (#4547) * Add support for list api for global reach connections * address farhan comment --- .../ExpressRouteCircuitConnectionList.json | 51 ++++++++++++++ .../2018-10-01/expressRouteCircuit.json | 68 +++++++++++++++++++ 2 files changed, 119 insertions(+) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionList.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..27b102a501e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/ExpressRouteCircuitConnectionList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2018-10-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + }, + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSEUR", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState":"Succeeded" + } + } + ] + } + } + } + } \ No newline at end of file diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json index c0baa6dae2a9..c45272011765 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/expressRouteCircuit.json @@ -638,6 +638,58 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections": { + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_List", + "description": "Gets all global reach connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { "$ref": "./examples/ExpressRouteCircuitConnectionList.json" } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { "delete": { "tags": [ @@ -1587,6 +1639,22 @@ ], "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." }, + "ExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The global reach connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, "ExpressRouteCircuitSku": { "properties": { "name": { From c4a2bf2c2b5a294a041e9ddb544e9b6e980a8ef7 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 27 Nov 2018 15:46:00 -0500 Subject: [PATCH 208/464] typo: addons/resource-manager/Microsoft.Addons (#4580) - camonical -> canonical --- .../Microsoft.Addons/preview/2018-03-01/addons-swagger.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json index 730f3b561af3..333d8238eafd 100644 --- a/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json +++ b/specification/addons/resource-manager/Microsoft.Addons/preview/2018-03-01/addons-swagger.json @@ -295,7 +295,7 @@ }, "CanonicalSupportPlanInfoDefinition": { "type": "object", - "description": "Definition object with the properties of a camonical plan", + "description": "Definition object with the properties of a canonical plan", "properties": { "supportPlanType": { "type": "string", From fb32c99ec2c17b61deba0999822f46580a8d21b5 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 27 Nov 2018 15:46:24 -0500 Subject: [PATCH 209/464] typo: devtestlabs/resource-manager/Microsoft.DevTestLab/DTL (#4538) - occured -> occurred - Reponse -> Response - seperated -> separated --- .../Microsoft.DevTestLab/stable/2018-09-15/DTL.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json index cc38601373f2..29bef183f87f 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json @@ -6632,7 +6632,7 @@ "properties": { "error": { "$ref": "#/definitions/CloudErrorBody", - "description": "The cloud error that occured" + "description": "The cloud error that occurred" } }, "x-ms-external": true @@ -7896,7 +7896,7 @@ } }, "GenerateUploadUriResponse": { - "description": "Reponse body for generating an upload URI.", + "description": "Response body for generating an upload URI.", "type": "object", "properties": { "uploadUri": { @@ -9349,7 +9349,7 @@ "type": "string" }, "emailRecipient": { - "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "description": "The email recipient to send notifications to (can be a list of semi-colon separated email addresses).", "type": "string" }, "notificationLocale": { @@ -9392,7 +9392,7 @@ "type": "string" }, "emailRecipient": { - "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "description": "The email recipient to send notifications to (can be a list of semi-colon separated email addresses).", "type": "string" }, "notificationLocale": { @@ -9433,7 +9433,7 @@ "type": "string" }, "emailRecipient": { - "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "description": "The email recipient to send notifications to (can be a list of semi-colon separated email addresses).", "type": "string" }, "notificationLocale": { @@ -9465,7 +9465,7 @@ "type": "string" }, "emailRecipient": { - "description": "The email recipient to send notifications to (can be a list of semi-colon seperated email addresses).", + "description": "The email recipient to send notifications to (can be a list of semi-colon separated email addresses).", "type": "string" }, "notificationLocale": { From 47fdd6b2b174ffe2b0b3fa8d0bdf3515c22b9951 Mon Sep 17 00:00:00 2001 From: vivek-microsoft <32766101+vivek-microsoft@users.noreply.github.com> Date: Wed, 28 Nov 2018 02:19:53 +0530 Subject: [PATCH 210/464] Updating PUT notificationSettings api (#4445) * Moving to Public Repository Moving to Public Repository * moving inside preview folder * updating relative path * Updating readme with code generation instructions Updating readme with code generation instructions * Updating tag Updating tag * adding PUT notificationSettings api * adding example file adding example file for notification settings PUT api * Fix example format * fix validation error * fix validation error * validation error fix * fix validation error * fix example * fix example * fix example * fix example * Removing python sdk instruction from readme.md * Review comments * Deleting temporary file. * Adding examples * review comments * Updating response format * Fixing json format * Restoring Python sdk in readme.md * Updating id in response * manual edit to refer to default parameter --- .../Microsoft.WorkloadMonitor.json | 175 ++++++++++++++++-- .../examples/Components_Get.json | 2 +- .../examples/Components_ListByResource.json | 16 +- .../examples/MonitorInstances_Get.json | 2 +- .../MonitorInstances_ListByResource.json | 124 ++++++------- .../examples/NotificationSettings_Get.json | 24 +++ .../NotificationSettings_ListByResource.json | 14 +- .../examples/NotificationSettings_Update.json | 25 +++ .../resource-manager/readme.md | 5 +- 9 files changed, 292 insertions(+), 95 deletions(-) create mode 100644 specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json create mode 100644 specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json index e41b71a73720..e664776c4327 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json @@ -630,6 +630,149 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings/{notificationSettingName}": { + "get": { + "tags": [ + "WLIExtension" + ], + "summary": "Get a of notification setting for a resource.", + "operationId": "NotificationSettings_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceNamespace", + "in": "path", + "description": "The Namespace of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "The type of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/notificationSettingName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. At least one component found.", + "schema": { + "$ref": "#/definitions/NotificationSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationSettings_Get": { + "$ref": "./examples/NotificationSettings_Get.json" + } + } + }, + "put": { + "tags": [ + "WLIExtension" + ], + "summary": "Update notification settings for a resource.", + "operationId": "NotificationSettings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "resourceNamespace", + "in": "path", + "description": "The Namespace of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "The type of the resource.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/notificationSettingName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "body", + "in": "body", + "description": "Body of the NotificationSetting PUT object.", + "required": true, + "schema": { + "$ref": "#/definitions/NotificationSetting" + } + } + ], + "responses": { + "200": { + "description": "OK. At least one component found.", + "schema": { + "$ref": "#/definitions/NotificationSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "NotificationSettings_Update": { + "$ref": "./examples/NotificationSettings_Update.json" + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary": { "get": { "tags": [ @@ -1446,23 +1589,22 @@ "description": "Model for collection of notificationSettings.", "type": "object", "properties": { - "nextLink": { - "description": "URL to the next set of results.", - "type": "string", - "readOnly": true - }, "value": { - "description": "Collection of components.", "type": "array", "items": { "$ref": "#/definitions/NotificationSetting" - }, + } + }, + "nextLink": { + "description": "URL to the next set of results.", + "type": "string", "readOnly": true } - } + }, + "x-ms-azure-resource": true }, "NotificationSetting": { - "description": "Model for component.", + "description": "Model for NotificationSetting.", "type": "object", "allOf": [ { @@ -1477,7 +1619,7 @@ }, "properties": { "$ref": "#/definitions/NotificationSettingProperties", - "description": "Properties of the component.", + "description": "Properties of Notification Settings", "readOnly": true, "x-ms-client-flatten": true } @@ -1487,7 +1629,7 @@ "description": "Model for properties of a NotificationSetting.", "type": "object", "properties": { - "actionGroups": { + "actionGroupResourceIds": { "description": "List of action group resource ids to be notified", "type": "array", "items": { @@ -1696,6 +1838,17 @@ "type": "string", "format": "uuid", "x-ms-parameter-location": "method" + }, + "notificationSettingName": { + "name": "notificationSettingName", + "in": "path", + "description": "Default string modeled as parameter for URL to work correctly.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json index 1fd37bc11b47..1e74ef7c48ab 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json @@ -35,7 +35,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" } diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json index 4a8ab7faa178..7865bbebab67 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json @@ -59,7 +59,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -111,7 +111,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -163,7 +163,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -215,7 +215,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -267,7 +267,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -319,7 +319,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -371,7 +371,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='05a70c91-2163-d974-638d-2ddda2308153'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='05a70c91-2163-d974-638d-2ddda2308153'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" }, @@ -423,7 +423,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/components/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/components/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad'", "type": "Microsoft.WorkloadMonitor/workloadInsights/components" } diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json index e59e24c29f4b..90504e7415ed 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json @@ -59,7 +59,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" } diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json index c5e670ff255c..c6648079a2f2 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json @@ -60,7 +60,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=052f9b7d-7bf0-7f61-966b-f372e207ef4e'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -113,7 +113,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=b974db31-cf93-9d6b-740a-9f8508b92712'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=b974db31-cf93-9d6b-740a-9f8508b92712'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=b974db31-cf93-9d6b-740a-9f8508b92712'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -166,7 +166,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -219,7 +219,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=c9db5e55-f3c8-7366-6b98-bc727e726a4b'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=c9db5e55-f3c8-7366-6b98-bc727e726a4b'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=c9db5e55-f3c8-7366-6b98-bc727e726a4b'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -272,7 +272,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -325,7 +325,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b787a678-ce4b-c473-b6b4-6e1dbf184a61'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b787a678-ce4b-c473-b6b4-6e1dbf184a61'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b787a678-ce4b-c473-b6b4-6e1dbf184a61'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -378,7 +378,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=9a86ee3f-d133-b183-a400-6ad3a3834c86'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=9a86ee3f-d133-b183-a400-6ad3a3834c86'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=9a86ee3f-d133-b183-a400-6ad3a3834c86'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -431,7 +431,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=6799aaae-533c-9a8d-331f-ea833db85d1d'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=6799aaae-533c-9a8d-331f-ea833db85d1d'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=6799aaae-533c-9a8d-331f-ea833db85d1d'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -484,7 +484,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=75472fe7-e406-32a6-4198-0502ecee1bfe'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=75472fe7-e406-32a6-4198-0502ecee1bfe'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=75472fe7-e406-32a6-4198-0502ecee1bfe'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -537,7 +537,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -590,7 +590,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=887e162a-74f4-2951-64e5-87dd5f076342'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=887e162a-74f4-2951-64e5-87dd5f076342'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=887e162a-74f4-2951-64e5-87dd5f076342'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -643,7 +643,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=a6c69968-61aa-a6b9-db6e-83a0da6110ea'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -696,7 +696,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -749,7 +749,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=3c184dff-8813-38f9-e965-2a9561425180'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=3c184dff-8813-38f9-e965-2a9561425180'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=3c184dff-8813-38f9-e965-2a9561425180'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -802,7 +802,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=4585a2f7-87c5-54e7-2b76-81af1073aec8'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=4585a2f7-87c5-54e7-2b76-81af1073aec8'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=4585a2f7-87c5-54e7-2b76-81af1073aec8'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -855,7 +855,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=37232a87-988f-6256-3033-ea0c102c2d43'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=37232a87-988f-6256-3033-ea0c102c2d43'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=37232a87-988f-6256-3033-ea0c102c2d43'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -908,7 +908,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=50fd1db1-7111-d67e-3f81-e73203d073e3'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=50fd1db1-7111-d67e-3f81-e73203d073e3'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=50fd1db1-7111-d67e-3f81-e73203d073e3'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -961,7 +961,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=41eccc60-5578-2eea-e104-8bf7022ed5af'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=41eccc60-5578-2eea-e104-8bf7022ed5af'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=41eccc60-5578-2eea-e104-8bf7022ed5af'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1014,7 +1014,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e80001dc-3aa8-e5c8-f782-5b4ef144fd5c'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e80001dc-3aa8-e5c8-f782-5b4ef144fd5c'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e80001dc-3aa8-e5c8-f782-5b4ef144fd5c'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1067,7 +1067,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1120,7 +1120,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1173,7 +1173,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1226,7 +1226,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=94df5e8c-989a-f595-86b0-0baba4662bfb'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=94df5e8c-989a-f595-86b0-0baba4662bfb'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=94df5e8c-989a-f595-86b0-0baba4662bfb'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1279,7 +1279,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=33f2143c-d677-6d10-c676-2f2bac54bbbd'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=33f2143c-d677-6d10-c676-2f2bac54bbbd'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=33f2143c-d677-6d10-c676-2f2bac54bbbd'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1332,7 +1332,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1385,7 +1385,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=99dbb2f7-9335-40c1-562e-0bee9e43b029'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1438,7 +1438,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=850400b6-9fd2-d927-bc47-9934dfe28845'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1491,7 +1491,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1544,7 +1544,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1597,7 +1597,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=584e5846-a4a3-a17a-26fd-25014f727ee9'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1650,7 +1650,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=f69b8b3f-3ba6-adf0-cdec-7c01b385d13c'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1703,7 +1703,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=8966cbe8-38d2-57be-5937-3d43e38a3df5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1756,7 +1756,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=07cacb31-615d-5c7a-e118-fd55c17b5a2c'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=07cacb31-615d-5c7a-e118-fd55c17b5a2c'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=07cacb31-615d-5c7a-e118-fd55c17b5a2c'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1809,7 +1809,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=194d2011-69ed-50bb-4d50-a394d48fb048'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=194d2011-69ed-50bb-4d50-a394d48fb048'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=194d2011-69ed-50bb-4d50-a394d48fb048'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1862,7 +1862,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c688a072-2a8f-6409-1895-a0cc363cb326'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1915,7 +1915,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=728733ca-14e2-9ddc-8ec8-5de911bdf35f'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=728733ca-14e2-9ddc-8ec8-5de911bdf35f'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=728733ca-14e2-9ddc-8ec8-5de911bdf35f'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -1968,7 +1968,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=1aa535e9-d09c-3557-297f-62923069ba81'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=1aa535e9-d09c-3557-297f-62923069ba81'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=1aa535e9-d09c-3557-297f-62923069ba81'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2021,7 +2021,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2074,7 +2074,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2127,7 +2127,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2180,7 +2180,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=b12539ea-7122-af29-6af6-0047432bab6a'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=b12539ea-7122-af29-6af6-0047432bab6a'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=b12539ea-7122-af29-6af6-0047432bab6a'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2233,7 +2233,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2286,7 +2286,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=c2396f9e-22eb-9a72-0149-ea3b9a219e64'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2339,7 +2339,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2392,7 +2392,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2445,7 +2445,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2498,7 +2498,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='804fc44e-c49d-58f0-3b03-bf24f7d11663',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2551,7 +2551,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2604,7 +2604,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=062d163a-0742-73d9-1d9d-a582c82127e4'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2657,7 +2657,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=22e3b675-109e-9292-952e-7554604e3605'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2710,7 +2710,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=8a16058b-d31e-c156-3460-2c6cae7bfc49'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=8a16058b-d31e-c156-3460-2c6cae7bfc49'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=8a16058b-d31e-c156-3460-2c6cae7bfc49'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2763,7 +2763,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2816,7 +2816,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b8375781-0835-15b6-c782-f497b54b65ea'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b8375781-0835-15b6-c782-f497b54b65ea'", "name": "ComponentId='06400e6a-6bac-1717-1e0d-e28f31a2e88b',MonitorId=b8375781-0835-15b6-c782-f497b54b65ea'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2869,7 +2869,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='1a526816-f757-7328-d0b2-7daf65fd919b',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2922,7 +2922,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -2975,7 +2975,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='767aea7b-2a28-8c7b-9a61-153eeced9466',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3028,7 +3028,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='ebf38b50-d78a-817b-89ee-0e5870c643ef',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3081,7 +3081,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=7db3eece-fd0d-fddd-3af7-f8371a914874'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3134,7 +3134,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=08ec2bb4-32be-2fae-2d5a-6b65feb200a6'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3187,7 +3187,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='05a70c91-2163-d974-638d-2ddda2308153',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3240,7 +3240,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "name": "ComponentId='3d945642-b98c-37b1-a75c-ee03cdb599ad',MonitorId=e3ab86a1-34fa-35b5-b864-da4db993c0f5'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" }, @@ -3293,7 +3293,7 @@ } }, "etag": null, - "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.WorkloadMonitor/workloadInsights/Canary-WLI-2/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7af5bcb4-31e9-5ec9-268f-178c265a6c2c'", + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/healthInstances/ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7af5bcb4-31e9-5ec9-268f-178c265a6c2c'", "name": "ComponentId='d91ce384-b682-883a-d02b-129bf37f218b',MonitorId=7af5bcb4-31e9-5ec9-268f-178c265a6c2c'", "type": "Microsoft.WorkloadMonitor/workloadInsights/healthInstances" } diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json new file mode 100644 index 000000000000..f3a7d89b4f54 --- /dev/null +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "a7f23fdb-e626-4f95-89aa-3a360a90861e", + "resourceGroupName": "viv_rg", + "resourceNamespace": "Microsoft.Compute", + "resourceType": "virtualMachines", + "resourceName": "Canary-WLI-2", + "notificationSettingName": "default", + "api-version": "2018-08-31-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "actionGroupResourceIds": [] + }, + "etag": null, + "id": "/subscriptions/a7f23fdb-e626-4f95-89aa-3a360a90861e/resourcegroups/viv_rg/providers/Microsoft.Compute/virtualMachines/Canary-WLI-2/providers/Microsoft.WorkloadMonitor/notificationSettings/default", + "name": "default", + "type": "Microsoft.WorkloadMonitor/virtualMachines/notificationSettings" + } + } + } +} \ No newline at end of file diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json index 8f1c388fe849..2ac99f1039bb 100644 --- a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json @@ -10,17 +10,13 @@ "responses": { "200": { "body": { - "value": [ + "value": [ { - "etag": null, "properties": { - "actionGroups": [ - - ] - } - } - ], - "nextLink": null + "actionGroupResourceIds": [] + } + } + ] } } } diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json new file mode 100644 index 000000000000..03397340f7b7 --- /dev/null +++ b/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "a7f23fdb-e626-4f95-89aa-3a360a90861e", + "resourceGroupName": "viv_rg", + "resourceNamespace": "Microsoft.Compute", + "resourceType": "virtualMachines", + "resourceName": "Canary-WLI-2", + "notificationSettingName": "default", + "api-version": "2018-08-31-preview", + "body": { + "properties": { + "actionGroupResourceIds": [ + "/subscriptions/12c5bb75-2c2c-44b1-8d7d-cbf4d12ff5c1/resourceGroups/vgajulaRG/providers/microsoft.insights/actiongroups/wli-we" + ] + } + } + }, + "responses": { + "200": { + "body": { + + } + } + } +} \ No newline at end of file diff --git a/specification/workloadmonitor/resource-manager/readme.md b/specification/workloadmonitor/resource-manager/readme.md index 0df5b6b5f4bc..ce490ee4f4ef 100644 --- a/specification/workloadmonitor/resource-manager/readme.md +++ b/specification/workloadmonitor/resource-manager/readme.md @@ -54,7 +54,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node @@ -75,13 +75,11 @@ csharp: clear-output-folder: true ``` - ## Python These settings apply only when `--python` is specified on the command line. Please also specify `--python-sdks-folder=`. Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - ``` yaml $(python) python-mode: create python: @@ -104,6 +102,7 @@ python: ``` + ## Go These settings apply only when `--go` is specified on the command line. From 5b818ee54698ee80a28d042789345ecca963a492 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Tue, 27 Nov 2018 15:45:43 -0800 Subject: [PATCH 211/464] Add readme.nodejs.md and readme.typescript.md for azure-kusto (#4592) --- .../azure-kusto/resource-manager/readme.nodejs.md | 14 ++++++++++++++ .../resource-manager/readme.typescript.md | 12 ++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 specification/azure-kusto/resource-manager/readme.nodejs.md create mode 100644 specification/azure-kusto/resource-manager/readme.typescript.md diff --git a/specification/azure-kusto/resource-manager/readme.nodejs.md b/specification/azure-kusto/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..98411ab9115e --- /dev/null +++ b/specification/azure-kusto/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-kusto + output-folder: $(node-sdks-folder)/lib/services/kustoManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/azure-kusto/resource-manager/readme.typescript.md b/specification/azure-kusto/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..727fef1297c6 --- /dev/null +++ b/specification/azure-kusto/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-kusto" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-kusto" + generate-metadata: true +``` From 0ffb3490a1a393bc1423dece9003f40dcf226ee2 Mon Sep 17 00:00:00 2001 From: DI QIU Date: Tue, 27 Nov 2018 17:18:22 -0800 Subject: [PATCH 212/464] Update manage service identity api version (#4492) * directly copy swagger folder from old api version * update Managed Service Identity api version to 2018-11-30, the differnt from previous api-version is the clientSecretUrl can be null if identity is user assigned * feedback --- .../2018-11-30/ManagedIdentity.json | 541 ++++++++++++++++++ .../2018-11-30/examples/IdentityCreate.json | 51 ++ .../2018-11-30/examples/IdentityDelete.json | 16 + .../2018-11-30/examples/IdentityGet.json | 27 + .../examples/IdentityListByResourceGroup.json | 31 + .../examples/IdentityListBySubscription.json | 30 + .../2018-11-30/examples/IdentityUpdate.json | 34 ++ .../examples/MsiOperationsList.json | 41 ++ .../msi/resource-manager/readme.go.md | 10 + specification/msi/resource-manager/readme.md | 24 +- .../msi/resource-manager/readme.ruby.md | 11 + 11 files changed, 815 insertions(+), 1 deletion(-) create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json create mode 100644 specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json new file mode 100644 index 000000000000..f6270f362ca6 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json @@ -0,0 +1,541 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-30", + "title": "ManagedServiceIdentityClient", + "description": "The Managed Service Identity Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "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.ManagedIdentity/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.ManagedIdentity provider", + "x-ms-examples": { + "MsiOperationsList": { + "$ref": "./examples/MsiOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListBySubscription", + "description": "Lists all the userAssignedIdentities available under the specified subscription.", + "x-ms-examples": { + "IdentityListBySubscription": { + "$ref": "./examples/IdentityListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities": { + "get": { + "operationId": "UserAssignedIdentities_ListByResourceGroup", + "description": "Lists all the userAssignedIdentities available under the specified ResourceGroup.", + "x-ms-examples": { + "IdentityListByResourceGroup": { + "$ref": "./examples/IdentityListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The list of userAssignedIdentities was retrieved and returned successfully.", + "schema": { + "$ref": "#/definitions/UserAssignedIdentitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resourceName}": { + "put": { + "operationId": "UserAssignedIdentities_CreateOrUpdate", + "description": "Create or update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityCreate": { + "$ref": "./examples/IdentityCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Identity" + }, + "description": "Parameters to create or update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "201": { + "description": "Created identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "UserAssignedIdentities_Update", + "description": "Update an identity in the specified subscription and resource group.", + "x-ms-examples": { + "IdentityUpdate": { + "$ref": "./examples/IdentityUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Identity" + }, + "description": "Parameters to update the identity" + } + ], + "responses": { + "200": { + "description": "Updated identity", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "UserAssignedIdentities_Get", + "description": "Gets the identity.", + "x-ms-examples": { + "IdentityGet": { + "$ref": "./examples/IdentityGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The requested identity.", + "schema": { + "$ref": "#/definitions/Identity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "UserAssignedIdentities_Delete", + "description": "Deletes the identity.", + "x-ms-examples": { + "IdentityDelete": { + "$ref": "./examples/IdentityDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. Deleted Identity." + }, + "204": { + "description": "The specified identity does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Identity": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The id of the created identity." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the created identity." + }, + "location": { + "type": "string", + "description": "The Azure region where the identity lives." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties associated with the identity.", + "$ref": "#/definitions/IdentityProperties" + }, + "type": { + "type": "string", + "readOnly": true, + "enum": [ + "Microsoft.ManagedIdentity/userAssignedIdentities" + ], + "x-ms-enum": { + "name": "UserAssignedIdentities", + "modelAsString": true + }, + "description": "The type of resource i.e. Microsoft.ManagedIdentity/userAssignedIdentities" + } + }, + "x-ms-azure-resource": true, + "description": "Describes an identity resource." + }, + "IdentityProperties": { + "description": "The properties associated with the identity.", + "type": "object", + "title": "Identity properties.", + "properties": { + "tenantId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the tenant which the identity belongs to." + }, + "principalId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the service principal object associated with the created identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "format": "uuid", + "description": "The id of the app associated with the identity. This is a random generated UUID by MSI." + }, + "clientSecretUrl": { + "type": "string", + "readOnly": true, + "description": " The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials. If identity is user assigned, then the clientSecretUrl will not be present in the response, otherwise it will be present." + } + } + }, + "UserAssignedIdentitiesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Identity" + }, + "description": "The collection of userAssignedIdentities returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The url to get the next page of results, if any." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "A list of additional details about the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the ManagedServiceIdentity service." + }, + "Operation": { + "title": "Microsoft.ManagedIdentity Operation.", + "description": "Operation supported by the Microsoft.ManagedIdentity REST API.", + "type": "object", + "properties": { + "name": { + "title": "Operation Name.", + "description": "The name of the REST Operation. This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationDisplay": { + "title": "Operation Display.", + "description": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Resource Provider Name.", + "description": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "Operation Type.", + "description": "The type of operation. For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "Resource Type.", + "description": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "Operation description", + "description": "A description of the operation.", + "type": "string" + } + } + }, + "OperationListResult": { + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "Operations List.", + "description": "A list of operations supported by Microsoft.ManagedIdentity Resource Provider." + }, + "nextLink": { + "type": "string", + "title": "Next Link", + "description": "The url to get the next page of results, if any." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Id of the Subscription to which the identity belongs.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the Resource Group to which the identity belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "description": "The name of the identity resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of API to invoke.", + "required": true, + "type": "string" + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json new file mode 100644 index 000000000000..e2ed2f2a6802 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "cus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json new file mode 100644 index 000000000000..0c3e88fd300b --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": "" + }, + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json new file mode 100644 index 000000000000..650525c833eb --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json new file mode 100644 index 000000000000..7ffbe7111c12 --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json new file mode 100644 index 000000000000..1411eab353ec --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + ], + "nextLink": "https://serviceRoot/subscriptions/subId/providers/Microsoft.ManagedIdentity/userAssignedIdentities?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json new file mode 100644 index 000000000000..041cf354bf8d --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2018-11-30", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "resourceName": "resourceName", + "parameters": { + "location": "cus", + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rgName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName", + "location": "cus", + "name": "identityName", + "properties": { + "clientId": "clientGUID", + "principalId": "identityObjectID", + "tenantId": "tenantGUID" + }, + "tags": { + "key1": "value1", + "key2": "value2" + }, + "type": "Microsoft.ManagedIdentity/userAssignedIdentities" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json new file mode 100644 index 000000000000..f3cdfff0c98c --- /dev/null +++ b/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2018-11-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "display": { + "description": "Gets an existing user assigned identity", + "operation": "Get User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/read" + }, + { + "display": { + "description": "Creates a new user assigned identity or updates the tags associated with an existing user assigned identity", + "operation": "Create/Update User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/write" + }, + { + "display": { + "description": "Deletes an existing user assigned identity", + "operation": "Delete User Assigned Identity", + "resource": "User Assigned Identities", + "provider": "Managed Service Identity" + }, + "name": "Microsoft.ManagedIdentity/userAssignedIdentities/delete" + } + ], + "nextLink": "https://serviceRoot/providers/Microsoft.ManagedIdentity/operations?api-version=2018-11-30&$skiptoken=X'12345'" + } + } + } +} \ No newline at end of file diff --git a/specification/msi/resource-manager/readme.go.md b/specification/msi/resource-manager/readme.go.md index ed9418e0b291..8117e3fba28b 100644 --- a/specification/msi/resource-manager/readme.go.md +++ b/specification/msi/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-11-30 - tag: package-2015-08-31-preview ``` +### Tag: package-2018-11-30 and go + +These settings apply only when `--tag=package-2018-11-30 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11-30' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-11-30/$(namespace) +``` + ### Tag: package-2015-08-31-preview and go These settings apply only when `--tag=package-2015-08-31-preview --go` is specified on the command line. diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index e05ba279f00d..7e63c2f6d6c8 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -22,9 +22,17 @@ These are the global settings for the Managed Service Identity API. ``` yaml openapi-type: arm -tag: package-2015-08-31-preview +tag: package-2018-11-30 ``` +### Tag: package-2018-11-30 + +These settings apply only when `--tag=package-2018-11-30` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-30' +input-file: +- Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json +``` ### Tag: package-2015-08-31-preview @@ -120,9 +128,23 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-msi ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-11-30 - tag: package-2015-08-31-preview ``` +### Tag: package-2018-11-30 and java + +These settings apply only when `--tag=package-2018-11-30 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-11-30' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.managedserviceidentity.v2018-11-30 + output-folder: $(azure-libraries-for-java-folder)/managedserviceidentity/resource-manager/v2018-11-30 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2015-08-31-preview and java These settings apply only when `--tag=package-2015-08-31-preview --java` is specified on the command line. diff --git a/specification/msi/resource-manager/readme.ruby.md b/specification/msi/resource-manager/readme.ruby.md index 37dc383b121c..d510835bb63c 100644 --- a/specification/msi/resource-manager/readme.ruby.md +++ b/specification/msi/resource-manager/readme.ruby.md @@ -12,9 +12,20 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2018-11-30 - tag: package-2015-08-31-preview ``` +### Tag: package-2018-11-30 and ruby + +These settings apply only when `--tag=package-2018-11-30 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-11-30' && $(ruby) +namespace: "Azure::ManagedServiceIdentity::Mgmt::V2018-11-30" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_msi/lib +``` + ### Tag: package-2015-08-31-preview and ruby These settings apply only when `--tag=package-2015-08-31-preview --ruby` is specified on the command line. From 009401731d6571b7ebe422c56c1afbee68d4f072 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 28 Nov 2018 13:27:40 -0500 Subject: [PATCH 213/464] typo: Fix AppServiceCertificateOrders.json (#4502) - Double word "to" - Successully -> Successfully - certitificate -> certificate --- .../stable/2015-08-01/AppServiceCertificateOrders.json | 10 +++++----- .../stable/2018-02-01/AppServiceCertificateOrders.json | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json index 0686c5824d92..5aadb60b62bf 100644 --- a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json @@ -164,7 +164,7 @@ { "name": "certificateDistinguishedName", "in": "body", - "description": "Distinguished name to to use for the certificate order.", + "description": "Distinguished name to use for the certificate order.", "required": true, "schema": { "$ref": "#/definitions/AppServiceCertificateOrder" @@ -220,7 +220,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate order." + "description": "Successfully deleted certificate order." }, "204": { "description": "Certificate order does not exist." @@ -248,7 +248,7 @@ { "name": "certificateDistinguishedName", "in": "body", - "description": "Distinguished name to to use for the certificate order.", + "description": "Distinguished name to use for the certificate order.", "required": true, "schema": { "$ref": "#/definitions/AppServiceCertificateOrderPatchResource" @@ -449,7 +449,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate." + "description": "Successfully deleted certificate." }, "204": { "description": "Certificate does not exist." @@ -1072,7 +1072,7 @@ } }, "AppServiceCertificateOrderCollection": { - "description": "Collection of certitificate orders.", + "description": "Collection of certificate orders.", "required": [ "value" ], diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json index 347d44f9af8f..8952bfecc6d5 100644 --- a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json @@ -182,7 +182,7 @@ { "name": "certificateDistinguishedName", "in": "body", - "description": "Distinguished name to to use for the certificate order.", + "description": "Distinguished name to use for the certificate order.", "required": true, "schema": { "$ref": "#/definitions/AppServiceCertificateOrder" @@ -244,7 +244,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate order." + "description": "Successfully deleted certificate order." }, "204": { "description": "Certificate order does not exist." @@ -272,7 +272,7 @@ { "name": "certificateDistinguishedName", "in": "body", - "description": "Distinguished name to to use for the certificate order.", + "description": "Distinguished name to use for the certificate order.", "required": true, "schema": { "$ref": "#/definitions/AppServiceCertificateOrderPatchResource" @@ -497,7 +497,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate." + "description": "Successfully deleted certificate." }, "204": { "description": "Certificate does not exist." @@ -1144,7 +1144,7 @@ } }, "AppServiceCertificateOrderCollection": { - "description": "Collection of certitificate orders.", + "description": "Collection of certificate orders.", "required": [ "value" ], From 871cf92a2977710f707cee7d4d8e72d03d5d0d79 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 28 Nov 2018 17:12:50 -0500 Subject: [PATCH 214/464] chore: Remove outdated VS files (#4593) The layout doesn't match the repo structure anymore and hasn't been updated in 2 years --- azure-rest-api-specs.njsproj | 558 ----------------------------------- azure-rest-api-specs.sln | 22 -- 2 files changed, 580 deletions(-) delete mode 100644 azure-rest-api-specs.njsproj delete mode 100644 azure-rest-api-specs.sln diff --git a/azure-rest-api-specs.njsproj b/azure-rest-api-specs.njsproj deleted file mode 100644 index 5685e6995bb5..000000000000 --- a/azure-rest-api-specs.njsproj +++ /dev/null @@ -1,558 +0,0 @@ - - - - Debug - 2.0 - {4927d984-a20d-4f8b-aa4a-b1bafd1896e6} - - ShowAllFiles - test\test.js - . - . - {3AF33F2E-1136-4D97-BBB7-1795711AC8B8};{349c5851-65df-11da-9384-00065b846f21};{9092AA53-FB77-4645-B42D-1CCCA6BD08BD} - 14.0 - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Mocha - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - False - True - 0 - / - http://localhost:48022/ - False - True - http://localhost:1337 - False - - - - - - - CurrentPage - True - False - False - False - - - - - - - - - False - False - - - - - \ No newline at end of file diff --git a/azure-rest-api-specs.sln b/azure-rest-api-specs.sln deleted file mode 100644 index 92f4f4a3e5e9..000000000000 --- a/azure-rest-api-specs.sln +++ /dev/null @@ -1,22 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.25420.1 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "azure-rest-api-specs", "azure-rest-api-specs.njsproj", "{4927D984-A20D-4F8B-AA4A-B1BAFD1896E6}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {4927D984-A20D-4F8B-AA4A-B1BAFD1896E6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {4927D984-A20D-4F8B-AA4A-B1BAFD1896E6}.Debug|Any CPU.Build.0 = Debug|Any CPU - {4927D984-A20D-4F8B-AA4A-B1BAFD1896E6}.Release|Any CPU.ActiveCfg = Release|Any CPU - {4927D984-A20D-4F8B-AA4A-B1BAFD1896E6}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection -EndGlobal From d5120f68fe16fa274f9258ccba42a66743e34271 Mon Sep 17 00:00:00 2001 From: BrianBlum Date: Wed, 28 Nov 2018 16:05:23 -0800 Subject: [PATCH 215/464] Updates to the 2018-07-01 version of the MediaServices API (#4483) All enums, use 'modelAsString' instead of 'modelAsExtensible' streamingservice, add "Standard" to LiveEncoding.encodingType encoding, remove top and skip from query parms and add orderby accountfilters and aasetsandassefilters, remove required attribute for PresentationTimeRange properties Updated readme.md to add "opt-in-extensible-enums: true" to csharp build --- .../stable/2018-07-01/AccountFilters.json | 12 +-- .../stable/2018-07-01/Accounts.json | 6 +- .../2018-07-01/AssetsAndAssetFilters.json | 16 +--- .../stable/2018-07-01/ContentKeyPolicies.json | 10 +- .../stable/2018-07-01/Encoding.json | 91 +++++++++++-------- ...StreamingPoliciesAndStreamingLocators.json | 10 +- .../jobs-list-all-filter-by-created.json | 81 +++++++++++++++++ .../jobs-list-all-filter-by-lastmodified.json | 81 +++++++++++++++++ ...obs-list-all-filter-by-name-and-state.json | 49 ++++++++++ .../jobs-list-all-filter-by-name.json | 81 +++++++++++++++++ .../jobs-list-all-filter-by-state-eq.json | 80 ++++++++++++++++ .../jobs-list-all-filter-by-state-ne.json | 80 ++++++++++++++++ ...transforms-list-all-filter-by-created.json | 38 ++++++++ ...forms-list-all-filter-by-lastmodified.json | 38 ++++++++ .../transforms-list-all-filter-by-name.json | 66 ++++++++++++++ .../examples/transforms-list-all.json | 8 +- .../stable/2018-07-01/streamingservice.json | 3 +- .../mediaservices/resource-manager/readme.md | 1 + 18 files changed, 672 insertions(+), 79 deletions(-) create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-created.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-lastmodified.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name-and-state.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-eq.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-ne.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-created.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-lastmodified.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-name.json diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AccountFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AccountFilters.json index 394858b78b72..0113e2c1450a 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AccountFilters.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AccountFilters.json @@ -60,14 +60,6 @@ } }, "type": "object", - "required": [ - "startTimestamp", - "endTimestamp", - "presentationWindowDuration", - "liveBackoffDuration", - "timescale", - "forceEndTimestamp" - ], "description": "The presentation time range, this is asset related and not recommended for Account Filter." }, "FilterTrackPropertyCondition": { @@ -110,7 +102,7 @@ "description": "The bitrate." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The track property type." }, @@ -136,7 +128,7 @@ "description": "The not equal operation." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The track property condition operation." } diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Accounts.json index de3b1611dd08..ed122a0cce52 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Accounts.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Accounts.json @@ -124,7 +124,7 @@ "description": "The number of milliseconds." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The metric unit", "readOnly": true, @@ -153,7 +153,7 @@ "description": "The sum." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The metric aggregation type", "readOnly": true, @@ -277,7 +277,7 @@ "description": "A secondary storage account for the Media Services account." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The type of the storage account." } diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json index 852662a7dbd1..4f54bed9ddb2 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/AssetsAndAssetFilters.json @@ -84,7 +84,7 @@ "description": "The Asset is encrypted with Media Services client-side encryption." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The Asset encryption format. One of None or MediaStorageEncryption.", "readOnly": true, @@ -264,14 +264,6 @@ } }, "type": "object", - "required": [ - "startTimestamp", - "endTimestamp", - "presentationWindowDuration", - "liveBackoffDuration", - "timescale", - "forceEndTimestamp" - ], "description": "The presentation time range, this is asset related and not recommended for Account Filter." }, "FilterTrackPropertyCondition": { @@ -314,7 +306,7 @@ "description": "The bitrate." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The track property type." }, @@ -340,7 +332,7 @@ "description": "The not equal operation." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The track property condition operation." } @@ -498,7 +490,7 @@ "description": "The SAS URL will allow read, write and delete access to the container." } ], - "modelAsExtensible": true + "modelAsString": true } }, "expiryTime": { diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json index 61ae2a86aa25..372adf53c003 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/ContentKeyPolicies.json @@ -152,7 +152,7 @@ "description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Configures Unknown output handling settings of the license." }, @@ -263,7 +263,7 @@ "description": "Persistent license. Allows offline playback." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The license type." }, @@ -299,7 +299,7 @@ "description": "Ultraviolet streaming content type." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The PlayReady content type." } @@ -500,7 +500,7 @@ "description": "JSON Web Token." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The type of token." }, @@ -634,7 +634,7 @@ "description": "Content key can be persisted and the valid duration is limited by the Rental Duration value" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The rental and lease key type." }, diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json index 125127424f5b..abe0b48fd62a 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/Encoding.json @@ -117,7 +117,7 @@ "description": "Specifies that the output audio is to be encoded into HE-AAC v2 profile." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The encoding profile to be used when encoding audio with AAC." } @@ -242,7 +242,7 @@ "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize" } @@ -361,7 +361,7 @@ "description": "Apply bottom field first processing of input video." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The field parity for de-interlacing, defaults to Auto." }, @@ -383,7 +383,7 @@ "description": "Apply automatic pixel adaptive de-interlacing on each frame in the input video." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." } @@ -457,7 +457,7 @@ "description": "Rotate 270 degrees clockwise." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto" }, @@ -588,7 +588,7 @@ "description": "High 4:4:4 predictive profile." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Which profile of the H.264 standard should be used when encoding this layer. Default is Auto." }, @@ -624,7 +624,7 @@ "description": "Context Adaptive Variable Length Coder (CAVLC) entropy encoding." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." } @@ -667,7 +667,7 @@ "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." }, @@ -847,7 +847,7 @@ "description": "Produces a set of 5 GOP-aligned MP4 files, ranging from 1600kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 360p." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The built-in preset to be used for encoding videos." } @@ -919,7 +919,7 @@ "description": "Generate both audio and video insights. Fails if either audio or video Insights fail." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The type of insights to be extracted. If not set then based on the content the type will selected. If the content is audio only then only audio insights are extracted and if it is video only." } @@ -983,7 +983,7 @@ "description": "Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'." }, @@ -1010,7 +1010,7 @@ "description": "Used for TransformOutputs that should take precedence over others." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." }, @@ -1221,7 +1221,7 @@ "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Describes the state of the JobOutput.", "readOnly": true, @@ -1300,7 +1300,7 @@ "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Error code describing the error.", "readOnly": true, @@ -1344,7 +1344,7 @@ "description": "The error is related to data in the input files." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Helps with categorization of errors.", "readOnly": true, @@ -1368,7 +1368,7 @@ "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", "readOnly": true, @@ -1473,7 +1473,7 @@ "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "The current state of the job.", "readOnly": true, @@ -1524,7 +1524,7 @@ "description": "Used for TransformOutputs that should take precedence over others." } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." }, @@ -1670,18 +1670,11 @@ "description": "Restricts the set of items returned." }, { - "name": "$top", + "name": "$orderby", "in": "query", "required": false, - "type": "integer", - "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." } ], "x-ms-pageable": { @@ -1691,6 +1684,15 @@ "x-ms-examples": { "Lists the Transforms": { "$ref": "examples/transforms-list-all.json" + }, + "Lists the Transforms filter by name": { + "$ref": "examples/transforms-list-all-filter-by-name.json" + }, + "Lists the Transforms filter by created": { + "$ref": "examples/transforms-list-all-filter-by-created.json" + }, + "Lists the Transforms filter by lastmodified": { + "$ref": "examples/transforms-list-all-filter-by-lastmodified.json" } } } @@ -1951,18 +1953,11 @@ "description": "Restricts the set of items returned." }, { - "name": "$top", + "name": "$orderby", "in": "query", "required": false, - "type": "integer", - "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." - }, - { - "name": "$skip", - "in": "query", - "required": false, - "type": "integer", - "description": "Specifies a non-negative integer n that excludes the first n items of the queried collection from the result. The service returns items starting at position n+1." + "type": "string", + "description": "Specifies the the key by which the result collection should be ordered." } ], "x-ms-pageable": { @@ -1972,6 +1967,24 @@ "x-ms-examples": { "Lists all of the Jobs for the Transform.": { "$ref": "examples/jobs-list-all.json" + }, + "Lists Jobs for the Transform filter by name.": { + "$ref": "examples/jobs-list-all-filter-by-name.json" + }, + "Lists Jobs for the Transform filter by state equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-eq.json" + }, + "Lists Jobs for the Transform filter by state not equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-ne.json" + }, + "Lists Jobs for the Transform filter by name and state.": { + "$ref": "examples/jobs-list-all-filter-by-name-and-state.json" + }, + "Lists Jobs for the Transform filter by created.": { + "$ref": "examples/jobs-list-all-filter-by-created.json" + }, + "Lists Jobs for the Transform filter by lastmodified.": { + "$ref": "examples/jobs-list-all-filter-by-lastmodified.json" } } } @@ -2147,7 +2160,7 @@ }, "patch": { "summary": "Update Job", - "description": "Updates a Job.", + "description": "Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.", "operationId": "Jobs_Update", "responses": { "200": { diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json index 12f4c598afa2..4c8bb254a538 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/StreamingPoliciesAndStreamingLocators.json @@ -47,7 +47,7 @@ "description": "Track FourCC" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Track property type" }, @@ -69,7 +69,7 @@ "description": "Equal operation" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Track property condition operation" }, @@ -414,7 +414,7 @@ "description": "Envelope Encryption" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Encryption type of Content Key", "readOnly": true, @@ -478,7 +478,7 @@ "description": "Download protocol" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Streaming protocol" }, @@ -510,7 +510,7 @@ "description": "CommonEncryptionCbcs scheme" } ], - "modelAsExtensible": true + "modelAsString": true }, "description": "Encryption scheme" }, diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-created.json new file mode 100644 index 000000000000..395cecb25446 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-created.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/created ge 2018-09-27T22:56:18.5507138Z and properties/created le 2018-09-27T22:56:28.5507138Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-09-27T22:56:18.5507138Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2018-09-27T22:56:18.5507138Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-09-27T22:56:28.5507138Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2018-09-27T22:56:28.5507138Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..f62722d0e0be --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-lastmodified.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/lastmodified ge 2018-09-27T22:56:18.5821662Z and properties/lastmodified le 2018-09-27T22:56:28.5821662Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-09-27T22:56:28.5821662Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2018-09-27T22:56:28.5821662Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2018-09-27T22:56:18.5821662Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2018-09-27T22:56:18.5821662Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name-and-state.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name-and-state.json new file mode 100644 index 000000000000..95975da8908e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name-and-state.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name.json new file mode 100644 index 000000000000..6b082f7e48d2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-name.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job1' or name eq 'job2'", + "$orderby": "name" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-eq.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-eq.json new file mode 100644 index 000000000000..f089816e8da7 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-eq.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state eq Microsoft.Media.JobState'Processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-ne.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-ne.json new file mode 100644 index 000000000000..2fef3a6c39dd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/jobs-list-all-filter-by-state-ne.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state ne Microsoft.Media.JobState'processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job4", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job4", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job4 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "assetName": "job4 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-created.json new file mode 100644 index 000000000000..cf729aa5a250 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-created.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/created gt 2018-09-27T22:56:07.7621546Z and properties/created le 2018-09-27T22:56:17.7621546Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-09-27T22:56:17.7621546-07:00", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2018-09-27T22:56:17.7621546-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..28153774e318 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-lastmodified.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/lastmodified gt 2018-09-27T22:56:07.7840953Z and properties/lastmodified le 2018-09-27T22:56:17.7840953Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-09-27T22:56:17.7840953-07:00", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2018-09-27T22:56:17.7840953-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-name.json new file mode 100644 index 000000000000..84a76f252fb5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all-filter-by-name.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2018-07-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "(name eq 'sampleEncode') or (name eq 'sampleEncodeAndVideoIndex')", + "$orderby": "name desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-09-27T22:56:07.5846087-07:00", + "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", + "lastModified": "2018-09-27T22:56:07.5846087-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + }, + { + "name": "sampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2018-09-27T22:56:07.5846087-07:00", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2018-09-27T22:56:07.5846087-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all.json index 645652fafd00..0b53d7c2160e 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/examples/transforms-list-all.json @@ -14,9 +14,9 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", "type": "Microsoft.Media/mediaservices/transforms", "properties": { - "created": "2018-08-23T15:09:34.2372568-04:00", + "created": "2018-07-26T19:11:48.9717921-07:00", "description": "A sample Transform using the Standard Encoder with a built in preset.", - "lastModified": "2018-08-23T15:09:34.2372568-04:00", + "lastModified": "2018-07-26T19:11:48.9717921-07:00", "outputs": [ { "onError": "StopProcessingJob", @@ -34,9 +34,9 @@ "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", "type": "Microsoft.Media/mediaservices/transforms", "properties": { - "created": "2018-08-23T15:09:34.2422668-04:00", + "created": "2018-07-26T19:11:48.9767793-07:00", "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", - "lastModified": "2018-08-23T15:09:34.2422668-04:00", + "lastModified": "2018-07-26T19:11:48.9767793-07:00", "outputs": [ { "onError": "StopProcessingJob", diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/streamingservice.json index cb6ca579a967..2b14f5aa4000 100644 --- a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/streamingservice.json +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2018-07-01/streamingservice.json @@ -1323,7 +1323,8 @@ "description": "The encoding type for Live Event. This value is specified at creation time and cannot be updated.", "enum": [ "None", - "Basic" + "Basic", + "Standard" ], "x-ms-enum": { "name": "LiveEventEncodingType", diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index d82feeb7b6d7..2e6e552a8d80 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -117,6 +117,7 @@ csharp: namespace: Microsoft.Azure.Management.Media output-folder: $(csharp-sdks-folder)/Media/Management.Media/Generated clear-output-folder: true + opt-in-extensible-enums: true ``` ## Python From 5b763741bfa4963707d48ff9c0034904b918958f Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Thu, 29 Nov 2018 08:55:02 +0800 Subject: [PATCH 216/464] Fix the error The 200 response model for an ARM PUT operation must have x-ms-azure-resource extension set to true in its hierarchy. Operation: 'Tags_CreateOrUpdate' Model: 'TagDetails' (#4600) Merging this Pull request but it might cause breaking changes on some of the SDKs --- .../Microsoft.Resources/stable/2018-05-01/resources.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index 13c788d880ff..1be8d73316af 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -3201,6 +3201,7 @@ "description": "The list of tag values." } }, + "x-ms-azure-resource": true, "description": "Tag details." }, "TagsListResult": { From b7afaf2f256f27c916b16f41aba430f20b265aae Mon Sep 17 00:00:00 2001 From: Sergey Shandar Date: Thu, 29 Nov 2018 09:16:29 -0800 Subject: [PATCH 217/464] OAV 0.9.5 better error handling (#4606) --- package.json | 9 ++++++--- scripts/semanticValidation.js | 7 ++++++- .../stable/2014-01-01/ADHybridHealthService.json | 2 +- 3 files changed, 13 insertions(+), 5 deletions(-) diff --git a/package.json b/package.json index 270c65eef6a1..3c3bc19ff9ec 100644 --- a/package.json +++ b/package.json @@ -13,16 +13,17 @@ "@microsoft.azure/async-io": "^1.0.21", "@microsoft.azure/literate": "^1.0.21", "@microsoft.azure/polyfill": "^1.0.17", + "@ts-common/local-install": "^0.0.7", "fs-extra": "^3.0.1", "glob": "^5.0.14", "js-yaml": "^3.8.2", "json-schema-ref-parser": "^3.1.2", "mocha": "*", "oad": "^0.1.11", - "oav": "^0.8.1", + "oav": "^0.9.5", "request": "^2.61.0", "request-promise-native": "^1.0.5", - "z-schema": "^3.16.1" + "z-schema": "^3.24.2" }, "dependencies": { "@octokit/rest": "^15.2.6" @@ -36,6 +37,8 @@ "url": "http://github.com/azure/azure-rest-api-specs/issues" }, "scripts": { - "test": "mocha -t 500000 --reporter min" + "test": "mocha -t 500000 --reporter min", + "oav": "oav", + "li": "local-install" } } diff --git a/scripts/semanticValidation.js b/scripts/semanticValidation.js index 6c5d8952bc30..afa72694ed62 100644 --- a/scripts/semanticValidation.js +++ b/scripts/semanticValidation.js @@ -13,7 +13,12 @@ async function main() { // return (item.match(/.*Microsoft.Logic.*2016-06-01.*/ig) !== null); // }); for (const swagger of swaggersToProcess) { - await oav.validateSpec(swagger, {consoleLogLevel: 'error', pretty: true}); + try { + await oav.validateSpec(swagger, {consoleLogLevel: 'error', pretty: true}); + } catch (e) { + console.error("error: ") + console.error(e) + } } } diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json index 46e80b072a21..a0d27ff3854d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -3,7 +3,7 @@ "info": { "version": "2014-01-01", "title": "ADHybridHealthService", - "description": "REST APIs for Azure Active Drectory Connect Health" + "description": "REST APIs for Azure Active Directory Connect Health" }, "host": "management.azure.com", "schemes": [ "https" ], From 9585c0c2827232575b192478fe6af0c2cec18ca1 Mon Sep 17 00:00:00 2001 From: Gaurav Bhatnagar Date: Thu, 29 Nov 2018 09:17:27 -0800 Subject: [PATCH 218/464] Adding ARM section to the template (#4569) This will help service teams be better informed about the ARM API review process and add the required labels. --- .github/PULL_REQUEST_TEMPLATE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e453a4fc63bc..dd2afd20e710 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,3 +5,13 @@ - [ ] I have reviewed the [documentation](https://github.com/Azure/azure-rest-api-specs#basics) for the workflow. - [ ] [Validation tools](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/swagger-checklist.md#validation-tools-for-swagger-checklist) were run on swagger spec(s) and have all been fixed in this PR. - [ ] The [OpenAPI Hub](https://aka.ms/openapiportal) was used for checking validation status and next steps. +### ARM API Review Checklist +- [ ] Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories. +- adding/removing APIs. +- adding/removing properties. +- adding/removing API-version. +- adding a new service in Azure. + +Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. +- [ ] If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them. +Please follow the link to find more details on [API review process](https://armwiki.azurewebsites.net/rp_onboarding/ResourceProviderOnboardingAPIRevieworkflow.html). From 2be9ea402e06b2bff52ca3ccfae6beedb40070a7 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Thu, 29 Nov 2018 09:22:00 -0800 Subject: [PATCH 219/464] Add Node.js and JavaScript configuration for sqlvirtualmachine (#4603) --- .../resource-manager/readme.nodejs.md | 14 ++++++++++++++ .../resource-manager/readme.typescript.md | 12 ++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 specification/sqlvirtualmachine/resource-manager/readme.nodejs.md create mode 100644 specification/sqlvirtualmachine/resource-manager/readme.typescript.md diff --git a/specification/sqlvirtualmachine/resource-manager/readme.nodejs.md b/specification/sqlvirtualmachine/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..47a48ae3f045 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-sqlvirtualmachine + output-folder: $(node-sdks-folder)/lib/services/sqlvirtualmachineManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/sqlvirtualmachine/resource-manager/readme.typescript.md b/specification/sqlvirtualmachine/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..d58c02981ba5 --- /dev/null +++ b/specification/sqlvirtualmachine/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-sqlvirtualmachine" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-sqlvirtualmachine" + generate-metadata: true +``` From 8a6943a836b20729eaa0d88c639cc6148c940156 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 29 Nov 2018 13:15:12 -0500 Subject: [PATCH 220/464] typo: Microsoft.Fabric.Admin (#4612) - requestd -> requested - visiblity -> visibility - sftware -> software --- .../Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json | 4 ++-- .../preview/2016-05-01/LogicalSubnet.json | 2 +- .../preview/2016-05-01/SlbMuxInstance.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json index 3189885ea4c9..d91982901b47 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/InfraRole.json @@ -107,14 +107,14 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoles/{infraRole}/Restart": { "post": { "x-ms-examples": { - "Restarts the requestd infrastructure role.": { + "Restarts the requested infrastructure role.": { "$ref": "./examples/InfraRole/Restart.json" } }, "tags": [ "InfraRole" ], - "description": "Restarts the requestd infrastructure role.", + "description": "Restarts the requested infrastructure role.", "operationId": "InfraRoles_Restart", "parameters": [ { diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json index f7bcf35b7644..85c7e7ecead9 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/LogicalSubnet.json @@ -140,7 +140,7 @@ } }, "isPublic": { - "description": "The visiblity status of the IP pool. If is true the associated pools are public IP address pools.", + "description": "The visibility status of the IP pool. If is true the associated pools are public IP address pools.", "type": "boolean" }, "metadata": { diff --git a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json index bb406502dc75..759653110bd4 100644 --- a/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json +++ b/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/SlbMuxInstance.json @@ -19,7 +19,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/slbMuxInstances/{slbMuxInstance}": { "get": { "x-ms-examples": { - "Returns the requested sftware load balancer MUX Instance": { + "Returns the requested software load balancer MUX Instance": { "$ref": "./examples/SlbMuxInstance/Get.json" } }, From dd2a88f3c528ef69fc81123eb4481196a3690b66 Mon Sep 17 00:00:00 2001 From: olrakovs <39234482+olrakovs@users.noreply.github.com> Date: Thu, 29 Nov 2018 20:16:01 +0200 Subject: [PATCH 221/464] Adding new resource type name Forecast to Microsoft.CostManagment RP (#4558) --- .../2018-12-01-preview/costmanagement.json | 350 ++++++++++++++++-- ...Usage.json => BillingAccountForecast.json} | 49 ++- .../examples/BillingAccountQuery.json | 52 +-- .../examples/BillingAccountQueryForecast.json | 110 ------ ....json => BillingAccountQueryGrouping.json} | 0 ...ueryUsage.json => DepartmentForecast.json} | 49 ++- .../examples/DepartmentQuery.json | 45 +-- .../examples/DepartmentQueryForecast.json | 111 ------ ...sage.json => DepartmentQueryGrouping.json} | 0 ...ge.json => EnrollmentAccountForecast.json} | 49 ++- .../examples/EnrollmentAccountQuery.json | 51 +-- .../EnrollmentAccountQueryForecast.json | 98 ----- ...on => EnrollmentAccountQueryGrouping.json} | 0 ...sage.json => ManagementGroupForecast.json} | 49 ++- .../examples/ManagementGroupQuery.json | 49 +-- .../ManagementGroupQueryForecast.json | 97 ----- ...json => ManagementGroupQueryGrouping.json} | 0 ...yUsage.json => ResourceGroupForecast.json} | 28 +- .../examples/ResourceGroupQuery.json | 34 +- .../examples/ResourceGroupQueryForecast.json | 103 ------ .../examples/SubscriptionForecast.json | 124 +++++++ .../examples/SubscriptionQuery.json | 47 +-- .../examples/SubscriptionQueryForecast.json | 82 ---- .../examples/SubscriptionQueryUsage.json | 75 ---- 24 files changed, 646 insertions(+), 1006 deletions(-) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{BillingAccountQueryUsage.json => BillingAccountForecast.json} (67%) delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryForecast.json rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{BillingAccountQueryGroupingUsage.json => BillingAccountQueryGrouping.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{DepartmentQueryUsage.json => DepartmentForecast.json} (67%) delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryForecast.json rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{DepartmentQueryGroupingUsage.json => DepartmentQueryGrouping.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{EnrollmentAccountQueryUsage.json => EnrollmentAccountForecast.json} (64%) delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryForecast.json rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{EnrollmentAccountQueryGroupingUsage.json => EnrollmentAccountQueryGrouping.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{ManagementGroupQueryUsage.json => ManagementGroupForecast.json} (62%) delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryForecast.json rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{ManagementGroupQueryGroupingUsage.json => ManagementGroupQueryGrouping.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/{ResourceGroupQueryUsage.json => ResourceGroupForecast.json} (76%) delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionForecast.json delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryForecast.json delete mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryUsage.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json index a72b04509131..f0d08a3877cb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json @@ -441,12 +441,57 @@ "x-ms-examples": { "SubscriptionQuery": { "$ref": "./examples/SubscriptionQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" }, - "SubscriptionQueryUsage": { - "$ref": "./examples/SubscriptionQueryUsage.json" + { + "$ref": "#/parameters/subscriptionIdParameter" }, - "SubscriptionQueryForecast": { - "$ref": "./examples/SubscriptionQueryForecast.json" + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageBySubscription", + "description": "Forecast the usage data for subscriptionId.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionForecast": { + "$ref": "./examples/SubscriptionForecast.json" } }, "parameters": [ @@ -574,14 +619,63 @@ "x-ms-examples": { "ResourceGroupQuery": { "$ref": "./examples/ResourceGroupQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" }, - "ResourceGroupQueryGroupingUsage": { - "$ref": "./examples/ResourceGroupQueryUsage.json" + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } }, - "ResourceGroupQueryGroupingForecast": { - "$ref": "./examples/ResourceGroupQueryForecast.json" + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } } }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByResourceGroup", + "description": "Forecast the usage data for subscriptionId and resource group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupForecast": { + "$ref": "./examples/ResourceGroupForecast.json" + } + + }, "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -634,16 +728,61 @@ "x-ms-examples": { "BillingAccountQuery": { "$ref": "./examples/BillingAccountQuery.json" - }, - "BillingAccountQueryUsage": { - "$ref": "./examples/BillingAccountQueryUsage.json" }, "BillingAccountQueryGroupingUsage": { - "$ref": "./examples/BillingAccountQueryGroupingUsage.json" + "$ref": "./examples/BillingAccountQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" }, - "BillingAccountQueryForecast": { - "$ref": "./examples/BillingAccountQueryForecast.json" - } + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByBillingAccount", + "description": "Forecast the usage data for billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountForecast": { + "$ref": "./examples/BillingAccountForecast.json" + } }, "parameters": [ { @@ -694,16 +833,64 @@ "x-ms-examples": { "EnrollmentAccountQuery": { "$ref": "./examples/EnrollmentAccountQuery.json" - }, - "EnrollmentAccountQueryUsage": { - "$ref": "./examples/EnrollmentAccountQueryUsage.json" }, "EnrollmentAccountQueryGroupingUsage": { - "$ref": "./examples/EnrollmentAccountQueryGroupingUsage.json" + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" }, - "EnrollmentAccountQueryForecast": { - "$ref": "./examples/EnrollmentAccountQueryForecast.json" - } + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByEnrollmentAccount", + "description": "Forecast the usage data for an enrollment account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "EnrollmentAccountForecast": { + "$ref": "./examples/EnrollmentAccountForecast.json" + } }, "parameters": [ { @@ -757,16 +944,64 @@ "x-ms-examples": { "DepartmentQuery": { "$ref": "./examples/DepartmentQuery.json" - }, - "DepartmentQueryUsage": { - "$ref": "./examples/DepartmentQueryUsage.json" }, "DepartmentQueryGroupingUsage": { - "$ref": "./examples/DepartmentQueryGroupingUsage.json" + "$ref": "./examples/DepartmentQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" }, - "DepartmentQueryForecast": { - "$ref": "./examples/DepartmentQueryForecast.json" - } + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByDepartment", + "description": "Forecast the usage data for department.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DepartmentForecast": { + "$ref": "./examples/DepartmentForecast.json" + } }, "parameters": [ { @@ -820,15 +1055,60 @@ "x-ms-examples": { "ManagementGroupQuery": { "$ref": "./examples/ManagementGroupQuery.json" - }, - "ManagementGroupQueryUsage": { - "$ref": "./examples/ManagementGroupQueryUsage.json" }, "ManagementGroupQueryGroupingUsage": { - "$ref": "./examples/ManagementGroupQueryGroupingUsage.json" + "$ref": "./examples/ManagementGroupQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReportConfigDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Report Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } }, - "ManagementGroupQueryForecast": { - "$ref": "./examples/ManagementGroupQueryForecast.json" + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/Forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_UsageByManagmentGroup", + "description": "Lists the usage data for managment group.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ManagementGroupForecast": { + "$ref": "./examples/ManagementGroupForecast.json" } }, "parameters": [ diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountForecast.json similarity index 67% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountForecast.json index a25ce920278b..e47da91768e7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryUsage.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountForecast.json @@ -58,20 +58,24 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", + "type": "microsoft.costmanagement/Forecast", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Forecast?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" - }, + }, + { + "name": "CostStatus", + "type": "String" + }, { "name": "Currency", "type": "String" @@ -79,20 +83,41 @@ ], "rows": [ [ - 19.545363672276512, - 20180831, + 19.545363672276512, + 20180831, + "Actual", + "USD" + ], + [ + 20.41979233490323, + 20180930, + "Actual", "USD" ], [ - 173.41979241290323, - 20180930, + 21.322216562625452, + 20181031, + "Actual", "USD" ], [ - 20.359416562625452, - 20181031, + 22.545363672276532, + 20180831, + "Actual", "USD" - ] + ], + [ + 23.41979675590323, + 20180930, + "Forecast", + "USD" + ], + [ + 24.359416562626652, + 20181031, + "Forecast", + "USD" + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQuery.json index d3ea12d457dc..a25ce920278b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQuery.json @@ -3,11 +3,11 @@ "api-version": "2018-12-01-preview", "billingAccountId": "70664866", "parameters":{ - "type": "UsageAndForecast", + "type": "Usage", "timeframe": "Custom", "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" }, "dataset": { "granularity": "Daily", @@ -71,15 +71,7 @@ { "name": "UsageDate", "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, + }, { "name": "Currency", "type": "String" @@ -88,47 +80,19 @@ "rows": [ [ 19.545363672276512, - 20181031, - 0, - 0, + 20180831, "USD" ], [ 173.41979241290323, - 20181031, - 0, - 0, + 20180930, "USD" ], [ 20.359416562625452, - 20181031, - 0, - 0, - "USD" - ], - [ - 0, - 20181231, - 9.4567, - 37.9876, - "USD" - ], - [ - 0, - 20181231, - 78.9887, - 316.87654, + 20181031, "USD" - ], - [ - 0, - "Azue Prod Account", - 20181231, - 10.4567, - 40.564433, - "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryForecast.json deleted file mode 100644 index 60f1e92e6982..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryForecast.json +++ /dev/null @@ -1,110 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "billingAccountId": "70664866", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-11-01T00:00:00.000Z", - "to": "2019-01-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "and": [ - { - "or":[ - { - "dimension": { - "name": "SubscriptionName", - "operator": "In", - "values": [ - "Azure Dev", - "Azure Prod", - "Azure PPE" - ] - } - }, - { - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - ] - }, - { - "dimension": { - "name": "DepartmentName", - "operator": "In", - "values": [ - "Azure Dept" - ] - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20181131, - 9.4567, - 37.9876, - "USD" - ], - [ - 20181231, - 78.9887, - 316.87654, - "USD" - ], - [ - 20190131, - 10.4567, - 40.564433, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryGroupingUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryGrouping.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryGroupingUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/BillingAccountQueryGrouping.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentForecast.json similarity index 67% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentForecast.json index 57a9053bedd1..8d2842b87a33 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryUsage.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentForecast.json @@ -59,20 +59,24 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", + "type": "microsoft.costmanagement/Forecast", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" - }, + }, + { + "name": "CostStatus", + "type": "String" + }, { "name": "Currency", "type": "String" @@ -80,20 +84,41 @@ ], "rows": [ [ - 19.545363672276512, - 20181031, + 19.545363672276512, + 20181026, + "Actual", + "USD" + ], + [ + 20.41179241293923, + 20181027, + "Actual", "USD" ], [ - 173.41979241290323, - 20181031, + 21.359416562625452, + 20181028, + "Actual", "USD" ], [ - 20.359416562625452, - 20181031, + 22.545363672276512, + 20181029, + "Forecast", "USD" - ] + ], + [ + 23.41979241290323, + 20181030, + "Forecast", + "USD" + ], + [ + 24.359416562625452, + 20181031, + "Forecast", + "USD" + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQuery.json index 65a77a3aaee2..57a9053bedd1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQuery.json @@ -72,15 +72,7 @@ { "name": "UsageDate", "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, + }, { "name": "Currency", "type": "String" @@ -89,46 +81,19 @@ "rows": [ [ 19.545363672276512, - 20181031, - 0, - 0, + 20181031, "USD" ], [ 173.41979241290323, - 20181031, - 0, - 0, + 20181031, "USD" ], [ 20.359416562625452, - 20181031, - 0, - 0, + 20181031, "USD" - ], - [ - 19.545363672276512, - 20181231, - 9.4567, - 37.9876, - "USD" - ], - [ - 173.41979241290323, - 20181231, - 79.4567, - 437.9876, - "USD" - ], - [ - 20.359416562625452, - 20181231, - 10.24567, - 37.19876, - "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryForecast.json deleted file mode 100644 index 5a3329776bba..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryForecast.json +++ /dev/null @@ -1,111 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "billingAccountId": "70664866", - "departmentId": "123", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-11-01T00:00:00.000Z", - "to": "2019-01-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "and": [ - { - "or":[ - { - "dimension": { - "name": "SubscriptionName", - "operator": "In", - "values": [ - "Azure Dev Subscription", - "Azure Prod Subscription", - "Azure PPE Subscription" - ] - } - }, - { - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - ] - }, - { - "dimension": { - "name": "AccountName", - "operator": "In", - "values": [ - "Azure Account" - ] - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20181131, - 9.4567, - 37.9876, - "USD" - ], - [ - 20181231, - 79.4567, - 437.9876, - "USD" - ], - [ - 20190131, - 10.24567, - 37.19876, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryGroupingUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryGrouping.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryGroupingUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/DepartmentQueryGrouping.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountForecast.json similarity index 64% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountForecast.json index 1dfc1ebdeff8..2857e80970b4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryUsage.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountForecast.json @@ -46,20 +46,24 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", + "type": "microsoft.costmanagement/Forecast", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" - }, + }, + { + "name": "CostStatus", + "type": "String" + }, { "name": "Currency", "type": "String" @@ -67,20 +71,41 @@ ], "rows": [ [ - 19.545363672276512, - 20180831, + 168.545323467227622, + 20180826, + "Actual", + "USD" + ], + [ + 169.41979241290344, + 20180927, + "Actual", + "USD" + ], + [ + 170.359416562338452, + 20181028, + "Actual", + "USD" + ], + [ + 172.545363234276512, + 20180829, + "Forecast", "USD" ], [ - 173.41979241290323, - 20180930, + 173.41979241290323, + 20180930, + "Forecast", "USD" ], [ - 20.359416562625452, - 20181031, + 174.359416562625452, + 20181031, + "Forecast", "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQuery.json index ae1e4c4caff1..1dfc1ebdeff8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQuery.json @@ -7,8 +7,8 @@ "type": "Usage", "timeframe": "Custom", "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-10-31T00:00:00.000Z" }, "dataset": { "granularity": "Daily", @@ -55,19 +55,11 @@ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, + }, { "name": "Currency", "type": "String" @@ -76,46 +68,19 @@ "rows": [ [ 19.545363672276512, - 20181031, - 0, - 0, - "USD" - ], - [ - 173.41979241290323, - 20181031, - 0, - 0, - "USD" - ], - [ - 20.359416562625452, - 20181031, - 0, - 0, - "USD" - ], - [ - 19.545363672276512, - 20181231, - 9.6776786, - 23.7889, + 20180831, "USD" ], [ 173.41979241290323, - 20181231, - 89.5679, - 389.566777, + 20180930, "USD" ], [ 20.359416562625452, - 20181231, - 11.26777655, - 43.64432, + 20181031, "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryForecast.json deleted file mode 100644 index f10b007d89c3..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryForecast.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "billingAccountId": "70664866", - "enrollmentAccountId": "456", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "or":[ - { - "dimension": { - "name": "SubscriptionName", - "operator": "In", - "values": [ - "Azure Dev Subscription", - "Azure Prod Subscription", - "Azure PPE Subscription" - ] - } - }, - { - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20181231, - 9.6776786, - 23.7889, - "USD" - ], - [ - 20181231, - 89.5679, - 389.566777, - "USD" - ], - [ - 20181231, - 11.26777655, - 43.64432, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryGroupingUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryGrouping.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryGroupingUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/EnrollmentAccountQueryGrouping.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupForecast.json similarity index 62% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupForecast.json index 605abffa2f5b..f29b980bf41e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryUsage.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupForecast.json @@ -45,20 +45,24 @@ "body": { "value": [ { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Forecast/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", + "type": "microsoft.costmanagement/Forecast", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Forecast?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" - }, + }, + { + "name": "CostStatus", + "type": "String" + }, { "name": "Currency", "type": "String" @@ -66,20 +70,41 @@ ], "rows": [ [ - 19.545363672276512, - 20181131, + 19.045363672276512, + 20190126, + "Actual", + "USD" + ], + [ + 19.41979241290323, + 20190127, + "Actual", + "USD" + ], + [ + 20.359416562625452, + 20190128, + "Actual", + "USD" + ], + [ + 19.045363672276512, + 20190129, + "Forecast", "USD" ], [ - 173.41979241290323, - 20181231, + 19.41979241290323, + 20190130, + "Forecast", "USD" ], [ - 20.359416562625452, - 20190131, + 20.359416562625452, + 20190131, + "Forecast", "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQuery.json index 4ef611a90d69..605abffa2f5b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQuery.json @@ -6,8 +6,8 @@ "type": "Usage", "timeframe": "Custom", "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" + "from": "2018-11-01T00:00:00.000Z", + "to": "2019-01-31T00:00:00.000Z" }, "dataset": { "granularity": "Daily", @@ -58,15 +58,7 @@ { "name": "UsageDate", "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, + }, { "name": "Currency", "type": "String" @@ -75,46 +67,19 @@ "rows": [ [ 19.545363672276512, - 20181031, - 0, - 0, + 20181131, "USD" ], [ 173.41979241290323, - 20181031, - 0, - 0, + 20181231, "USD" ], [ 20.359416562625452, - 20181031, - 0, - 0, + 20190131, "USD" - ], - [ - 19.545363672276512, - 20181231, - 9.4567, - 37.9876, - "USD" - ], - [ - 173.41979241290323, - 20181231, - 78.9887, - 316.87654, - "USD" - ], - [ - 20.359416562625452, - 20181231, - 10.4567, - 40.564433, - "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryForecast.json deleted file mode 100644 index 38384eb0c2b3..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryForecast.json +++ /dev/null @@ -1,97 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "managementGroupId": "MyMgId", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "or":[ - { - "dimension": { - "name": "SubscriptionName", - "operator": "In", - "values": [ - "Azure Dev", - "Azure Prod", - "Azure PPE" - ] - } - }, - { - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2018-12-01-preview&$skiptoken=AQAAAA%3D%3D", - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20181231, - 9.4567, - 37.9876, - "USD" - ], - [ - 20181231, - 78.9887, - 316.87654, - "USD" - ], - [ - 20181231, - 10.4567, - 40.564433, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryGroupingUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryGrouping.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryGroupingUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ManagementGroupQueryGrouping.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupForecast.json similarity index 76% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryUsage.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupForecast.json index ef7aefedfdfd..137391629751 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryUsage.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupForecast.json @@ -53,20 +53,24 @@ "body": { "value": [ { - "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Forecast/9af9459d-441d-4055-9ed0-83d4c4a363fb", "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", - "type": "microsoft.costmanagement/Query", + "type": "microsoft.costmanagement/Forecast", "properties": { "nextLink": null, "columns": [ { "name": "PreTaxCost", "type": "Number" - }, + }, { "name": "UsageDate", "type": "Number" }, + { + "name": "CostStatus", + "type": "String" + }, { "name": "Currency", "type": "String" @@ -74,13 +78,27 @@ ], "rows": [ [ - 2.10333307059661, + 19.10333307059661, 20180417, + "Actual", "USD" ], [ - 20.10333307059661, + 20.10333307059661, 20180418, + "Actual", + "USD" + ], + [ + 21.10333307059661, + 20180419, + "Forecast", + "USD" + ], + [ + 22.10333307059661, + 20180420, + "Forecast", "USD" ] ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQuery.json index 007a4cf7e265..ef7aefedfdfd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQuery.json @@ -4,12 +4,8 @@ "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", "resourceGroupName": "ScreenSharingTest-peer", "parameters":{ - "type": "UsageAndForecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2019-12-31T00:00:00.000Z" - }, + "type": "Usage", + "timeframe": "MonthToDate", "dataset": { "granularity": "Daily", "filter":{ @@ -71,14 +67,6 @@ "name": "UsageDate", "type": "Number" }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, { "name": "Currency", "type": "String" @@ -88,29 +76,11 @@ [ 2.10333307059661, 20180417, - 0, - 0, "USD" ], [ 20.10333307059661, 20180418, - 0, - 0, - "USD" - ], - [ - 0, - 20190417, - 1.2087, - 4.35788, - "USD" - ], - [ - 0, - 20190418, - 10.44657, - 43.565767, "USD" ] ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryForecast.json deleted file mode 100644 index 5497057f5b8a..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/ResourceGroupQueryForecast.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", - "resourceGroupName": "ScreenSharingTest-peer", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2019-10-01T00:00:00.000Z", - "to": "2019-12-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "and": [ - { - "or":[ - { - "dimension": { - "name": "ResourceLocation", - "operator": "In", - "values": [ - "East US", - "West Europe" - ] - } - }, - { - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "UAT", - "Prod" - ] - } - } - ] - }, - { - "dimension": { - "name": "ResourceGroup", - "operator": "In", - "values": [ - "API" - ] - } - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", - "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": null, - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20190417, - 545.33555, - 1000.434344, - "USD" - ], - [ - 20190418, - 344.5677, - 789.7666, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionForecast.json new file mode 100644 index 000000000000..5616d3b57ffb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionForecast.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "parameters":{ + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2018-10-01T00:00:00.000Z", + "to": "2018-12-31T00:00:00.000Z" + }, + "dataset": { + "granularity": "Daily", + "filter":{ + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "Dev", + "PPE", + "Prod" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Forecast/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Forecast", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 214.68795741935486, + 20181222, + "Actual", + "USD" + ], + [ + 215.68795741935486, + 20181223, + "Actual", + "USD" + ], + [ + 216.68795741935486, + 20181224, + "Actual", + "USD" + ], + [ + 217.68795741935486, + 20181225, + "Actual", + "USD" + ], + [ + 218.68795741935486, + 20181226, + "Actual", + "USD" + ], + [ + 219.143849143581657052, + 20181227, + "Actual", + "USD" + ], + [ + 220.143849143588766052, + 20181228, + "Forecast", + "USD" + ], + [ + 221.143433143588766052, + 20181229, + "Forecast", + "USD" + ], + [ + 222.143433555588766052, + 20181230, + "Forecast", + "USD" + ], + [ + 223.143433555588743252, + 20181231, + "Forecast", + "USD" + ] + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQuery.json index ac26dc88e042..6847e8584028 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQuery.json @@ -3,7 +3,7 @@ "api-version": "2018-12-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "parameters":{ - "type": "UsageAndForecast", + "type": "Usage", "timeframe": "Custom", "timePeriod": { "from": "2018-10-01T00:00:00.000Z", @@ -43,15 +43,7 @@ { "name": "UsageDate", "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, + }, { "name": "Currency", "type": "String" @@ -60,46 +52,19 @@ "rows": [ [ 2.10333307059661, - 20181017, - 0, - 0, + 20181017, "USD" ], [ 218.68795741935486, - 20181018, - 0, - 0, + 20181018, "USD" ], [ 0.14384913581657052, - 20181019, - 0, - 0, - "USD" - ], - [ - 0, - 20181217, - 1.67777, - 5.9787, - "USD" - ], - [ - 0, - 20181218, - 102.78787, - 456.976554, - "USD" - ], - [ - 0, - 20181219, - 0.07233, - 0.287766, + 20181019, "USD" - ] + ] ] } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryForecast.json deleted file mode 100644 index 9294ae12287f..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryForecast.json +++ /dev/null @@ -1,82 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "parameters":{ - "type": "Forecast", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", - "name": "55312978-ba1b-415c-9304-cfd9c43c0481", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": null, - "columns": [ - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "ConfidenceLevelsLower", - "type": "String" - }, - { - "name": "ConfidenceLevelsUpper", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 20181217, - 1.67777, - 5.9787, - "USD" - ], - [ - 20181218, - 102.78787, - 456.976554, - "USD" - ], - [ - 20181219, - 0.07233, - 0.287766, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryUsage.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryUsage.json deleted file mode 100644 index 6847e8584028..000000000000 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/examples/SubscriptionQueryUsage.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "api-version": "2018-12-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "parameters":{ - "type": "Usage", - "timeframe": "Custom", - "timePeriod": { - "from": "2018-10-01T00:00:00.000Z", - "to": "2018-12-31T00:00:00.000Z" - }, - "dataset": { - "granularity": "Daily", - "filter":{ - "tag": { - "name": "Environment", - "operator": "In", - "values": [ - "Dev", - "PPE", - "Prod" - ] - } - } - } - } - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", - "name": "55312978-ba1b-415c-9304-cfd9c43c0481", - "type": "microsoft.costmanagement/Query", - "properties": { - "nextLink": null, - "columns": [ - { - "name": "PreTaxCost", - "type": "Number" - }, - { - "name": "UsageDate", - "type": "Number" - }, - { - "name": "Currency", - "type": "String" - } - ], - "rows": [ - [ - 2.10333307059661, - 20181017, - "USD" - ], - [ - 218.68795741935486, - 20181018, - "USD" - ], - [ - 0.14384913581657052, - 20181019, - "USD" - ] - ] - } - } - ] - } - } - } -} \ No newline at end of file From a2fb5b72d7e65d2d4f254a28f796d1f124f3085a Mon Sep 17 00:00:00 2001 From: Eric Dettinger Date: Thu, 29 Nov 2018 11:00:47 -0800 Subject: [PATCH 222/464] Add a new preview api-version for Time Series Insights (#4599) * Fix or suppress spec violations Fix R2016 by making PATCH body properties optional. Suppress the remaining 4 violations that are confirmed as false positives. * Try removing 2nd top-level heading, which _may_ have been causing a linter warning. * Fix extra indention which prevented linter from running. * Added dataStringComparisonBehavior parameter to reference data put/update spec. * Fixed grammar. * adding partitionkeyProperty to environmentInfo * changing property name * changing modelAsString * Initial checkin of spec. Unchanged from GA release other than version. * Remove .orig files * Fix validation error by removing IoTHub ES from List ES example response * Add extra example that was missing from preview spec. * Add long-term environment to resource hierarchy, and update examples. * Switch to model-as-string for enums. Restore EnvironmentResource's inheritance from TrackedResource. * Upsate sku description * Add new TSI preview api-version to readme.md. * Add suppressions for false-positive linter failures. * Test suppression failures * Adding preview package tag to several other places in readme.md * Add preview package to the readme.go.md file * Remove invalid required property from EnvironmentCreateOrUpdateParameters --- .../examples/AccessPoliciesCreate.json | 42 + .../examples/AccessPoliciesDelete.json | 13 + .../examples/AccessPoliciesGet.json | 23 + .../AccessPoliciesListByEnvironment.json | 26 + .../examples/AccessPoliciesPatchRoles.json | 28 + .../examples/EnvironmentsCreate.json | 66 + .../examples/EnvironmentsDelete.json | 12 + .../examples/EnvironmentsGet.json | 35 + .../examples/EnvironmentsGetExpandStatus.json | 44 + .../EnvironmentsListByResourceGroup.json | 32 + .../EnvironmentsListBySubscription.json | 31 + .../EnvironmentsPatchSkuCapacity.json | 35 + .../examples/EnvironmentsStatusGet.json | 20 + .../examples/EventSourcesCreateEventHub.json | 62 + .../examples/EventSourcesCreateIoTHub.json | 59 + .../examples/EventSourcesDelete.json | 13 + .../examples/EventSourcesGet.json | 30 + .../examples/EventSourcesGetEventHub.json | 30 + .../examples/EventSourcesGetIoTHub.json | 29 + .../EventSourcesListByEnvironment.json | 33 + .../examples/EventSourcesPatchTags.json | 34 + ...ventSourcesPatchTimestampPropertyName.json | 36 + .../examples/Operation_List.json | 130 + .../examples/ReferenceDataSetsCreate.json | 72 + .../examples/ReferenceDataSetsDelete.json | 13 + .../examples/ReferenceDataSetsGet.json | 34 + .../ReferenceDataSetsListByEnvironment.json | 37 + .../examples/ReferenceDataSetsPatchTags.json | 37 + .../timeseriesinsights.json | 2402 +++++++++++++++++ .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.md | 29 +- 31 files changed, 3495 insertions(+), 2 deletions(-) create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesPatchRoles.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGetExpandStatus.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListByResourceGroup.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListBySubscription.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsPatchSkuCapacity.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsStatusGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateEventHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateIoTHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetEventHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetIoTHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTags.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTimestampPropertyName.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/Operation_List.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsPatchTags.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesCreate.json new file mode 100644 index 000000000000..df11a732d205 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesCreate.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "parameters": { + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesDelete.json new file mode 100644 index 000000000000..e2423912af97 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesGet.json new file mode 100644 index 000000000000..82fefa1074be --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesListByEnvironment.json new file mode 100644 index 000000000000..cd8af78c4a01 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesListByEnvironment.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesPatchRoles.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesPatchRoles.json new file mode 100644 index 000000000000..074d5c19fb39 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/AccessPoliciesPatchRoles.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "accessPolicyUpdateParameters": { + "properties": { + "roles": [ "Reader", "Contributor" ] + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ "Reader" ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsCreate.json new file mode 100644 index 000000000000..6cc42c178c74 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "parameters": { + "location": "West US", + "kind": "Standard", + "sku": { + "name": "S1", + "capacity": 1 + }, + "properties": { + "dataRetentionTime": "P31D", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Creating", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "404": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsDelete.json new file mode 100644 index 000000000000..334a2039d6d4 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGet.json new file mode 100644 index 000000000000..aa5d33f8f7d8 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGetExpandStatus.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGetExpandStatus.json new file mode 100644 index 000000000000..7fd36b2a6af8 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsGetExpandStatus.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2018-08-15-preview5", + "$expand": "status" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "storageLimitExceededBehavior": "PurgeOldData", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ], + "dataAccessId": "", + "dataAccessFqdn": "", + "status": { + "ingress": { + "state": "Running" + } + } + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListByResourceGroup.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListByResourceGroup.json new file mode 100644 index 000000000000..a01b5d89a9fb --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListBySubscription.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListBySubscription.json new file mode 100644 index 000000000000..e85e4f3753fd --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsPatchSkuCapacity.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsPatchSkuCapacity.json new file mode 100644 index 000000000000..8e1dd380b48a --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsPatchSkuCapacity.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "environmentUpdateParameters": { + "sku": { + "name": "S1", + "capacity": 10 + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Standard", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 10 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsStatusGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsStatusGet.json new file mode 100644 index 000000000000..9d446631de7a --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EnvironmentsStatusGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "provisioningState": "Succeeded", + "ingress": { + "state": "Running" + } + } + } + } +} + + \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateEventHub.json new file mode 100644 index 000000000000..fd2fc91cb000 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateEventHub.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty" + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateIoTHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateIoTHub.json new file mode 100644 index 000000000000..5047894b4496 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesCreateIoTHub.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.IoTHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "consumerGroupName": "cgn", + "iotHubName": "iothn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty" + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.IoTHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "consumerGroupName": "cgn", + "iotHubName": "iothn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.IoTHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "consumerGroupName": "cgn", + "iotHubName": "iothn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesDelete.json new file mode 100644 index 000000000000..af19f743d71e --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGet.json new file mode 100644 index 000000000000..557d6e2f7641 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetEventHub.json new file mode 100644 index 000000000000..557d6e2f7641 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetEventHub.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetIoTHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetIoTHub.json new file mode 100644 index 000000000000..ee493d1325f2 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesGetIoTHub.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.IoTHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "consumerGroupName": "cgn", + "iotHubName": "iothn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesListByEnvironment.json new file mode 100644 index 000000000000..6c856aaf637a --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesListByEnvironment.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTags.json new file mode 100644 index 000000000000..d31fb852eea2 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTags.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "eventSourceUpdateParameters": { + "tags": { "someKey": "someValue" } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": { "someKey": "someValue" }, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "timestampPropertyName": "someOtherTimestampProperty" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTimestampPropertyName.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTimestampPropertyName.json new file mode 100644 index 000000000000..41eff87f051b --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/EventSourcesPatchTimestampPropertyName.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "eventSourceUpdateParameters": { + "properties": { + "timestampPropertyName": "someOtherTimestampProperty" + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "timestampPropertyName": "someOtherTimestampProperty" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/Operation_List.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/Operation_List.json new file mode 100644 index 000000000000..f9c9a47fde7a --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/Operation_List.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.TimeSeriesInsights/register/action", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Time Series Insights Resource Provider", + "operation": "Registers the Time Series Insights Resource Provider", + "description": "Registers the subscription for the Time Series Insights resource provider and enables the creation of Time Series Insights environments." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Read Environment", + "description": "Get the properties of an environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Create or Update Environment", + "description": "Creates a new environment, or updates an existing environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Delete Environment", + "description": "Deletes the environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Read Event Source", + "description": "Get the properties of an event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Create or Update Event Source", + "description": "Creates a new event source for an environment, or updates an existing event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Delete Event Source", + "description": "Deletes the event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Read Reference Data Set", + "description": "Get the properties of a reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Create or Update Reference Data Set", + "description": "Creates a new reference data set for an environment, or updates an existing reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Delete Reference Data Set", + "description": "Deletes the reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Read Access Policy", + "description": "Get the properties of an access policy." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Create or Update Access Policy", + "description": "Creates a new access policy for an environment, or updates an existing access policy." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Delete Access Policy", + "description": "Deletes the access policy." + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsCreate.json new file mode 100644 index 000000000000..26cb825ea353 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsCreate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "parameters": { + "location": "West US", + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ] + } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsDelete.json new file mode 100644 index 000000000000..7ec7b0457e3c --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsGet.json new file mode 100644 index 000000000000..86cfb7fb24ea --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsListByEnvironment.json new file mode 100644 index 000000000000..713863e531e9 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsListByEnvironment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsPatchTags.json new file mode 100644 index 000000000000..586ec38ca0ce --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/examples/ReferenceDataSetsPatchTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "referenceDataSetUpdateParameters": { + "tags": { "someKey": "someValue" } + }, + "api-version": "2018-08-15-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": { "someKey": "someValue" }, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json new file mode 100644 index 000000000000..9e8f3dc6aeda --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json @@ -0,0 +1,2402 @@ +{ + "swagger": "2.0", + "info": { + "title": "TimeSeriesInsightsClient", + "description": "Time Series Insights client", + "version": "2018-08-15-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.TimeSeriesInsights/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Time Series Insights related operations.", + "x-ms-examples": { + "List available operations for the Time Series Insights resource provider": { "$ref": "./examples/Operation_List.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}": { + "put": { + "tags": [ + "Environments" + ], + "operationId": "Environments_CreateOrUpdate", + "x-ms-examples": { + "EnvironmentsCreate": { "$ref": "./examples/EnvironmentsCreate.json" } + }, + "x-ms-long-running-operation": true, + "description": "Create or update an environment in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the environment" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + }, + "description": "Parameters for creating an environment resource." + } + ], + "responses": { + "200": { + "description": "The existing environment definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "201": { + "description": "The environment create request was accepted. Environment provisioning is an asynchroneous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "404": { + "description": "The subscription or resource group could not be found." + }, + "default": { + "description": "HTTP 400 (Bad Request): The given environment request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Get", + "x-ms-examples": { + "EnvironmentsGet": { "$ref": "./examples/EnvironmentsGet.json" } + }, + "description": "Gets the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Update", + "x-ms-examples": { + "EnvironmentsUpdate": { "$ref": "./examples/EnvironmentsPatchSkuCapacity.json" } + }, + "x-ms-long-running-operation": true, + "description": "Updates the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "environmentUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdateParameters" + }, + "description": "Request object that contains the updated information for the environment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchroneously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchroneously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Delete", + "x-ms-examples": { + "EnvironmentsDelete": { "$ref": "./examples/EnvironmentsDelete.json" } + }, + "description": "Deletes the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment was successfully deleted." + }, + "204": { + "description": "The environment was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListByResourceGroup", + "x-ms-examples": { + "EnvironmentsByResourceGroup": { "$ref": "./examples/EnvironmentsListByResourceGroup.json" } + }, + "description": "Lists all the available environments associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, or resource group could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListBySubscription", + "x-ms-examples": { + "EnvironmentsBySubscription": { "$ref": "./examples/EnvironmentsListBySubscription.json" } + }, + "description": "Lists all the available environments within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}": { + "put": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_CreateOrUpdate", + "x-ms-examples": { + "CreateEventHubEventSource": { "$ref": "./examples/EventSourcesCreateEventHub.json" } + }, + "description": "Create or update an event source under the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the event source." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + }, + "description": "Parameters for creating an event source resource." + } + ], + "responses": { + "200": { + "description": "The existing event source definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "201": { + "description": "The event source was successfully created.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given event source request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Get", + "x-ms-examples": { + "GetEventHubEventSource": { "$ref": "./examples/EventSourcesGetEventHub.json" } + }, + "description": "Gets the event source with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Update", + "x-ms-examples": { + "UpdateEventSource": { "$ref": "./examples/EventSourcesPatchTags.json" } + }, + "description": "Updates the event source with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "eventSourceUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceUpdateParameters" + }, + "description": "Request object that contains the updated information for the event source." + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Delete", + "x-ms-examples": { + "DeleteEventSource": { "$ref": "./examples/EventSourcesDelete.json" } + }, + "description": "Deletes the event source with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source was successfully deleted." + }, + "204": { + "description": "The event source was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources": { + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_ListByEnvironment", + "x-ms-examples": { + "ListEventSourcesByEnvironment": { "$ref": "./examples/EventSourcesListByEnvironment.json" } + }, + "description": "Lists all the available event sources associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EventSourceListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}": { + "put": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_CreateOrUpdate", + "x-ms-examples": { + "ReferenceDataSetsCreate": { "$ref": "./examples/ReferenceDataSetsCreate.json" } + }, + "description": "Create or update a reference data set in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]", + "minLength": 3, + "maxLength": 63, + "description": "Name of the reference data set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetCreateOrUpdateParameters" + }, + "description": "Parameters for creating a reference data set." + } + ], + "responses": { + "200": { + "description": "The existing reference data set definition was successfully updated.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "201": { + "description": "The reference data set was successfully created.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given reference data set request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Get", + "x-ms-examples": { + "ReferenceDataSetsGet": { "$ref": "./examples/ReferenceDataSetsGet.json" } + }, + "description": "Gets the reference data set with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Update", + "x-ms-examples": { + "ReferenceDataSetsUpdate": { "$ref": "./examples/ReferenceDataSetsPatchTags.json" } + }, + "description": "Updates the reference data set with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "referenceDataSetUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetUpdateParameters" + }, + "description": "Request object that contains the updated information for the reference data set." + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Delete", + "x-ms-examples": { + "ReferenceDataSetsDelete": { "$ref": "./examples/ReferenceDataSetsDelete.json" } + }, + "description": "Deletes the reference data set with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set was successfully deleted." + }, + "204": { + "description": "The reference data set was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets": { + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_ListByEnvironment", + "x-ms-examples": { + "ReferenceDataSetsListByEnvironment": { "$ref": "./examples/ReferenceDataSetsListByEnvironment.json" } + }, + "description": "Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Reference data sets returned successfully.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies/{accessPolicyName}": { + "put": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_CreateOrUpdate", + "x-ms-examples": { + "AccessPoliciesCreate": { "$ref": "./examples/AccessPoliciesCreate.json" } + }, + "description": "Create or update an access policy in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the access policy." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyCreateOrUpdateParameters" + }, + "description": "Parameters for creating an access policy." + } + ], + "responses": { + "200": { + "description": "The existing access policy definition was successfully updated.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "201": { + "description": "The access policy was successfully created.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given access policy request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Get", + "x-ms-examples": { + "AccessPoliciesGet": { "$ref": "./examples/AccessPoliciesGet.json" } + }, + "description": "Gets the access policy with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Update", + "x-ms-examples": { + "AccessPoliciesUpdate": { "$ref": "./examples/AccessPoliciesPatchRoles.json" } + }, + "description": "Updates the access policy with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "accessPolicyUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyUpdateParameters" + }, + "description": "Request object that contains the updated information for the access policy." + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Delete", + "x-ms-examples": { + "AccessPoliciesDelete": { "$ref": "./examples/AccessPoliciesDelete.json" } + }, + "description": "Deletes the access policy with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy was successfully deleted." + }, + "204": { + "description": "The access policy was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies": { + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_ListByEnvironment", + "x-ms-examples": { + "AccessPoliciesByEnvironment": { "$ref": "./examples/AccessPoliciesListByEnvironment.json" } + }, + "description": "Lists all the available access policies associated with the environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "access policies returned successfully.", + "schema": { + "$ref": "#/definitions/AccessPolicyListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Time Series Insights REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Time Series Insights resource", + "x-ms-azure-resource": true + }, + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ "read", "create" ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "location" + ], + "description": "Time Series Insights resource that is tracked by Azure Resource Manager." + }, + "ResourceProperties": { + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource." + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the resource was created." + } + }, + "description": "Properties that are common to all tracked resources." + }, + "ProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this SKU.", + "enum": [ + "S1", + "S2", + "L1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The capacity of the sku. For standard environments, this value can be changed to support scale out of environments after they have been created.", + "minimum": 1, + "maximum": 10 + } + }, + "required": [ + "name", + "capacity" + ], + "description": "The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "LongTermStorageConfigurationInput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's long term data." + }, + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "accountName", + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "LongTermStorageConfigurationOutput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's long term data." + } + }, + "required": [ + "accountName" + ], + "description": "The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data." + }, + "LongTermStorageConfigurationMutableProperties": { + "type": "object", + "properties": { + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "CreateOrUpdateTrackedResourceProperties": { + "properties": { + "location": { + "type": "string", + "description": "The location of the resource.", + "x-ms-mutability": [ "read", "create" ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the resource." + } + }, + "required": [ + "location" + ], + "description": "Properties required to create any resource tracked by Azure Resource Manager." + }, + "EnvironmentCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Standard", + "LongTerm" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the CreateOrUpdate Environment operation." + }, + "StandardEnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Standard", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StandardEnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a standard environment." + }, + "LongTermEnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "LongTerm", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LongTermEnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a long-term environment." + }, + "EnvironmentUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the environment." + } + }, + "description": "Parameters supplied to the Update Environment operation." + }, + "StandardEnvironmentUpdateParameters": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the environment." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StandardEnvironmentMutableProperties", + "description": "Properties of the standard environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a standard environment." + }, + "LongTermEnvironmentUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LongTermEnvironmentMutableProperties", + "description": "Properties of the long-term environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a long-term environment." + }, + "EnvironmentListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentResource" + }, + "description": "Result of the List Environments operation." + } + }, + "description": "The response of the List Environments operation." + }, + "EnvironmentResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either standard (S1 or S2) or long-term (L1). For standard environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Standard", + "LongTerm" + ] + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource." + }, + "StandardEnvironmentResource": { + "x-ms-discriminator-value": "Standard", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StandardEnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource. Standard environments have data retention limits." + }, + "LongTermEnvironmentResource": { + "x-ms-discriminator-value": "LongTerm", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LongTermEnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource. LongTerm environments do not have set data retention limits." + }, + "StandardEnvironmentCreationProperties": { + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ "PurgeOldData", "PauseIngress" ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment." + } + }, + "required": [ + "dataRetentionTime" + ], + "description": "Properties used to create a standard environment." + }, + "LongTermEnvironmentCreationProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/LongTermStorageConfigurationInput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "description": "Properties used to create a long-term environment." + }, + "EnvironmentResourceProperties": { + "properties": { + "dataAccessId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "dataAccessFqdn": { + "readOnly": true, + "type": "string", + "description": "The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "status": { + "$ref": "#/definitions/EnvironmentStatus", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the environment." + }, + "StandardEnvironmentResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/StandardEnvironmentCreationProperties" + }, + { + "$ref": "#/definitions/EnvironmentResourceProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "required": [ + "dataRetentionTime" + ], + "description": "Properties of the standard environment." + }, + "LongTermEnvironmentResourceProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/LongTermStorageConfigurationOutput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResourceProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the long-term environment." + }, + "StandardEnvironmentMutableProperties": { + "description": "An object that represents a set of mutable standard environment resource properties.", + "type": "object", + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ "PurgeOldData", "PauseIngress" ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment." + } + } + }, + "LongTermEnvironmentMutableProperties": { + "description": "An object that represents a set of mutable long-term environment resource properties.", + "type": "object", + "properties": { + "storageConfiguration": { + "$ref": "#/definitions/LongTermStorageConfigurationMutableProperties", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment." + } + } + }, + "TimeSeriesIdProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the property." + }, + "type": { + "type": "string", + "description": "The type of the property.", + "enum": [ + "String" + ], + "x-ms-enum": { + "name": "PropertyType", + "modelAsString": true + } + } + }, + "description": "The structure of the property that a time series id can have. An environment can have multiple such properties." + }, + "EnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service.", + "properties": { + "ingress": { + "$ref": "#/definitions/IngressEnvironmentStatus", + "description": "An object that represents the status of ingress on an environment." + } + } + }, + "IngressEnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of ingress on an environment.", + "properties": { + "state": { + "type": "string", + "description": "This string represents the state of ingress operations on an environment. It can be \"Disabled\", \"Ready\", \"Running\", \"Paused\" or \"Unknown\"", + "enum": [ + "Disabled", + "Ready", + "Running", + "Paused", + "Unknown" + ], + "x-ms-enum": { + "name": "IngressState", + "modelAsString": true + } + }, + "stateDetails": { + "$ref": "#/definitions/EnvironmentStateDetails", + "description": "An object that contains the details about an environment's state." + } + } + }, + "EnvironmentStateDetails": { + "readOnly": true, + "type": "object", + "description": "An object that contains the details about an environment's state.", + "properties": { + "code": { + "type": "string", + "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programatically handle specific cases." + }, + "message": { + "type": "string", + "description": "A message that describes the state in detail." + } + } + }, + "EventSourceCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation." + }, + "EventHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an EventHub event source." + }, + "IoTHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an IoTHub event source." + }, + "EventSourceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the event source." + } + }, + "description": "Parameters supplied to the Update Event Source operation." + }, + "EventHubEventSourceUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceMutableProperties", + "description": "Properties of the EventHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an EventHub event source." + }, + "IoTHubEventSourceUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceMutableProperties", + "description": "Properties of the IoTHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an IoTHub event source." + }, + "EventSourceListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EventSourceResource" + }, + "description": "Result of the List EventSources operation." + } + }, + "description": "The response of the List EventSources operation." + }, + "EventSourceResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ "Microsoft.EventHub", "Microsoft.IoTHub" ] + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source" + }, + "EventHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure EventHub." + }, + "IoTHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.IotHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure IoTHub." + }, + "EventSourceCommonProperties": { + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the event source." + }, + "AzureEventSourceProperties": { + "properties": { + "eventSourceResourceId": { + "type": "string", + "description": "The resource id of the event source in Azure Resource Manager." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceCommonProperties" + } + ], + "required": [ + "eventSourceResourceId" + ], + "description": "Properties of an event source that reads events from an event broker in Azure." + }, + "EventHubEventSourceCommonProperties": { + "properties": { + "serviceBusNamespace": { + "type": "string", + "description": "The name of the service bus that contains the event hub." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the event hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "serviceBusNamespace", + "eventHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the EventHub event source." + }, + "EventHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the EventHub event source that are required on create or update requests." + }, + "EventHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "description": "Properties of the EventHub event source resource." + }, + "IoTHubEventSourceCommonProperties": { + "properties": { + "iotHubName": { + "type": "string", + "description": "The name of the iot hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the iot hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "iotHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the IoTHub event source." + }, + "IoTHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the IoTHub event source that are required on create or update requests." + }, + "IoTHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "description": "Properties of the IoTHub event source resource." + }, + "LocalTimestamp": { + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.", + "type": "object", + "properties": { + "format": { + "description": "An enum that represents the format of the local timestamp property that needs to be set.", + "type": "string", + "enum": [ + "Embedded", + "Iana", + "TimeSpan" + ], + "x-ms-enum": { + "name": "LocalTimestampFormat", + "modelAsString": true + } + }, + "timeZoneOffset": { + "description": "An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.", + "type": "object", + "properties": { + "propertyName": { + "type": "string", + "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" + } + } + } + } + }, + "EventSourceMutableProperties": { + "description": "An object that represents a set of mutable event source resource properties.", + "type": "object", + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + } + } + }, + "EventHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable EventHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "IoTHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable IoTHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "ReferenceDataSetCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ] + }, + "ReferenceDataSetUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the reference data set." + } + }, + "description": "Parameters supplied to the Update Reference Data Set operation." + }, + "ReferenceDataSetListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetResource" + }, + "description": "Result of the List Reference Data Sets operation." + } + }, + "description": "The response of the List Reference Data Sets operation." + }, + "ReferenceDataSetResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs." + }, + "ReferenceDataSetCreationProperties": { + "properties": { + "keyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetKeyProperty" + }, + "description": "The list of key properties for the reference data set." + }, + "dataStringComparisonBehavior": { + "type": "string", + "description": "The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.", + "enum": [ "Ordinal", "OrdinalIgnoreCase" ], + "x-ms-enum": { + "name": "DataStringComparisonBehavior", + "modelAsString": true + } + } + }, + "required": [ + "keyProperties" + ], + "description": "Properties used to create a reference data set." + }, + "ReferenceDataSetResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "required": [ + "keyProperties" + ], + "description": "Properties of the reference data set." + }, + "ReferenceDataSetKeyProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the key property." + }, + "type": { + "type": "string", + "description": "The type of the key property.", + "enum": [ + "String", + "Double", + "Bool", + "DateTime" + ], + "x-ms-enum": { + "name": "ReferenceDataKeyPropertyType", + "modelAsString": true + } + } + }, + "description": "A key property for the reference data set. A reference data set can have multiple key properties." + }, + "AccessPolicyCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "required": [ + "properties" + ] + }, + "AccessPolicyUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyMutableProperties" + } + } + }, + "AccessPolicyListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyResource" + }, + "description": "Result of the List access policies operation." + } + }, + "description": "The response of the List access policies operation." + }, + "AccessPolicyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs." + }, + "AccessPolicyResourceProperties": { + "properties": { + "principalObjectId": { + "type": "string", + "description": "The objectId of the principal in Azure Active Directory." + }, + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "AccessPolicyMutableProperties": { + "description": "An object that represents a set of mutable access policy resource properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + } + }, + "description": "Contains information about an API error.", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "Describes a particular API error with an error code and a message.", + "properties": { + "code": { + "type": "string", + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases." + }, + "message": { + "type": "string", + "description": "A message that describes the error in detail and provides debugging information." + }, + "target": { + "type": "string", + "description": "The target of the particular error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + }, + "description": "Contains nested errors that are related to this error." + } + }, + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + }, + "ExpandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of an Azure Resource group." + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights environment associated with the specified resource group.", + "x-ms-parameter-location": "method" + }, + "EventSourceNameParameter": { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights event source associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "ReferenceDataSetNameParameter": { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights reference data set associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "AccessPolicyNameParameter": { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights access policy associated with the specified environment.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/readme.go.md b/specification/timeseriesinsights/resource-manager/readme.go.md index 595b6f9fd345..6a179450c62c 100644 --- a/specification/timeseriesinsights/resource-manager/readme.go.md +++ b/specification/timeseriesinsights/resource-manager/readme.go.md @@ -15,6 +15,7 @@ go: batch: - tag: package-2017-11-15 - tag: package-2017-02-preview + - tag: package-2018-08-preview ``` ### Tag: package-2017-11-15 and go @@ -33,4 +34,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-08-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-08-15-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index 95dee2ea7dd3..15fc58484ddf 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -46,23 +46,36 @@ input-file: - Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json ``` +### Tag: package-2018-08-preview + +These settings apply only when `--tag=package-2018-08-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-08-preview' +input-file: +- Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json +``` + ## Suppression ``` yaml directive: - suppress: R3025 # Tracked resource 'XXX' must have a get operation where: + - $.definitions.StandardEnvironmentResource + - $.definitions.LongTermEnvironmentResource - $.definitions.EventHubEventSourceResource - $.definitions.IoTHubEventSourceResource from: timeseriesinsights.json - reason: These violations are false positives. The EventSources_Get operation returns an EventSourceResource, and both EventHubEventSourceResource and IoTHubEventSourceResource inherit from EventSourceResource. + reason: These violations are false positives. The EventSources_Get operation returns an EventSourceResource, and both EventHubEventSourceResource and IoTHubEventSourceResource inherit from EventSourceResource. Similarly, the Environments_Get operation returns an EnvironmentResource, from which both StandardEnvironmentResource and LongTermEnvironmentResource inherit. - suppress: R3026 # Tracked resource 'XXX' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. where: + - $.definitions.StandardEnvironmentResource + - $.definitions.LongTermEnvironmentResource - $.definitions.EventHubEventSourceResource - $.definitions.IoTHubEventSourceResource from: timeseriesinsights.json - reason: These violations are false positives. The EventSources_Update operation takes an EventSourceUpdateParameters as the body, and EventHubEventSourceUpdateParameters and IoTHubEventSourceUpdateParameters both inherit from EventSourceUpdateParameters. These definitions can be used to update mutable properties of the event source, including the Tags collection. + reason: These violations are false positives. The EventSources_Update operation takes an EventSourceUpdateParameters as the body, and EventHubEventSourceUpdateParameters and IoTHubEventSourceUpdateParameters both inherit from EventSourceUpdateParameters. Similarly, the Environments_Update operation takes an EnvironmentUpdateParameters as the body, and both StandardEnvironmentUpdateParameters and LongTermEnvironmentUpdateParameters inherit from EnvironmentUpdateParameters. These definitions can be used to update mutable properties of the event source, including the Tags collection. ``` --- @@ -105,6 +118,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-timeseriesinsights batch: - tag: package-2017-11-15 - tag: package-2017-02-preview + - tag: package-2018-08-preview ``` ### Tag: package-2017-11-15 and java @@ -133,4 +147,15 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2018-08-preview and java +These settings apply only when `--tag=package-2018-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2018_08_15_preview + output-folder: $(azure-libraries-for-java-folder)/timeseriesinsights/resource-manager/v2018_08_15_preview +regenerate-manager: true +generate-interface: true +``` From bd03fc522692d3b4d0498cf229080cfc96b7a684 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 29 Nov 2018 14:11:33 -0500 Subject: [PATCH 223/464] typo: Microsoft.Compute.Admin (#4610) - cancallation -> cancellation --- .../preview/2018-07-30-preview/DiskMigrationJobs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json index 8fd948a339fc..a07e54ee1d4d 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json @@ -159,7 +159,7 @@ ], "responses": { "200": { - "description": "OK -- Disk migration job cancallation is called.", + "description": "OK -- Disk migration job cancellation is called.", "schema": { "$ref": "DiskMigrationJobs.json#/definitions/DiskMigrationJob" } From 40e8341db7a38cf3053dc1000f1af9609e8f6e90 Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Fri, 30 Nov 2018 03:14:28 +0800 Subject: [PATCH 224/464] Revert "Fix the ARM R2062 error for Microsoft.Resources" (#4618) --- .../Microsoft.Resources/stable/2018-05-01/resources.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index 1be8d73316af..13c788d880ff 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -3201,7 +3201,6 @@ "description": "The list of tag values." } }, - "x-ms-azure-resource": true, "description": "Tag details." }, "TagsListResult": { From 5f43e3aa2a1aab644cc635379d126f63ca01b3aa Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 29 Nov 2018 14:31:11 -0500 Subject: [PATCH 225/464] typo: Microsoft.Storage.Admin (#4613) - Storag -> Storage - Maxium -> Maximum --- .../Microsoft.Storage.Admin/preview/2016-05-01/quotas.json | 2 +- .../Microsoft.Storage.Admin/preview/2016-05-01/storage.json | 2 +- specification/azsadmin/resource-manager/storage/readme.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json index 96563f8296ad..6c4649fd869a 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json @@ -197,7 +197,7 @@ "default": 20 }, "capacityInGb": { - "description": "Maxium capacity (GB).", + "description": "Maximum capacity (GB).", "type": "integer", "format": "int32", "default": 500 diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json index 374c28032326..f02b77dc14a9 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json @@ -81,7 +81,7 @@ "type": "boolean" }, "frontEndMaxMillisecondsBetweenMemorySamples": { - "description": "Maxium interval (in millisecond) between memory samples of front end.", + "description": "Maximum interval (in millisecond) between memory samples of front end.", "type": "integer", "format": "int32" }, diff --git a/specification/azsadmin/resource-manager/storage/readme.md b/specification/azsadmin/resource-manager/storage/readme.md index 7f96b896957e..7b8bdc26fb05 100644 --- a/specification/azsadmin/resource-manager/storage/readme.md +++ b/specification/azsadmin/resource-manager/storage/readme.md @@ -22,7 +22,7 @@ These are the global settings for the Storage API. ``` yaml title: StorageAdminClient -description: Storag Admin Client +description: Storage Admin Client openapi-type: arm tag: package-2016-05-01 ``` From 75feb1f66941d26dfdaa7e0e1dd56679761c273b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 29 Nov 2018 16:46:23 -0500 Subject: [PATCH 226/464] typo: Microsoft.ApiManagement (#4596) - reponse -> response - succesfully -> successfully - Successfull -> Successful - Double word "the" - GeoGraphy -> geography - secconds -> seconds - agregation -> aggregation - succesful -> successful - HttpStatusCode.Unauthorize -> HttpStatusCode.Unauthorized - fullfilled -> fulfilled - specificied -> specified - productid -> productId - appplying -> applying - assosiated -> associated - Storename -> StoreName - Managemet -> Management - outcoming -> outgoing - queruering -> querying - Countery -> Counter - Subsctions -> Subscriptions - groupid -> groupId - subid -> subscriptionId - dignostic -> diagnostic - settigs -> settings - concent -> consent - fescription -> description - Reconect -> Reconnect --- .../preview/2017-03-01/apimapis.json | 2 +- .../preview/2017-03-01/apimgroups.json | 2 +- .../preview/2017-03-01/apimproducts.json | 2 +- .../preview/2017-03-01/apimproperties.json | 2 +- .../preview/2017-03-01/apimreports.json | 12 +- .../preview/2017-03-01/apimsubscriptions.json | 4 +- .../preview/2017-03-01/apimtenant.json | 2 +- .../preview/2018-06-01-preview/apimapis.json | 14 +- .../2018-06-01-preview/apimdeployment.json | 4 +- .../2018-06-01-preview/apimdiagnostics.json | 8 +- .../2018-06-01-preview/apimgroups.json | 2 +- .../2018-06-01-preview/apimproducts.json | 2 +- .../2018-06-01-preview/apimproperties.json | 2 +- .../2018-06-01-preview/apimquotas.json | 8 +- .../2018-06-01-preview/apimreports.json | 12 +- .../2018-06-01-preview/apimsubscriptions.json | 2 +- .../2018-06-01-preview/apimtagresources.json | 2 +- .../preview/2018-06-01-preview/apimtags.json | 4 +- .../2018-06-01-preview/apimtenant.json | 2 +- ... => ApiManagementGetQuotaCounterKeys.json} | 0 ...mentGetQuotaCounterKeysByQuotaPeriod.json} | 0 .../stable/2016-07-07/apimanagement.json | 24 +- .../stable/2016-07-07/apimdeployment.json | 6 +- .../stable/2016-10-10/apimapis.json | 2 +- .../stable/2016-10-10/apimdeployment.json | 2610 ++++++++--------- .../stable/2016-10-10/apimgroups.json | 4 +- .../stable/2016-10-10/apimproducts.json | 2 +- .../stable/2016-10-10/apimproperties.json | 2 +- .../stable/2016-10-10/apimreports.json | 8 +- .../stable/2016-10-10/apimsubscriptions.json | 4 +- .../stable/2016-10-10/apimtenant.json | 2 +- .../stable/2017-03-01/apimdeployment.json | 2 +- .../stable/2017-03-01/apimdiagnostics.json | 8 +- .../stable/2017-03-01/apimgroups.json | 2 +- .../stable/2017-03-01/apimloggers.json | 2 +- .../stable/2017-03-01/apimportalsettings.json | 2 +- .../stable/2017-03-01/apimproducts.json | 2 +- .../stable/2017-03-01/apimproperties.json | 2 +- .../stable/2017-03-01/apimquotas.json | 8 +- .../stable/2017-03-01/apimreports.json | 12 +- .../stable/2017-03-01/apimsubscriptions.json | 4 +- .../stable/2017-03-01/apimtagresources.json | 2 +- .../stable/2017-03-01/apimtags.json | 4 +- .../stable/2017-03-01/apimtenant.json | 2 +- ... => ApiManagementGetQuotaCounterKeys.json} | 0 ...mentGetQuotaCounterKeysByQuotaPeriod.json} | 0 .../stable/2018-01-01/apimapis.json | 20 +- .../stable/2018-01-01/apimbackends.json | 2 +- .../stable/2018-01-01/apimdeployment.json | 4 +- .../stable/2018-01-01/apimdiagnostics.json | 8 +- .../stable/2018-01-01/apimgroups.json | 2 +- .../stable/2018-01-01/apimproducts.json | 2 +- .../stable/2018-01-01/apimproperties.json | 2 +- .../stable/2018-01-01/apimquotas.json | 8 +- .../stable/2018-01-01/apimreports.json | 12 +- .../stable/2018-01-01/apimsubscriptions.json | 4 +- .../stable/2018-01-01/apimtagresources.json | 2 +- .../stable/2018-01-01/apimtags.json | 4 +- .../stable/2018-01-01/apimtenant.json | 2 +- ... => ApiManagementGetQuotaCounterKeys.json} | 0 ...mentGetQuotaCounterKeysByQuotaPeriod.json} | 0 61 files changed, 1438 insertions(+), 1438 deletions(-) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/{ApiManagementGetQuotaCounteryKeys.json => ApiManagementGetQuotaCounterKeys.json} (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/{ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json => ApiManagementGetQuotaCounterKeysByQuotaPeriod.json} (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/{ApiManagementGetQuotaCounteryKeys.json => ApiManagementGetQuotaCounterKeys.json} (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/{ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json => ApiManagementGetQuotaCounterKeysByQuotaPeriod.json} (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/{ApiManagementGetQuotaCounteryKeys.json => ApiManagementGetQuotaCounterKeys.json} (100%) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/{ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json => ApiManagementGetQuotaCounterKeysByQuotaPeriod.json} (100%) diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimapis.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimapis.json index 2d0298d6160f..65975ef5b2cb 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimapis.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimapis.json @@ -77,7 +77,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of Apis.", + "description": "Paged Result response of Apis.", "schema": { "$ref": "#/definitions/ApiCollection" } diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimgroups.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimgroups.json index 0a867a703814..64c8cf5047f4 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimgroups.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimgroups.json @@ -160,7 +160,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully.", + "description": "Group was created successfully.", "schema": { "$ref": "#/definitions/GroupContract" } 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 8912b14c2c58..4452bfaad2df 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 @@ -226,7 +226,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproperties.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproperties.json index a71a112e6815..a61cd16f96dc 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproperties.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimproperties.json @@ -231,7 +231,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "x-ms-examples": { "ApiManagementDeleteProperties": { "$ref": "./examples/ApiManagementDeleteProperties.json" diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimreports.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimreports.json index f7dae0d437cf..ad295ade1ae6 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimreports.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimreports.json @@ -224,7 +224,7 @@ "Reports" ], "operationId": "Reports_ListByGeo", - "description": "Lists report records by GeoGraphy.", + "description": "Lists report records by geography.", "x-ms-examples": { "ApiManagementGetReportsByGeo": { "$ref": "./examples/ApiManagementGetReportsByGeo.json" @@ -338,7 +338,7 @@ "required": true, "type": "string", "format": "duration", - "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -438,7 +438,7 @@ }, "interval": { "type": "string", - "description": "Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." }, "country": { "type": "string", @@ -481,12 +481,12 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", @@ -621,7 +621,7 @@ }, "cache": { "type": "string", - "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend." + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." }, "apiTime": { "type": "number", diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json index 31100ae142a7..d11185157a7d 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json @@ -199,7 +199,7 @@ "Subscriptions" ], "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "x-ms-examples": { "ApiManagementPatchSubscriptions": { "$ref": "./examples/ApiManagementPatchSubscriptions.json" @@ -486,7 +486,7 @@ }, "productId": { "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + "description": "Product (product id path) for which subscription is being created in form /products/{productId}" }, "name": { "type": "string", diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json index 369cb628eded..7371f669fb9d 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json @@ -338,7 +338,7 @@ "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." }, "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json index 73019ac93c17..86a665fe95dd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -2124,7 +2124,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics for an API.", + "description": "Paged Result response of diagnostics for an API.", "schema": { "$ref": "./apimdiagnostics.json#/definitions/DiagnosticCollection" } @@ -2419,7 +2419,7 @@ "ApiIssues" ], "operationId": "ApiIssue_ListByService", - "description": "Lists all issues assosiated with the specified API.", + "description": "Lists all issues associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssues": { "$ref": "./examples/ApiManagementListApiIssues.json" @@ -2457,7 +2457,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issues for the API.", + "description": "Paged Result response of issues for the API.", "schema": { "$ref": "#/definitions/IssueCollection" } @@ -2764,7 +2764,7 @@ "ApiIssueComments" ], "operationId": "ApiIssueComment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueComments": { "$ref": "./examples/ApiManagementListApiIssueComments.json" @@ -2805,7 +2805,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueCommentCollection" } @@ -3065,7 +3065,7 @@ "ApiIssueAttachments" ], "operationId": "ApiIssueAttachment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueAttachments": { "$ref": "./examples/ApiManagementListApiIssueAttachments.json" @@ -3106,7 +3106,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueAttachmentCollection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json index 9b28e55f3cec..738d97051979 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json @@ -680,7 +680,7 @@ "description": "Certificate Password." }, "storeName": { - "description": "The System.Security.Cryptography.x509certificates.Storename certificate store location. Only Root and CertificateAuthority are valid locations.", + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", "type": "string", "enum": [ "CertificateAuthority", @@ -981,7 +981,7 @@ }, "virtualNetworkType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "default": "None", "enum": [ "None", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json index 9f2383a28c83..b89fc886120a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdiagnostics.json @@ -75,7 +75,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics.", + "description": "Paged Result response of diagnostics.", "schema": { "$ref": "#/definitions/DiagnosticCollection" } @@ -422,7 +422,7 @@ "description": "Diagnostic settings for response." } }, - "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Gateway." + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." }, "HttpMessageDiagnostic": { "properties": { @@ -480,11 +480,11 @@ }, "frontend": { "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Gateway." + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway." }, "backend": { "$ref": "#/definitions/PipelineDiagnosticSettings", - "description": "Diagnostic settings for incoming/outcoming HTTP messages to the Backend" + "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Backend" }, "enableHttpCorrelationHeaders": { "type": "boolean", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json index 9732a8ba97e5..a210fe8636d1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimgroups.json @@ -231,7 +231,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully.", + "description": "Group was created successfully.", "schema": { "$ref": "#/definitions/GroupContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json index 14df7bb8d5d9..e09e8d0a7491 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproducts.json @@ -299,7 +299,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json index 1be0bf615e9f..851f252c9340 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimproperties.json @@ -304,7 +304,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "x-ms-examples": { "ApiManagementDeleteProperty": { "$ref": "./examples/ApiManagementDeleteProperty.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json index 320f2834ae6d..6eaa1bc25474 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimquotas.json @@ -46,8 +46,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeys": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeys.json" + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" } }, "parameters": [ @@ -144,8 +144,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeysByQuotaPeriod": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json" + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json index 52508cc6115c..99d8eba3eb42 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimreports.json @@ -252,7 +252,7 @@ "Reports" ], "operationId": "Reports_ListByGeo", - "description": "Lists report records by GeoGraphy.", + "description": "Lists report records by geography.", "x-ms-examples": { "ApiManagementGetReportsByGeo": { "$ref": "./examples/ApiManagementGetReportsByGeo.json" @@ -390,7 +390,7 @@ "required": true, "type": "string", "format": "duration", - "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -502,7 +502,7 @@ }, "interval": { "type": "string", - "description": "Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." }, "country": { "type": "string", @@ -545,12 +545,12 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", @@ -685,7 +685,7 @@ }, "cache": { "type": "string", - "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend." + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." }, "apiTime": { "type": "number", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json index 2dc97a403b2b..01e7e52edcc7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimsubscriptions.json @@ -258,7 +258,7 @@ "Subscriptions" ], "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "x-ms-examples": { "ApiManagementUpdateSubscription": { "$ref": "./examples/ApiManagementUpdateSubscription.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json index ef1f457b198c..d3c2b30a9d79 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtagresources.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "ApiManagementClient", - "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", + "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", "version": "2018-06-01-preview" }, "host": "management.azure.com", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json index 587b3a52f91c..ea5afcdec05c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtags.json @@ -229,7 +229,7 @@ ], "responses": { "201": { - "description": "Tag was created succesfully.", + "description": "Tag was created successfully.", "schema": { "$ref": "#/definitions/TagContract" } @@ -785,7 +785,7 @@ "ApiTagDescriptions" ], "operationId": "TagDescription_CreateOrUpdate", - "description": "Create/Update tag fescription in scope of the Api.", + "description": "Create/Update tag description in scope of the Api.", "x-ms-examples": { "ApiManagementCreateApiTagDescription": { "$ref": "./examples/ApiManagementCreateApiTagDescription.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json index dc300339823a..487a7b169075 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimtenant.json @@ -397,7 +397,7 @@ "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." }, "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounterKeys.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeys.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounterKeys.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json 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 80b24e008508..21e9cd7b6412 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 @@ -73,7 +73,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of Apis.", + "description": "Paged Result response of Apis.", "schema": { "$ref": "#/definitions/ApiCollection" } @@ -767,7 +767,7 @@ "Subscriptions" ], "operationId": "Subscriptions_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -1143,7 +1143,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", @@ -1615,7 +1615,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully." + "description": "Group was created successfully." }, "204": { "description": "Group already exists." @@ -3017,7 +3017,7 @@ "in": "query", "required": false, "type": "string", - "description": "By time interval. This value is only applicable to ByTime aggregation. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. This value is only applicable to ByTime aggregation. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3667,7 +3667,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -4120,7 +4120,7 @@ ], "responses": { "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } @@ -5495,7 +5495,7 @@ "description": "Next page link if any." } }, - "description": "Paged Subsctions list representation." + "description": "Paged Subscriptions list representation." }, "SubscriptionCreateParameters": { "properties": { @@ -5505,7 +5505,7 @@ }, "productId": { "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + "description": "Product (product id path) for which subscription is being created in form /products/{productId}" }, "name": { "type": "string", @@ -5653,7 +5653,7 @@ "properties": { "id": { "type": "string", - "description": "Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupid} where {groupid} is a group identifier.", + "description": "Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier.", "readOnly": true }, "name": { @@ -6473,7 +6473,7 @@ "interval": { "type": "integer", "format": "int64", - "description": "Length of agregation period." + "description": "Length of aggregation period." }, "country": { "type": "string", @@ -6516,7 +6516,7 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls." + "description": "Number of successful calls." }, "callCountBlocked": { "type": "integer", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimdeployment.json index b23c3b81a225..33442505f330 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-07-07/apimdeployment.json @@ -646,7 +646,7 @@ }, "subnetResourceId": { "type": "string", - "description": "The name of the subnet Resource ID. This has format /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}." + "description": "The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}." }, "location": { "type": "string", @@ -738,7 +738,7 @@ }, "vpnType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified.", "default": "None", "enum": [ "None", @@ -870,7 +870,7 @@ }, "vpnType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "default": "None", "enum": [ "None", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimapis.json index de29dc04b25a..8cd734f95254 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimapis.json @@ -73,7 +73,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of Apis.", + "description": "Paged Result response of Apis.", "schema": { "$ref": "#/definitions/ApiCollection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json index 0774d680e41d..56453da0e404 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimdeployment.json @@ -1,1306 +1,1306 @@ -{ - "swagger": "2.0", - "info": { - "title": "ApiManagementClient", - "description": "Use these REST APIs to manage Azure API Management deployment.", - "version": "2016-10-10" - }, - "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.ApiManagement/operations": { - "get": { - "tags": [ - "ApiManagementOperations" - ], - "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", - "operationId": "ApiManagementOperations_List", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success. The response describes the list of operations.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/managedeployments": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_ManageDeployments", - "description": "Manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.", - "x-ms-examples": { - "ApiManagementServiceManageDeployment": { "$ref": "./examples/ApiManagementServiceManageDeployment.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceManageDeploymentsParameters" - }, - "description": "Parameters supplied to the ManageDeployments operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully applied the new deployment Configuration on the API Management service.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked.The response also includes the unmodified ApiManagementServiceResource.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_Restore", - "description": "Restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementRestoreService": { "$ref": "./examples/ApiManagementRestoreService.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" - }, - "description": "Parameters supplied to the Restore API Management service from backup operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully restored the backup onto the API Management service.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_Backup", - "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementCreateBackup": { "$ref": "./examples/ApiManagementCreateBackup.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" - }, - "description": "Parameters supplied to the ApiManagementServices_Backup operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully backed up the API Management service to the storage account.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}": { - "put": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_CreateOrUpdate", - "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementCreateService": { "$ref": "./examples/ApiManagementCreateService.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management service operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The service was successfully set up.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_Update", - "description": "Updates an existing API Management service.", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceUpdateParameters" - }, - "description": "Parameters supplied to the CreateOrUpdate API Management service operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the current API Management service.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_Get", - "description": "Gets an API Management service resource description.", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully got the API Management Service Resource.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_Delete", - "description": "Deletes an existing API Management service.", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Service was successfully deleted." - }, - "204": { - "description": "Service is already deleted." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/": { - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_ListByResourceGroup", - "description": "List all API Management services within a resource group.", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The API Management service list.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service/": { - "get": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_List", - "description": "Lists all API Management services within an Azure subscription.", - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The API Management service list.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_GetSsoToken", - "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", - "x-ms-examples": { - "ApiManagementServiceGetSsoToken": { "$ref": "./examples/ApiManagementServiceGetSsoToken.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "OK if successful with the SSO Redirect URI.", - "schema": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_CheckNameAvailability", - "description": "Checks availability and correctness of a name for an API Management service.", - "x-ms-examples": { - "ApiManagementServiceCheckNameAvailability": { "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" } - }, - "parameters": [ - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" - }, - "description": "Parameters supplied to the CheckNameAvailability operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "The result of check name availability.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/uploadcertificate": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_UploadCertificate", - "description": "Upload Custom Domain SSL certificate for an API Management service.", - "x-ms-examples": { - "ApiManagementServiceUploadProxyCertificate": { "$ref": "./examples/ApiManagementServiceUploadProxyCertificate.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceUploadCertificateParameters" - }, - "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Successfully uploaded certificate to the API Management Service.", - "schema": { - "$ref": "#/definitions/CertificateInformation" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_UpdateHostname", - "description": "Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.", - "x-ms-examples": { - "ApiManagementServiceUpdateHostName": { "$ref": "./examples/ApiManagementServiceUpdateHostName.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ApiManagementServiceUpdateHostnameParameters" - }, - "description": "Parameters supplied to the UpdateHostname operation." - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Service was successfully updated with desired hostnames.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked. The response also includes the unmodified ApiManagementServiceResource.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { - "post": { - "tags": [ - "ApiManagementService" - ], - "operationId": "ApiManagementServices_ApplyNetworkConfigurationUpdates", - "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.", - "x-ms-examples": { - "ApiManagementApplyNetworkConfigurationUpdates": { "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" } - }, - "parameters": [ - { - "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Service was successfully updated with new virtual network configurations.", - "schema": { - "$ref": "#/definitions/ApiManagementServiceResource" - } - }, - "202": { - "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - } - }, - "definitions": { - "CertificateInformation": { - "properties": { - "expiry": { - "type": "string", - "format": "date-time", - "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." - }, - "thumbprint": { - "type": "string", - "description": "Thumbprint of the certificate." - }, - "subject": { - "type": "string", - "description": "Subject of the certificate." - } - }, - "required": [ - "expiry", - "thumbprint", - "subject" - ], - "description": "SSL certificate information." - }, - "HostnameConfiguration": { - "properties": { - "type": { - "type": "string", - "description": "Hostname type.", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "hostname": { - "type": "string", - "description": "Hostname." - }, - "certificate": { - "$ref": "#/definitions/CertificateInformation", - "description": "Certificate information." - } - }, - "required": [ - "type", - "hostname", - "certificate" - ], - "description": "Custom hostname configuration." - }, - "VirtualNetworkConfiguration": { - "properties": { - "vnetid": { - "readOnly": true, - "type": "string", - "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." - }, - "subnetname": { - "readOnly": true, - "type": "string", - "description": "The name of the subnet." - }, - "subnetResourceId": { - "type": "string", - "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." - }, - "location": { - "type": "string", - "description": "The location of the virtual network." - } - }, - "description": "Configuration of a virtual network to which API Management service is deployed." - }, - "AdditionalRegion": { - "properties": { - "location": { - "type": "string", - "description": "The location name of the additional region among Azure Data center regions." - }, - "skuType": { - "type": "string", - "description": "The SKU type in the location.", - "enum": [ - "Developer", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuType", - "modelAsString": false - } - }, - "skuUnitCount": { - "type": "integer", - "format": "int32", - "description": "The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.", - "default": 1, - "maximum": 10 - }, - "staticIPs": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Static IP addresses of the location's virtual machines." - }, - "vpnconfiguration": { - "$ref": "#/definitions/VirtualNetworkConfiguration", - "description": "Virtual network configuration for the location." - } - }, - "required": [ - "location", - "skuType" - ], - "description": "Description of an additional API Management resource location." - }, - "ApiManagementServiceManageDeploymentsParameters": { - "properties": { - "location": { - "type": "string", - "description": "Location of the API Management service Azure data center." - }, - "skuType": { - "type": "string", - "description": "SKU type of the API Management service.", - "enum": [ - "Developer", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuType", - "modelAsString": false - } - }, - "skuUnitCount": { - "type": "integer", - "format": "int32", - "description": "SKU Unit count of the API Management service. Default value is 1.", - "default": 1 - }, - "additionalLocations": { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalRegion" - }, - "description": "Additional data center locations for the API Management service." - }, - "vpnConfiguration": { - "$ref": "#/definitions/VirtualNetworkConfiguration", - "description": "Virtual network configuration." - }, - "vpnType": { - "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified.", - "default": "None", - "enum": [ - "None", - "External", - "Internal" - ], - "x-ms-enum": { - "name": "VirtualNetworkType", - "modelAsString": false - } - } - }, - "required": [ - "location", - "skuType" - ], - "description": "Parameters supplied to the ManageDeployments operation." - }, - "ApiManagementServiceBackupRestoreParameters": { - "properties": { - "storageAccount": { - "type": "string", - "description": "Azure Cloud Storage account (used to place/retrieve the backup) name." - }, - "accessKey": { - "type": "string", - "description": "Azure Cloud Storage account (used to place/retrieve the backup) access key." - }, - "containerName": { - "type": "string", - "description": "Azure Cloud Storage blob container name used to place/retrieve the backup." - }, - "backupName": { - "type": "string", - "description": "The name of the backup file to create." - } - }, - "required": [ - "storageAccount", - "accessKey", - "containerName", - "backupName" - ], - "description": "Parameters supplied to the Backup/Restore of an API Management service operation." - }, - "ApiManagementServiceProperties": { - "properties": { - "publisherEmail": { - "type": "string", - "description": "Publisher email.", - "maxLength": 100 - }, - "publisherName": { - "type": "string", - "description": "Publisher name." - }, - "provisioningState": { - "type": "string", - "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", - "readOnly": true - }, - "targetProvisioningState": { - "type": "string", - "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", - "readOnly": true - }, - "createdAtUtc": { - "type": "string", - "format": "date-time", - "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", - "readOnly": true - }, - "runtimeUrl": { - "type": "string", - "description": "Proxy endpoint URL of the API Management service.", - "readOnly": true - }, - "portalUrl": { - "type": "string", - "description": "Publisher portal endpoint Url of the API Management service.", - "readOnly": true - }, - "managementApiUrl": { - "type": "string", - "description": "Management API endpoint URL of the API Management service.", - "readOnly": true - }, - "scmUrl": { - "type": "string", - "description": "SCM endpoint URL of the API Management service.", - "readOnly": true - }, - "addresserEmail": { - "type": "string", - "description": "Addresser email." - }, - "hostnameConfigurations": { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfiguration" - }, - "description": "Custom hostname configuration of the API Management service." - }, - "staticIPs": { - "type": "array", - "items": { - "type": "string" - }, - "readOnly": true, - "description": "Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU." - }, - "vpnconfiguration": { - "$ref": "#/definitions/VirtualNetworkConfiguration", - "description": "Virtual network configuration of the API Management service." - }, - "additionalLocations": { - "type": "array", - "items": { - "$ref": "#/definitions/AdditionalRegion" - }, - "description": "Additional datacenter locations of the API Management service." - }, - "customProperties": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Custom properties of the API Management service, like disabling TLS 1.0." - }, - "vpnType": { - "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", - "default": "None", - "enum": [ - "None", - "External", - "Internal" - ], - "x-ms-enum": { - "name": "VirtualNetworkType", - "modelAsString": false - } - } - }, - "required": [ - "publisherEmail", - "publisherName" - ], - "description": "Properties of an API Management service resource description." - }, - "ApiManagementServiceSkuProperties": { - "properties": { - "name": { - "type": "string", - "description": "Name of the Sku.", - "externalDocs": { - "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" - }, - "enum": [ - "Developer", - "Standard", - "Premium" - ], - "x-ms-enum": { - "name": "SkuType", - "modelAsString": false - } - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1.", - "default": 1 - } - }, - "required": [ - "name" - ], - "description": "API Management service resource SKU properties." - }, - "ApiManagementServiceResource":{ - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceProperties", - "description": "Properties of the API Management service." - }, - "sku": { - "$ref": "#/definitions/ApiManagementServiceSkuProperties", - "description": "SKU properties of the API Management service." - }, - "etag": { - "type": "string", - "description": "ETag of the resource.", - "readOnly": true - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "required": [ - "sku", - "properties" - ], - "description": "A single API Management service resource in List or Get response." - }, - "Resource": { - "description": "The Resource definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "type": "string", - "description": "Resource name.", - "x-ms-mutability":[ - "read", - "create" - ] - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." - }, - "location": { - "type": "string", - "description": "Resource location.", - "x-ms-mutability":[ - "read", - "create" - ] - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "required": [ - "location" - ], - "x-ms-azure-resource": true - }, - "ApiManagementServiceUpdateParameters": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ApiManagementServiceProperties", - "description": "Properties of the API Management service." - }, - "sku": { - "$ref": "#/definitions/ApiManagementServiceSkuProperties", - "description": "SKU properties of the API Management service." - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags." - } - }, - "description": "Parameters supplied to the Update API Management service operation." - }, - "ApiManagementServiceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/ApiManagementServiceResource" - }, - "description": "Result of the List API Management services operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." - } - }, - "required": [ - "value" - ], - "description": "The response of the List API Management services operation." - }, - "ApiManagementServiceGetSsoTokenResult": { - "properties": { - "redirect_uri": { - "type": "string", - "description": "Redirect URL containing the SSO token." - } - }, - "description": "The response of the GetSsoToken operation." - }, - "ApiManagementServiceCheckNameAvailabilityParameters": { - "properties": { - "name": { - "type": "string", - "description": "The name to check for availability." - } - }, - "required": [ - "name" - ], - "description": "Parameters supplied to the CheckNameAvailability operation." - }, - "ApiManagementServiceNameAvailabilityResult": { - "properties": { - "nameAvailable": { - "type": "boolean", - "description": "True if the name is available and can be used to create a new API Management service; otherwise false." - }, - "message": { - "type": "string", - "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name." - }, - "reason": { - "type": "string", - "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", - "enum": [ - "Valid", - "Invalid", - "AlreadyExists" - ], - "x-ms-enum": { - "name": "NameAvailabilityReason", - "modelAsString": false - } - } - }, - "required": [ - "nameAvailable" - ], - "description": "Response of the CheckNameAvailability operation." - }, - "ApiManagementServiceUploadCertificateParameters": { - "properties": { - "type": { - "type": "string", - "description": "Hostname type.", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "certificate": { - "type": "string", - "description": "Base64 Encoded certificate." - }, - "certificate_password": { - "type": "string", - "description": "Certificate password." - } - }, - "required": [ - "type", - "certificate", - "certificate_password" - ], - "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." - }, - "ApiManagementServiceUpdateHostnameParameters": { - "properties": { - "update": { - "type": "array", - "items": { - "$ref": "#/definitions/HostnameConfiguration" - }, - "description": "Hostnames to create or update." - }, - "delete": { - "type": "array", - "items": { - "type": "string", - "enum": [ - "Proxy", - "Portal", - "Management", - "Scm" - ], - "x-ms-enum": { - "name": "HostnameType", - "modelAsString": false - } - }, - "description": "Hostnames types to delete." - } - }, - "description": "Parameters supplied to the UpdateHostname operation." - }, - "ErrorResponse": { - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - }, - "description": "Error Response." - }, - "Operation": { - "description": "REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that describes the operation.", - "properties": { - "provider": { - "description": "Friendly name of the resource provider", - "type": "string" - }, - "operation": { - "description": "Operation type: read, write, delete, listKeys/action, etc.", - "type": "string" - }, - "resource": { - "description": "Resource type on which the operation is performed.", - "type": "string" - }, - "description": { - "description": "Friendly name of the operation", - "type": "string" - } - } - } - } - }, - "OperationListResult": { - "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "description": "List of operations supported by the resource provider." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of operation list results if there are any." - } - } - } - }, - "parameters": { - } +{ + "swagger": "2.0", + "info": { + "title": "ApiManagementClient", + "description": "Use these REST APIs to manage Azure API Management deployment.", + "version": "2016-10-10" + }, + "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.ApiManagement/operations": { + "get": { + "tags": [ + "ApiManagementOperations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.ApiManagement provider.", + "operationId": "ApiManagementOperations_List", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/managedeployments": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_ManageDeployments", + "description": "Manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.", + "x-ms-examples": { + "ApiManagementServiceManageDeployment": { "$ref": "./examples/ApiManagementServiceManageDeployment.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceManageDeploymentsParameters" + }, + "description": "Parameters supplied to the ManageDeployments operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully applied the new deployment Configuration on the API Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked.The response also includes the unmodified ApiManagementServiceResource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_Restore", + "description": "Restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementRestoreService": { "$ref": "./examples/ApiManagementRestoreService.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the Restore API Management service from backup operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully restored the backup onto the API Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_Backup", + "description": "Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateBackup": { "$ref": "./examples/ApiManagementCreateBackup.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceBackupRestoreParameters" + }, + "description": "Parameters supplied to the ApiManagementServices_Backup operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully backed up the API Management service to the storage account.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}": { + "put": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_CreateOrUpdate", + "description": "Creates or updates an API Management service. This is long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementCreateService": { "$ref": "./examples/ApiManagementCreateService.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The service was successfully set up.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_Update", + "description": "Updates an existing API Management service.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateParameters" + }, + "description": "Parameters supplied to the CreateOrUpdate API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the current API Management service.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_Get", + "description": "Gets an API Management service resource description.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the API Management Service Resource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_Delete", + "description": "Deletes an existing API Management service.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully deleted." + }, + "204": { + "description": "Service is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_ListByResourceGroup", + "description": "List all API Management services within a resource group.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service/": { + "get": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_List", + "description": "Lists all API Management services within an Azure subscription.", + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The API Management service list.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_GetSsoToken", + "description": "Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.", + "x-ms-examples": { + "ApiManagementServiceGetSsoToken": { "$ref": "./examples/ApiManagementServiceGetSsoToken.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK if successful with the SSO Redirect URI.", + "schema": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceGetSsoTokenResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_CheckNameAvailability", + "description": "Checks availability and correctness of a name for an API Management service.", + "x-ms-examples": { + "ApiManagementServiceCheckNameAvailability": { "$ref": "./examples/ApiManagementServiceCheckNameAvailability.json" } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceCheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The result of check name availability.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceNameAvailabilityResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/uploadcertificate": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_UploadCertificate", + "description": "Upload Custom Domain SSL certificate for an API Management service.", + "x-ms-examples": { + "ApiManagementServiceUploadProxyCertificate": { "$ref": "./examples/ApiManagementServiceUploadProxyCertificate.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUploadCertificateParameters" + }, + "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully uploaded certificate to the API Management Service.", + "schema": { + "$ref": "#/definitions/CertificateInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_UpdateHostname", + "description": "Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.", + "x-ms-examples": { + "ApiManagementServiceUpdateHostName": { "$ref": "./examples/ApiManagementServiceUpdateHostName.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApiManagementServiceUpdateHostnameParameters" + }, + "description": "Parameters supplied to the UpdateHostname operation." + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully updated with desired hostnames.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted. The location header contains the URL where the status of the long running operation can be checked. The response also includes the unmodified ApiManagementServiceResource.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/applynetworkconfigurationupdates": { + "post": { + "tags": [ + "ApiManagementService" + ], + "operationId": "ApiManagementServices_ApplyNetworkConfigurationUpdates", + "description": "Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.", + "x-ms-examples": { + "ApiManagementApplyNetworkConfigurationUpdates": { "$ref": "./examples/ApiManagementApplyNetworkConfigurationUpdates.json" } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Service was successfully updated with new virtual network configurations.", + "schema": { + "$ref": "#/definitions/ApiManagementServiceResource" + } + }, + "202": { + "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "CertificateInformation": { + "properties": { + "expiry": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." + }, + "thumbprint": { + "type": "string", + "description": "Thumbprint of the certificate." + }, + "subject": { + "type": "string", + "description": "Subject of the certificate." + } + }, + "required": [ + "expiry", + "thumbprint", + "subject" + ], + "description": "SSL certificate information." + }, + "HostnameConfiguration": { + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "hostname": { + "type": "string", + "description": "Hostname." + }, + "certificate": { + "$ref": "#/definitions/CertificateInformation", + "description": "Certificate information." + } + }, + "required": [ + "type", + "hostname", + "certificate" + ], + "description": "Custom hostname configuration." + }, + "VirtualNetworkConfiguration": { + "properties": { + "vnetid": { + "readOnly": true, + "type": "string", + "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." + }, + "subnetname": { + "readOnly": true, + "type": "string", + "description": "The name of the subnet." + }, + "subnetResourceId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." + }, + "location": { + "type": "string", + "description": "The location of the virtual network." + } + }, + "description": "Configuration of a virtual network to which API Management service is deployed." + }, + "AdditionalRegion": { + "properties": { + "location": { + "type": "string", + "description": "The location name of the additional region among Azure Data center regions." + }, + "skuType": { + "type": "string", + "description": "The SKU type in the location.", + "enum": [ + "Developer", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": false + } + }, + "skuUnitCount": { + "type": "integer", + "format": "int32", + "description": "The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location.", + "default": 1, + "maximum": 10 + }, + "staticIPs": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Static IP addresses of the location's virtual machines." + }, + "vpnconfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration for the location." + } + }, + "required": [ + "location", + "skuType" + ], + "description": "Description of an additional API Management resource location." + }, + "ApiManagementServiceManageDeploymentsParameters": { + "properties": { + "location": { + "type": "string", + "description": "Location of the API Management service Azure data center." + }, + "skuType": { + "type": "string", + "description": "SKU type of the API Management service.", + "enum": [ + "Developer", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": false + } + }, + "skuUnitCount": { + "type": "integer", + "format": "int32", + "description": "SKU Unit count of the API Management service. Default value is 1.", + "default": 1 + }, + "additionalLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalRegion" + }, + "description": "Additional data center locations for the API Management service." + }, + "vpnConfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration." + }, + "vpnType": { + "type": "string", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified.", + "default": "None", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": false + } + } + }, + "required": [ + "location", + "skuType" + ], + "description": "Parameters supplied to the ManageDeployments operation." + }, + "ApiManagementServiceBackupRestoreParameters": { + "properties": { + "storageAccount": { + "type": "string", + "description": "Azure Cloud Storage account (used to place/retrieve the backup) name." + }, + "accessKey": { + "type": "string", + "description": "Azure Cloud Storage account (used to place/retrieve the backup) access key." + }, + "containerName": { + "type": "string", + "description": "Azure Cloud Storage blob container name used to place/retrieve the backup." + }, + "backupName": { + "type": "string", + "description": "The name of the backup file to create." + } + }, + "required": [ + "storageAccount", + "accessKey", + "containerName", + "backupName" + ], + "description": "Parameters supplied to the Backup/Restore of an API Management service operation." + }, + "ApiManagementServiceProperties": { + "properties": { + "publisherEmail": { + "type": "string", + "description": "Publisher email.", + "maxLength": 100 + }, + "publisherName": { + "type": "string", + "description": "Publisher name." + }, + "provisioningState": { + "type": "string", + "description": "The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted.", + "readOnly": true + }, + "targetProvisioningState": { + "type": "string", + "description": "The provisioning state of the API Management service, which is targeted by the long running operation started on the service.", + "readOnly": true + }, + "createdAtUtc": { + "type": "string", + "format": "date-time", + "description": "Creation UTC date of the API Management service.The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.", + "readOnly": true + }, + "runtimeUrl": { + "type": "string", + "description": "Proxy endpoint URL of the API Management service.", + "readOnly": true + }, + "portalUrl": { + "type": "string", + "description": "Publisher portal endpoint Url of the API Management service.", + "readOnly": true + }, + "managementApiUrl": { + "type": "string", + "description": "Management API endpoint URL of the API Management service.", + "readOnly": true + }, + "scmUrl": { + "type": "string", + "description": "SCM endpoint URL of the API Management service.", + "readOnly": true + }, + "addresserEmail": { + "type": "string", + "description": "Addresser email." + }, + "hostnameConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + }, + "description": "Custom hostname configuration of the API Management service." + }, + "staticIPs": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU." + }, + "vpnconfiguration": { + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network configuration of the API Management service." + }, + "additionalLocations": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalRegion" + }, + "description": "Additional datacenter locations of the API Management service." + }, + "customProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Custom properties of the API Management service, like disabling TLS 1.0." + }, + "vpnType": { + "type": "string", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "default": "None", + "enum": [ + "None", + "External", + "Internal" + ], + "x-ms-enum": { + "name": "VirtualNetworkType", + "modelAsString": false + } + } + }, + "required": [ + "publisherEmail", + "publisherName" + ], + "description": "Properties of an API Management service resource description." + }, + "ApiManagementServiceSkuProperties": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": false + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity of the SKU (number of deployed units of the SKU). The default value is 1.", + "default": 1 + } + }, + "required": [ + "name" + ], + "description": "API Management service resource SKU properties." + }, + "ApiManagementServiceResource":{ + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "etag": { + "type": "string", + "description": "ETag of the resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku", + "properties" + ], + "description": "A single API Management service resource in List or Get response." + }, + "Resource": { + "description": "The Resource definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "type": "string", + "description": "Resource name.", + "x-ms-mutability":[ + "read", + "create" + ] + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type for API Management resource is set to Microsoft.ApiManagement." + }, + "location": { + "type": "string", + "description": "Resource location.", + "x-ms-mutability":[ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "ApiManagementServiceUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApiManagementServiceProperties", + "description": "Properties of the API Management service." + }, + "sku": { + "$ref": "#/definitions/ApiManagementServiceSkuProperties", + "description": "SKU properties of the API Management service." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Parameters supplied to the Update API Management service operation." + }, + "ApiManagementServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiManagementServiceResource" + }, + "description": "Result of the List API Management services operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of API Management services." + } + }, + "required": [ + "value" + ], + "description": "The response of the List API Management services operation." + }, + "ApiManagementServiceGetSsoTokenResult": { + "properties": { + "redirect_uri": { + "type": "string", + "description": "Redirect URL containing the SSO token." + } + }, + "description": "The response of the GetSsoToken operation." + }, + "ApiManagementServiceCheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability." + } + }, + "required": [ + "name" + ], + "description": "Parameters supplied to the CheckNameAvailability operation." + }, + "ApiManagementServiceNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "True if the name is available and can be used to create a new API Management service; otherwise false." + }, + "message": { + "type": "string", + "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name." + }, + "reason": { + "type": "string", + "description": "Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.", + "enum": [ + "Valid", + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false + } + } + }, + "required": [ + "nameAvailable" + ], + "description": "Response of the CheckNameAvailability operation." + }, + "ApiManagementServiceUploadCertificateParameters": { + "properties": { + "type": { + "type": "string", + "description": "Hostname type.", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "certificate": { + "type": "string", + "description": "Base64 Encoded certificate." + }, + "certificate_password": { + "type": "string", + "description": "Certificate password." + } + }, + "required": [ + "type", + "certificate", + "certificate_password" + ], + "description": "Parameters supplied to the Upload SSL certificate for an API Management service operation." + }, + "ApiManagementServiceUpdateHostnameParameters": { + "properties": { + "update": { + "type": "array", + "items": { + "$ref": "#/definitions/HostnameConfiguration" + }, + "description": "Hostnames to create or update." + }, + "delete": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Proxy", + "Portal", + "Management", + "Scm" + ], + "x-ms-enum": { + "name": "HostnameType", + "modelAsString": false + } + }, + "description": "Hostnames types to delete." + } + }, + "description": "Parameters supplied to the UpdateHostname operation." + }, + "ErrorResponse": { + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error Response." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": { + } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimgroups.json index 0fff1a472d0d..087a6639dd89 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimgroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimgroups.json @@ -164,7 +164,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully." + "description": "Group was created successfully." }, "204": { "description": "Group already exists." @@ -463,7 +463,7 @@ "properties": { "id": { "type": "string", - "description": "Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupid} where {groupid} is a group identifier.", + "description": "Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier.", "readOnly": true }, "name": { 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 bff6c0769edc..939531ee1cd2 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 @@ -231,7 +231,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproperties.json index 1a2af137d417..a0ee7b187701 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproperties.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimproperties.json @@ -233,7 +233,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimreports.json index ed549ddd53d0..1e472cc2f61f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimreports.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimreports.json @@ -87,7 +87,7 @@ "required": false, "type": "string", "format": "duration", - "description": "By time interval. This value is only applicable to ByTime aggregation. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. This value is only applicable to ByTime aggregation. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -147,7 +147,7 @@ "interval": { "type": "integer", "format": "int64", - "description": "Length of agregation period." + "description": "Length of aggregation period." }, "country": { "type": "string", @@ -190,12 +190,12 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimsubscriptions.json index 1753adca409b..e89012bdc0bd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimsubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimsubscriptions.json @@ -188,7 +188,7 @@ "Subscriptions" ], "operationId": "Subscriptions_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "parameters": [ { "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" @@ -464,7 +464,7 @@ }, "productId": { "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + "description": "Product (product id path) for which subscription is being created in form /products/{productId}" }, "name": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimtenant.json index 9f641dfc8d0d..7c536e545f2c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimtenant.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimtenant.json @@ -334,7 +334,7 @@ ], "responses": { "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdeployment.json index 4008049ff1b6..8e66d6d2c763 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdeployment.json @@ -961,7 +961,7 @@ }, "virtualNetworkType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "default": "None", "enum": [ "None", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdiagnostics.json index 2a5970ae67e0..4264715afcae 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimdiagnostics.json @@ -75,7 +75,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics.", + "description": "Paged Result response of diagnostics.", "schema": { "$ref": "#/definitions/DiagnosticCollection" } @@ -364,7 +364,7 @@ "DiagnosticLoggers" ], "operationId": "DiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of the API Management service instance.", + "description": "Lists all loggers associated with the specified Diagnostic of the API Management service instance.", "x-ms-examples": { "ApiManagementListDiagnosticLoggers": { "$ref": "./examples/ApiManagementListDiagnosticLoggers.json" @@ -402,7 +402,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", + "description": "Paged Result response of loggers assigned to the specified Diagnostic.", "schema": { "$ref": "./apimloggers.json#/definitions/LoggerCollection" } @@ -469,7 +469,7 @@ "DiagnosticLoggers" ], "operationId": "DiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic.", + "description": "Attaches a logger to a diagnostic.", "x-ms-examples": { "ApiManagementCreateDiagnosticLogger": { "$ref": "./examples/ApiManagementCreateDiagnosticLogger.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json index 6a4a7b319333..a60cb1560060 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimgroups.json @@ -228,7 +228,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully.", + "description": "Group was created successfully.", "schema": { "$ref": "#/definitions/GroupContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimloggers.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimloggers.json index abbd3ffc0de6..b979e08bc884 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimloggers.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimloggers.json @@ -516,7 +516,7 @@ "description": "Sampling settings entity contract properties." } }, - "description": "Sampling settigs contract." + "description": "Sampling settings contract." }, "LoggerSamplingProperties": { "properties": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimportalsettings.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimportalsettings.json index 510e636edf18..4fab75fe7926 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimportalsettings.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimportalsettings.json @@ -662,7 +662,7 @@ }, "consentRequired": { "type": "boolean", - "description": "Ask user for concent." + "description": "Ask user for consent." } }, "description": "Terms of service contract properties." 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 b3f3e8516b5c..792eba383f65 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 @@ -300,7 +300,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproperties.json index c41100469738..0fdf926423a1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproperties.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimproperties.json @@ -305,7 +305,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "x-ms-examples": { "ApiManagementDeleteProperty": { "$ref": "./examples/ApiManagementDeleteProperty.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json index a7193cb4c8eb..ad1630e53c61 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimquotas.json @@ -46,8 +46,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeys": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeys.json" + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" } }, "parameters": [ @@ -144,8 +144,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeysByQuotaPeriod": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json" + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimreports.json index ae13e6a85779..3cfc28e6b785 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimreports.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimreports.json @@ -252,7 +252,7 @@ "Reports" ], "operationId": "Reports_ListByGeo", - "description": "Lists report records by GeoGraphy.", + "description": "Lists report records by geography.", "x-ms-examples": { "ApiManagementGetReportsByGeo": { "$ref": "./examples/ApiManagementGetReportsByGeo.json" @@ -390,7 +390,7 @@ "required": true, "type": "string", "format": "duration", - "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -502,7 +502,7 @@ }, "interval": { "type": "string", - "description": "Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." }, "country": { "type": "string", @@ -545,12 +545,12 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", @@ -685,7 +685,7 @@ }, "cache": { "type": "string", - "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend." + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." }, "apiTime": { "type": "number", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json index 730df28f501c..44e5ab3a4f0c 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimsubscriptions.json @@ -252,7 +252,7 @@ "Subscriptions" ], "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "x-ms-examples": { "ApiManagementUpdateSubscription": { "$ref": "./examples/ApiManagementUpdateSubscription.json" @@ -570,7 +570,7 @@ }, "productId": { "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + "description": "Product (product id path) for which subscription is being created in form /products/{productId}" }, "displayName": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json index 5f7a83abed39..15a95d020572 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtagresources.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "ApiManagementClient", - "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", + "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", "version": "2017-03-01" }, "host": "management.azure.com", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json index 346d32b09b51..30500bef3da7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtags.json @@ -222,7 +222,7 @@ ], "responses": { "201": { - "description": "Tag was created succesfully.", + "description": "Tag was created successfully.", "schema": { "$ref": "#/definitions/TagContract" } @@ -788,7 +788,7 @@ "ApiTagDescriptions" ], "operationId": "TagDescription_CreateOrUpdate", - "description": "Create/Update tag fescription in scope of the Api.", + "description": "Create/Update tag description in scope of the Api.", "x-ms-examples": { "ApiManagementCreateApiTagDescription": { "$ref": "./examples/ApiManagementCreateApiTagDescription.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json index ffc6a27d3ae7..1ff1ea3cd7db 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimtenant.json @@ -401,7 +401,7 @@ "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." }, "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounteryKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounterKeys.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounteryKeys.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounterKeys.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json index 16286cb719e9..a393af3575dd 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimapis.json @@ -2116,7 +2116,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics for an API.", + "description": "Paged Result response of diagnostics for an API.", "schema": { "$ref": "./apimdiagnostics.json#/definitions/DiagnosticCollection" } @@ -2411,7 +2411,7 @@ "ApiDiagnosticLoggers" ], "operationId": "ApiDiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of an API.", + "description": "Lists all loggers associated with the specified Diagnostic of an API.", "x-ms-examples": { "ApiManagementListApiDiagnosticLoggers": { "$ref": "./examples/ApiManagementListApiDiagnosticLoggers.json" @@ -2452,7 +2452,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", + "description": "Paged Result response of loggers assigned to the specified Diagnostic.", "schema": { "$ref": "./apimloggers.json#/definitions/LoggerCollection" } @@ -2525,7 +2525,7 @@ "ApiDiagnosticLoggers" ], "operationId": "ApiDiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic for an API.", + "description": "Attaches a logger to a diagnostic for an API.", "x-ms-examples": { "ApiManagementCreateApiDiagnosticLogger": { "$ref": "./examples/ApiManagementCreateApiDiagnosticLogger.json" @@ -2631,7 +2631,7 @@ "ApiIssues" ], "operationId": "ApiIssue_ListByService", - "description": "Lists all issues assosiated with the specified API.", + "description": "Lists all issues associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssues": { "$ref": "./examples/ApiManagementListApiIssues.json" @@ -2669,7 +2669,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issues for the API.", + "description": "Paged Result response of issues for the API.", "schema": { "$ref": "#/definitions/IssueCollection" } @@ -2976,7 +2976,7 @@ "ApiIssueComments" ], "operationId": "ApiIssueComment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueComments": { "$ref": "./examples/ApiManagementListApiIssueComments.json" @@ -3017,7 +3017,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueCommentCollection" } @@ -3277,7 +3277,7 @@ "ApiIssueAttachments" ], "operationId": "ApiIssueAttachment_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueAttachments": { "$ref": "./examples/ApiManagementListApiIssueAttachments.json" @@ -3318,7 +3318,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueAttachmentCollection" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json index 12a0ea9ff041..8680355c2a8e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimbackends.json @@ -748,7 +748,7 @@ "after": { "type": "string", "format": "duration", - "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconect is PT2M." + "description": "Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M." } }, "description": "Properties to control reconnect requests." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json index c93e303ca8b6..a3a6d8bc8496 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json @@ -680,7 +680,7 @@ "description": "Certificate Password." }, "storeName": { - "description": "The System.Security.Cryptography.x509certificates.Storename certificate store location. Only Root and CertificateAuthority are valid locations.", + "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.", "type": "string", "enum": [ "CertificateAuthority", @@ -981,7 +981,7 @@ }, "virtualNetworkType": { "type": "string", - "description": "The type of VPN in which API Managemet service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", + "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "default": "None", "enum": [ "None", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json index e1c5eb28a79a..0a46a4020ab5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdiagnostics.json @@ -75,7 +75,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics.", + "description": "Paged Result response of diagnostics.", "schema": { "$ref": "#/definitions/DiagnosticCollection" } @@ -355,7 +355,7 @@ "DiagnosticLoggers" ], "operationId": "DiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of the API Management service instance.", + "description": "Lists all loggers associated with the specified Diagnostic of the API Management service instance.", "x-ms-examples": { "ApiManagementListDiagnosticLoggers": { "$ref": "./examples/ApiManagementListDiagnosticLoggers.json" @@ -393,7 +393,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", + "description": "Paged Result response of loggers assigned to the specified Diagnostic.", "schema": { "$ref": "./apimloggers.json#/definitions/LoggerCollection" } @@ -463,7 +463,7 @@ "DiagnosticLoggers" ], "operationId": "DiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic.", + "description": "Attaches a logger to a diagnostic.", "x-ms-examples": { "ApiManagementCreateDiagnosticLogger": { "$ref": "./examples/ApiManagementCreateDiagnosticLogger.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json index 0e4e9aa54dd2..c759fba75274 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimgroups.json @@ -231,7 +231,7 @@ ], "responses": { "201": { - "description": "Group was created succesfully.", + "description": "Group was created successfully.", "schema": { "$ref": "#/definitions/GroupContract" } 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 0be80fe4fa76..8ba536db5863 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 @@ -299,7 +299,7 @@ ], "responses": { "204": { - "description": "No Content in case of Update Successfull." + "description": "No Content in case of Update Successful." }, "default": { "description": "Error response describing why the operation failed.", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json index 7b5a088a6b29..52feddada7aa 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimproperties.json @@ -304,7 +304,7 @@ "Property" ], "operationId": "Property_Delete", - "description": "Deletes specific property from the the API Management service instance.", + "description": "Deletes specific property from the API Management service instance.", "x-ms-examples": { "ApiManagementDeleteProperty": { "$ref": "./examples/ApiManagementDeleteProperty.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json index 1e41a13b0d24..789255ef73de 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimquotas.json @@ -46,8 +46,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeys": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeys.json" + "ApiManagementGetQuotaCounterKeys": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeys.json" } }, "parameters": [ @@ -144,8 +144,8 @@ "description": "Document describing how to configure the quota policies." }, "x-ms-examples": { - "ApiManagementGetQuotaCounteryKeysByQuotaPeriod": { - "$ref": "./examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json" + "ApiManagementGetQuotaCounterKeysByQuotaPeriod": { + "$ref": "./examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json index da029fd6e13b..eb27c6bc67eb 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimreports.json @@ -252,7 +252,7 @@ "Reports" ], "operationId": "Reports_ListByGeo", - "description": "Lists report records by GeoGraphy.", + "description": "Lists report records by geography.", "x-ms-examples": { "ApiManagementGetReportsByGeo": { "$ref": "./examples/ApiManagementGetReportsByGeo.json" @@ -390,7 +390,7 @@ "required": true, "type": "string", "format": "duration", - "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, secconds))" + "description": "By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, { "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" @@ -502,7 +502,7 @@ }, "interval": { "type": "string", - "description": "Length of agregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." + "description": "Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations)." }, "country": { "type": "string", @@ -545,12 +545,12 @@ "callCountSuccess": { "type": "integer", "format": "int32", - "description": "Number of succesful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" + "description": "Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect" }, "callCountBlocked": { "type": "integer", "format": "int32", - "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorize and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" + "description": "Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests" }, "callCountFailed": { "type": "integer", @@ -685,7 +685,7 @@ }, "cache": { "type": "string", - "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fullfilled by the backend." + "description": "Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend." }, "apiTime": { "type": "number", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json index 8f60defe345f..7a2793cf572f 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimsubscriptions.json @@ -258,7 +258,7 @@ "Subscriptions" ], "operationId": "Subscription_Update", - "description": "Updates the details of a subscription specificied by its identifier.", + "description": "Updates the details of a subscription specified by its identifier.", "x-ms-examples": { "ApiManagementUpdateSubscription": { "$ref": "./examples/ApiManagementUpdateSubscription.json" @@ -574,7 +574,7 @@ }, "productId": { "type": "string", - "description": "Product (product id path) for which subscription is being created in form /products/{productid}" + "description": "Product (product id path) for which subscription is being created in form /products/{productId}" }, "displayName": { "type": "string", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json index b659290eebc6..93c9b457c67a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtagresources.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "ApiManagementClient", - "description": "Use these REST APIs for queuering APIs. Operations and Products by tags in your Azure API Management deployment.", + "description": "Use these REST APIs for querying APIs. Operations and Products by tags in your Azure API Management deployment.", "version": "2018-01-01" }, "host": "management.azure.com", diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json index 0315b8ef4f7f..1fc6c77f883b 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtags.json @@ -222,7 +222,7 @@ ], "responses": { "201": { - "description": "Tag was created succesfully.", + "description": "Tag was created successfully.", "schema": { "$ref": "#/definitions/TagContract" } @@ -778,7 +778,7 @@ "ApiTagDescriptions" ], "operationId": "TagDescription_CreateOrUpdate", - "description": "Create/Update tag fescription in scope of the Api.", + "description": "Create/Update tag description in scope of the Api.", "x-ms-examples": { "ApiManagementCreateApiTagDescription": { "$ref": "./examples/ApiManagementCreateApiTagDescription.json" diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json index 92c495e33a0a..588672d22d9a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimtenant.json @@ -397,7 +397,7 @@ "description": "Accepted: Location header contains the URL where the status of the long running operation can be checked." }, "200": { - "description": "Result of appplying changes from Git branch to database.", + "description": "Result of applying changes from Git branch to database.", "schema": { "$ref": "#/definitions/OperationResultContract" } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounterKeys.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeys.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounterKeys.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounteryKeysByQuotaPeriod.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementGetQuotaCounterKeysByQuotaPeriod.json From cc624929338b4f308d63196e1b9ce84d67c65e34 Mon Sep 17 00:00:00 2001 From: Sergey Shandar Date: Thu, 29 Nov 2018 14:43:56 -0800 Subject: [PATCH 227/464] Update OAV to 0.9.6 (#4624) --- package.json | 4 ++-- .../2018-07-01/examples/BlobServicesPut.json | 16 ++++++++-------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/package.json b/package.json index 3c3bc19ff9ec..8d7a15738c6d 100644 --- a/package.json +++ b/package.json @@ -13,14 +13,14 @@ "@microsoft.azure/async-io": "^1.0.21", "@microsoft.azure/literate": "^1.0.21", "@microsoft.azure/polyfill": "^1.0.17", - "@ts-common/local-install": "^0.0.7", + "@ts-common/local-install": "^0.0.8", "fs-extra": "^3.0.1", "glob": "^5.0.14", "js-yaml": "^3.8.2", "json-schema-ref-parser": "^3.1.2", "mocha": "*", "oad": "^0.1.11", - "oav": "^0.9.5", + "oav": "^0.9.6", "request": "^2.61.0", "request-promise-native": "^1.0.5", "z-schema": "^3.24.2" diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json index 23110fcb5827..cc0c86e362ab 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json @@ -22,7 +22,7 @@ "OPTIONS", "MERGE", "PUT" - ], + ], "maxAgeInSeconds": 100, "exposedHeaders": [ "x-ms-meta-*" @@ -31,7 +31,7 @@ "x-ms-meta-abc", "x-ms-meta-data*", "x-ms-meta-target*" - ], + ] }, { "allowedOrigins": [ @@ -46,7 +46,7 @@ ], "allowedHeaders": [ "*" - ], + ] }, { "allowedOrigins": [ @@ -65,7 +65,7 @@ ], "allowedHeaders": [ "x-ms-meta-12345675754564*" - ], + ] } ] }, @@ -98,7 +98,7 @@ "OPTIONS", "MERGE", "PUT" - ], + ], "maxAgeInSeconds": 100, "exposedHeaders": [ "x-ms-meta-*" @@ -107,7 +107,7 @@ "x-ms-meta-abc", "x-ms-meta-data*", "x-ms-meta-target*" - ], + ] }, { "allowedOrigins": [ @@ -122,7 +122,7 @@ ], "allowedHeaders": [ "*" - ], + ] }, { "allowedOrigins": [ @@ -141,7 +141,7 @@ ], "allowedHeaders": [ "x-ms-meta-12345675754564*" - ], + ] } ] }, From e702cfdd4372a0c06c65c02750a3cee01418fbe3 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Thu, 29 Nov 2018 14:44:02 -0800 Subject: [PATCH 228/464] Generate README.md for JavaScript @azure/arm-network package (#4623) --- specification/network/resource-manager/readme.typescript.md | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/network/resource-manager/readme.typescript.md b/specification/network/resource-manager/readme.typescript.md index d957e3918245..f2bab9f6a07c 100644 --- a/specification/network/resource-manager/readme.typescript.md +++ b/specification/network/resource-manager/readme.typescript.md @@ -9,5 +9,4 @@ typescript: package-name: "@azure/arm-network" output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-network" generate-metadata: true - generate-readme-md: false ``` From d8ce5394d4c5cad11132040dbad7f9f378aca432 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 13:14:39 -0500 Subject: [PATCH 229/464] typo: Microsoft.Cdn (#4635) - subscitption -> subscription - consoto -> contoso - adress -> address --- .../Microsoft.Cdn/stable/2015-06-01/cdn.json | 2 +- .../Microsoft.Cdn/stable/2016-04-02/cdn.json | 2 +- .../Microsoft.Cdn/stable/2016-10-02/cdn.json | 4 ++-- .../Microsoft.Cdn/stable/2017-04-02/cdn.json | 4 ++-- .../Microsoft.Cdn/stable/2017-10-12/cdn.json | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json index 34f9c2e01425..0c4dedb6a91d 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2015-06-01/cdn.json @@ -39,7 +39,7 @@ "tags": [ "Profiles" ], - "summary": "Lists the CDN profiles within an Azure subscitption.", + "summary": "Lists the CDN profiles within an Azure subscription.", "operationId": "Profiles_ListBySubscriptionId", "parameters": [ { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json index ef70ba6063e4..fae70c4d47fd 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-04-02/cdn.json @@ -39,7 +39,7 @@ "tags": [ "Profiles" ], - "summary": "Lists the CDN profiles within an Azure subscitption.", + "summary": "Lists the CDN profiles within an Azure subscription.", "operationId": "Profiles_ListBySubscriptionId", "parameters": [ { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json index afb9c55f38d1..6d5bf2505ba5 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2016-10-02/cdn.json @@ -1810,7 +1810,7 @@ ], "properties": { "hostName": { - "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. consoto.azureedge.net", + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", "type": "string", "readOnly": true }, @@ -2155,7 +2155,7 @@ } }, "CustomDomain": { - "description": "Customer provided domain for branding purposes, e.g. www.consoto.com.", + "description": "Customer provided domain for branding purposes, e.g. www.contoso.com.", "type": "object", "allOf": [ { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json index ab181c0c2f75..53787b230576 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/cdn.json @@ -2038,7 +2038,7 @@ ], "properties": { "hostName": { - "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. consoto.azureedge.net", + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", "type": "string", "readOnly": true }, @@ -2389,7 +2389,7 @@ } }, "CustomDomain": { - "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.consoto.com.", + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", "type": "object", "allOf": [ { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json index 79ba38c81747..580c70d4d4d0 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/cdn.json @@ -2083,7 +2083,7 @@ ], "properties": { "hostName": { - "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. consoto.azureedge.net", + "description": "The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net", "type": "string", "readOnly": true }, @@ -2657,7 +2657,7 @@ } }, "CustomDomain": { - "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.consoto.com.", + "description": "Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.", "type": "object", "allOf": [ { @@ -3067,7 +3067,7 @@ "type": "object", "properties": { "baseIpAddress": { - "description": "Ip adress itself.", + "description": "Ip address itself.", "type": "string" }, "prefixLength": { From d6ad72734a6b1a86b68a5c331ec1d68b78379cbf Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 13:15:13 -0500 Subject: [PATCH 230/464] typo: azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin (#4614) - Double word "gallery" - metdata -> metadata --- .../preview/2015-04-01/GalleryItem.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json index 33ac4c08f312..c3ec9773d0fa 100644 --- a/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json +++ b/specification/azsadmin/resource-manager/gallery/Microsoft.Gallery.Admin/preview/2015-04-01/GalleryItem.json @@ -13,7 +13,7 @@ "/subscriptions/{subscriptionId}/providers/microsoft.gallery.admin/galleryItems": { "get": { "x-ms-examples": { - "Lists gallery gallery items.": { + "Lists gallery items.": { "$ref": "./examples/GalleryItem/List.json" } }, @@ -345,7 +345,7 @@ "readOnly": true }, "metadata": { - "description": "Custom item metdata.", + "description": "Custom item metadata.", "$ref": "#/definitions/OpenProperty", "readOnly": true }, From f47ba7f9c1508b131ed400c4022b59e3cf5882a9 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 13:31:18 -0500 Subject: [PATCH 231/464] typo: Microsoft.Batch (#4631) - coordianation -> coordination - updateable -> updatable - behaviour -> behavior - performExitOptionsJobAction camelcase - noAction camel case - terminateJob camel case - taskwithin -> task within - erro -> error - VNETs -> VNets --- .../stable/2015-12-01.2.2/BatchService.json | 4 +-- .../stable/2016-02-01.3.0/BatchService.json | 4 +-- .../stable/2016-07-01.3.1/BatchService.json | 34 +++++++++---------- .../stable/2017-01-01.4.0/BatchService.json | 14 ++++---- .../stable/2017-05-01.5.0/BatchService.json | 14 ++++---- .../stable/2017-06-01.5.1/BatchService.json | 14 ++++---- .../stable/2017-09-01.6.0/BatchService.json | 14 ++++---- .../stable/2018-03-01.6.1/BatchService.json | 14 ++++---- .../stable/2018-08-01.7.0/BatchService.json | 14 ++++---- .../stable/2017-09-01/BatchManagement.json | 2 +- 10 files changed, 64 insertions(+), 64 deletions(-) diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json index abf8f47f69b0..009f63beeb0a 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2015-12-01.2.2/BatchService.json @@ -11370,7 +11370,7 @@ }, "commandLine": { "type": "string", - "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation command line." + "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", @@ -11433,7 +11433,7 @@ }, "commandLine": { "type": "string", - "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation command line." + "description": "Gets or sets the command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json index 10ca4a85342c..85a34cb906bf 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2016-02-01.3.0/BatchService.json @@ -11812,7 +11812,7 @@ }, "commandLine": { "type": "string", - "description": "The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation command line." + "description": "The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", @@ -11875,7 +11875,7 @@ }, "commandLine": { "type": "string", - "description": "The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation command line." + "description": "The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordination command line." }, "resourceFiles": { "type": "array", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json index 5323a4b00787..d87ed82be381 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2016-07-01.3.1/BatchService.json @@ -2990,7 +2990,7 @@ ], "operationId": "JobSchedule_Update", "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4255,7 +4255,7 @@ ], "operationId": "Job_Update", "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -6878,7 +6878,7 @@ ], "operationId": "Pool_UpdateProperties", "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -8759,7 +8759,7 @@ ], "operationId": "ComputeNode_UpdateUser", "summary": "Updates the password or expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -10457,7 +10457,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties – that is, any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, or a scheduling error if the schedulingError property is not present.", - "description": "Note that the default condition does not include exit code 0. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "Note that the default condition does not include exit code 0. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -10502,8 +10502,8 @@ "properties": { "jobAction": { "type": "string", - "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job’s onTaskFailed property is 'performexitoptionsjobaction'.", - "description": "The default is none for exit code 0 and terminate for all other exit conditions. It is an error to specify this if the job's onTaskFailed is noaction. The add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job’s onTaskFailed property is 'performExitOptionsJobAction'.", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. It is an error to specify this if the job's onTaskFailed is noAction. The add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -10541,7 +10541,7 @@ "properties": { "id": { "type": "string", - "title": "A string that uniquely identifies the Job Manager taskwithin the job.", + "title": "A string that uniquely identifies the Job Manager task within the job.", "description": "The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." }, "displayName": { @@ -10978,7 +10978,7 @@ "onAllTasksComplete": { "type": "string", "title": "The action the Batch service should take when all tasks in a job created under this schedule are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a job manager task; if you want to use automatic job termination without a job manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a job manager task; if you want to use automatic job termination without a job manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. The default is noAction.", "enum": [ "noAction", "terminateJob" @@ -10988,7 +10988,7 @@ "onTaskFailure": { "type": "string", "title": "The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error.", - "description": "The default is noaction.", + "description": "The default is noAction.", "enum": [ "noAction", "performExitOptionsJobAction" @@ -11350,7 +11350,7 @@ "terminateReason": { "type": "string", "title": "A string describing the reason the job ended.", - "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete – the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry – the job reached its maxWallClockTime constraint. TerminateJobSchedule – the job ran as part of a schedule, and the schedule terminated. AllTasksComplete – the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed – the job's onTaskFailure attribute is set to performexitoptionsjobaction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." + "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete – the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry – the job reached its maxWallClockTime constraint. TerminateJobSchedule – the job ran as part of a schedule, and the schedule terminated. AllTasksComplete – the job's onAllTasksComplete attribute is set to terminateJob, and all tasks in the job are complete. TaskFailed – the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminateJob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." } }, "required": ["startTime"], @@ -11469,7 +11469,7 @@ "onAllTasksComplete": { "type": "string", "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Permitted values are: noaction – do nothing. The job remains active unless terminated or disabled by some other means. terminatejob – terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noaction.", + "description": "Permitted values are: noAction – do nothing. The job remains active unless terminated or disabled by some other means. terminateJob – terminate the job. The job's terminateReason is set to 'AllTasksComplete'. The default is noAction.", "enum": [ "noAction", "terminateJob" @@ -11479,7 +11479,7 @@ "onTaskFailure": { "type": "string", "title": "The action the Batch service should take when any task in the job fails. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error.", - "description": "Permitted values are: noaction – do nothing. performexitoptionsjobaction – take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noaction.", + "description": "Permitted values are: noAction – do nothing. performExitOptionsJobAction – take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", "enum": [ "noAction", "performExitOptionsJobAction" @@ -11556,7 +11556,7 @@ "onAllTasksComplete": { "type": "string", "title": "The action the Batch service should take when all tasks in the job are in the completed state.", - "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a job manager task; if you want to use automatic job termination without a job manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. Permitted values are: noaction – do nothing. The job remains active unless terminated or disabled by some other means. terminatejob – terminate the job. The job’s terminateReason is set to 'AllTasksComplete'. The default is noaction.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a job manager task; if you want to use automatic job termination without a job manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. Permitted values are: noAction – do nothing. The job remains active unless terminated or disabled by some other means. terminateJob – terminate the job. The job’s terminateReason is set to 'AllTasksComplete'. The default is noAction.", "enum": [ "noAction", "terminateJob" @@ -11566,7 +11566,7 @@ "onTaskFailure": { "type": "string", "title": "The action the Batch service should take when any task in the job fails. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error.", - "description": "Permitted values are: noaction – do nothing. performexitoptionsjobaction – take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noaction.", + "description": "Permitted values are: noAction – do nothing. performExitOptionsJobAction – take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction.", "enum": [ "noAction", "performExitOptionsJobAction" @@ -13193,7 +13193,7 @@ "onAllTasksComplete": { "type": "string", "title": "Specifies an action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction – that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminateJob to noAction – that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "noAction", "terminateJob" @@ -13250,7 +13250,7 @@ "onAllTasksComplete": { "type": "string", "title": "Specifies an action the Batch service should take when all tasks in the job are in the completed state.", - "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction.", + "description": "If omitted, the completion behavior is set to noAction. If the current value is terminateJob, this is an error because a job's completion behavior may not be changed from terminateJob to noAction.", "enum": [ "noAction", "terminateJob" diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json index 9a989687b1d7..e22497216879 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json @@ -3110,7 +3110,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4425,7 +4425,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7150,7 +7150,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9108,7 +9108,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password or expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -10868,7 +10868,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties - that is, any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, or a scheduling error if the schedulingError property is not present.", - "description": "Note that the default condition does not include exit code 0. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "Note that the default condition does not include exit code 0. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11031,7 +11031,7 @@ "properties": { "id": { "type": "string", - "title": "A string that uniquely identifies the Job Manager taskwithin the job.", + "title": "A string that uniquely identifies the Job Manager task within the job.", "description": "The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." }, "displayName": { @@ -14176,4 +14176,4 @@ } } } - + diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json index 38fb75cbe280..a7d0272f4233 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json @@ -3110,7 +3110,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4425,7 +4425,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7150,7 +7150,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9108,7 +9108,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password or expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -10872,7 +10872,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", - "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11057,7 +11057,7 @@ "properties": { "id": { "type": "string", - "title": "A string that uniquely identifies the Job Manager taskwithin the job.", + "title": "A string that uniquely identifies the Job Manager task within the job.", "description": "The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." }, "displayName": { @@ -14394,4 +14394,4 @@ } } } - + diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json index 5c116e442a53..75d807361e01 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json @@ -3111,7 +3111,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4426,7 +4426,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7249,7 +7249,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9207,7 +9207,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password and expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -10974,7 +10974,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", - "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11033,7 +11033,7 @@ "dependencyAction": { "type": "string", "title": "An action that the Batch service performs on tasks that depend on this task.", - "description": "Values are:\n\n satisfy - Satisfy the task's dependencies.\n block - Block the task's dependencies.\n\n The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an erro and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "Values are:\n\n satisfy - Satisfy the task's dependencies.\n block - Block the task's dependencies.\n\n The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "satisfy", "block" @@ -11276,7 +11276,7 @@ "userIdentity": { "$ref": "#/definitions/UserIdentity", "title": "The user identity under which the Job Preparation task runs.", - "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json index 000a8b1047c1..d4fd9d4145c2 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json @@ -3111,7 +3111,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4426,7 +4426,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7250,7 +7250,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9210,7 +9210,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password and expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -11024,7 +11024,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", - "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11069,7 +11069,7 @@ "jobAction": { "type": "string", "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", - "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -11370,7 +11370,7 @@ "userIdentity": { "$ref": "#/definitions/UserIdentity", "title": "The user identity under which the Job Preparation task runs.", - "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json index d474f05a9601..7e79e6181dcf 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json @@ -3251,7 +3251,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4569,7 +4569,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7405,7 +7405,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9368,7 +9368,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password and expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -11303,7 +11303,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", - "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11348,7 +11348,7 @@ "jobAction": { "type": "string", "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", - "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -11649,7 +11649,7 @@ "userIdentity": { "$ref": "#/definitions/UserIdentity", "title": "The user identity under which the Job Preparation task runs.", - "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json index 693ad843ae2e..59f829847444 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json @@ -3253,7 +3253,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4571,7 +4571,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7407,7 +7407,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9370,7 +9370,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password and expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -11306,7 +11306,7 @@ "default": { "$ref": "#/definitions/ExitOptions", "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", - "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." } }, "title": "Specifies how the Batch service should respond when the task completes." @@ -11351,7 +11351,7 @@ "jobAction": { "type": "string", "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", - "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noAction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", "enum": [ "none", "disable", @@ -11652,7 +11652,7 @@ "userIdentity": { "$ref": "#/definitions/UserIdentity", "title": "The user identity under which the Job Preparation task runs.", - "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json index 25aa294e41df..8973929eee8b 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2017-09-01/BatchManagement.json @@ -3206,7 +3206,7 @@ "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", "externalDocs": { "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", - "description": "Setting up RBAC for Azure Batch VNETs" + "description": "Setting up RBAC for Azure Batch VNets" } }, "endpointConfiguration": { From a4c8ee7dbb2237af2a1c2cd0fb0a38b2144e8b1d Mon Sep 17 00:00:00 2001 From: Jianping Zeng Date: Sat, 1 Dec 2018 02:53:12 +0800 Subject: [PATCH 232/464] Suppress the error because TagDetails is not an Azure resource (#4630) --- specification/resources/resource-manager/readme.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index ac4f25f891ea..974823e4faf3 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -315,6 +315,10 @@ directive: from: resources.json where: $.definitions.TagDetails reason: TagDetails will be deprecated soon + - suppress: XmsResourceInPutResponse + from: resources.json + where: $.paths["/subscriptions/{subscriptionId}/tagNames/{tagName}"].put + reason: TagDetails is not an Azure resource - suppress: BodyTopLevelProperties from: managedapplications.json where: $.definitions.Appliance.properties From 2f4118bf47f689088203b0b444f9038b150ad7c8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 13:54:15 -0500 Subject: [PATCH 233/464] typo: Microsoft.BotService (#4634) - Diplay -> Display --- .../preview/2017-12-01/botservice.json | 8 ++++---- .../preview/2018-07-12/botservice.json | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json index 0b368eefc5c7..d37741cf17ca 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2017-12-01/botservice.json @@ -1987,22 +1987,22 @@ }, "displayName": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "serviceProviderName": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "devPortalUrl": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "iconUrl": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "parameters": { diff --git a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json index dfa1e80e0ab6..f49c370b5504 100644 --- a/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json +++ b/specification/botservice/resource-manager/Microsoft.BotService/preview/2018-07-12/botservice.json @@ -2275,22 +2275,22 @@ }, "displayName": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "serviceProviderName": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "devPortalUrl": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "iconUrl": { "type": "string", - "description": "Diplay Name of the Service Provider", + "description": "Display Name of the Service Provider", "readOnly": true }, "parameters": { From 786508db13166eac99f0e9d9601c52c07c449499 Mon Sep 17 00:00:00 2001 From: Dongjiang You Date: Fri, 30 Nov 2018 11:08:48 -0800 Subject: [PATCH 234/464] Add network rule set properties, empty resource group validation (#4506) --- .../2017-06-01-preview/containerregistry.json | 2 +- .../stable/2017-03-01/containerregistry.json | 1 + .../stable/2017-10-01/containerregistry.json | 51 +++++++++++++++++++ .../2018-09-01/containerregistry_build.json | 3 +- 4 files changed, 55 insertions(+), 2 deletions(-) diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json index 9e75d18d5dc3..1c29a5ce2ba1 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2017-06-01-preview/containerregistry.json @@ -1856,7 +1856,7 @@ "type": "integer" }, "digest": { - "description": "The digest of the content, as defined by the Registry V2 HTTP API Specificiation.", + "description": "The digest of the content, as defined by the Registry V2 HTTP API Specification.", "type": "string" }, "length": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json index 139bd6d5680c..418765d1df55 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-03-01/containerregistry.json @@ -808,6 +808,7 @@ "description": "The name of the resource group to which the container registry belongs.", "required": true, "type": "string", + "minLength": 1, "x-ms-parameter-location": "method" }, "RegistryNameParameter": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json index 3bfc07179b16..17f43a114a38 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json @@ -1497,6 +1497,10 @@ "storageAccount": { "$ref": "#/definitions/StorageAccountProperties", "description": "The properties of the storage account for the container registry. Only applicable to Classic SKU." + }, + "networkRuleSet": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "The network rule set for a container registry." } } }, @@ -1535,6 +1539,48 @@ } } }, + "NetworkRuleSet": { + "description": "The network rule set for a container registry.", + "required": [ + "defaultAction" + ], + "type": "object", + "properties": { + "defaultAction": { + "description": "The default action of allow or deny when no other rules match.", + "default": "Allow", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "description": "The virtual network rules.", + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + } + } + }, + "VirtualNetworkRule": { + "description": "The virtual network rule for a container registry.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.", + "type": "string" + } + } + }, "RegistryUpdateParameters": { "description": "The parameters for updating a container registry.", "type": "object", @@ -1568,6 +1614,10 @@ "storageAccount": { "$ref": "#/definitions/StorageAccountProperties", "description": "The parameters of a storage account for the container registry. Only applicable to Classic SKU. If specified, the storage account must be in the same physical location as the container registry." + }, + "networkRuleSet": { + "$ref": "#/definitions/NetworkRuleSet", + "description": "The network rule set for a container registry." } } }, @@ -2370,6 +2420,7 @@ "description": "The name of the resource group to which the container registry belongs.", "required": true, "type": "string", + "minLength": 1, "x-ms-parameter-location": "method" }, "RegistryNameParameter": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json index 38cbcb137517..cdd6a36968d5 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json @@ -1060,7 +1060,7 @@ } }, "Task": { - "description": "The task that has the ARM resource and task properties. \r\nThe task will have all information to schedule a run against it.", + "description": "The task that has the ARM resource and task properties. \r\nThe task will have all information to schedule a run against it.", "type": "object", "allOf": [ { @@ -2194,6 +2194,7 @@ "description": "The name of the resource group to which the container registry belongs.", "required": true, "type": "string", + "minLength": 1, "x-ms-parameter-location": "method" }, "RegistryNameParameter": { From 0882bff9015a676ff71e1aa4cec5f0534554be8d Mon Sep 17 00:00:00 2001 From: Samir Solanki Date: Fri, 30 Nov 2018 13:37:26 -0800 Subject: [PATCH 235/464] Added example for template params (#4602) --- .../preview/2018-06-01-preview/apimapis.json | 3 + .../ApiManagementGetApiOperationPetstore.json | 91 +++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json index 86a665fe95dd..77b2b292b596 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -919,6 +919,9 @@ "x-ms-examples": { "ApiManagementGetApiOperation": { "$ref": "./examples/ApiManagementGetApiOperation.json" + }, + "ApiManagementGetApiOperationPetstore": { + "$ref": "./examples/ApiManagementGetApiOperationPetstore.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json new file mode 100644 index 000000000000..8cb2bae00f97 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "apiId": "swagger-petstore", + "operationId": "loginUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/swagger-petstore/operations/loginUser", + "type": "Microsoft.ApiManagement/service/apis/operations", + "name": "loginUser", + "properties": { + "displayName": "Logs user into the system", + "method": "GET", + "urlTemplate": "/user/login?username={username}&password={password}", + "templateParameters": [ + { + "name": "username", + "description": "The user name for login", + "type": "string", + "required": true, + "values": [] + }, + { + "name": "password", + "description": "The password for login in clear text", + "type": "string", + "required": true, + "values": [] + } + ], + "description": "", + "request": { + "queryParameters": [], + "headers": [], + "representations": [] + }, + "responses": [ + { + "statusCode": 200, + "description": "successful operation", + "representations": [ + { + "contentType": "application/xml", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationXmlResponse" + }, + { + "contentType": "application/json", + "schemaId": "5ba91a35f373b513a0bf31c6", + "typeName": "UserLoginGet200ApplicationJsonResponse" + } + ], + "headers": [ + { + "name": "X-Rate-Limit", + "description": "calls per hour allowed by the user", + "type": "integer", + "values": [] + }, + { + "name": "X-Expires-After", + "description": "date in UTC when token expires", + "type": "string", + "values": [] + } + ] + }, + { + "statusCode": 400, + "description": "Invalid username/password supplied", + "representations": [ + { + "contentType": "application/xml" + }, + { + "contentType": "application/json" + } + ], + "headers": [] + } + ] + } + } + } + } +} \ No newline at end of file From 3cba10b4e5ef315864b4df7eb8327116303202c7 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 17:12:23 -0500 Subject: [PATCH 236/464] typo: Microsoft.Subscriptions (#4616) - specifed -> specified --- .../preview/2015-11-01/Subscriptions.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json index 9a37b4ff166f..c8e9139bf124 100644 --- a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json @@ -114,11 +114,11 @@ }, "delete": { "x-ms-examples": { - "Delete the specifed subscription": { + "Delete the specified subscription": { "$ref": "./examples/Subscriptions/Delete.json" } }, - "description": "Delete the specifed subscription.", + "description": "Delete the specified subscription.", "tags": [ "Subscriptions" ], From 322c47d43e8ce48aeb5d018e32c2b44a31243b13 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 17:12:57 -0500 Subject: [PATCH 237/464] typo: Microsoft.Automation (#4608) - specifc -> specific - theresource -> the resource - detailes -> Details - souce -> source - occured -> occurred - cerdential -> credential - madatory -> mandatory - infomration -> information - runas -> RunAs - dratft -. draft - varible -> variable --- .../softwareUpdateConfiguration.json | 2 +- .../softwareUpdateConfigurationMachineRun.json | 4 ++-- .../softwareUpdateConfigurationRun.json | 2 +- .../2017-05-15-preview/sourceControl.json | 2 +- .../2017-05-15-preview/sourceControlSyncJob.json | 2 +- .../stable/2015-10-31/connectionType.json | 16 ++++++++-------- .../stable/2015-10-31/credential.json | 2 +- .../stable/2015-10-31/dscConfiguration.json | 2 +- .../stable/2015-10-31/dscNode.json | 6 +++--- .../2015-10-31/hybridRunbookWorkerGroup.json | 2 +- .../stable/2015-10-31/runbook.json | 6 +++--- .../stable/2015-10-31/variable.json | 4 ++-- .../stable/2018-01-15/dscNode.json | 6 +++--- .../stable/2018-01-15/dscNodeConfiguration.json | 2 +- .../stable/2018-06-30/runbook.json | 6 +++--- 15 files changed, 32 insertions(+), 32 deletions(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json index 53ee14a4786c..2862d3dbe5ed 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json @@ -449,7 +449,7 @@ }, "updateConfiguration": { "type": "object", - "description": "Update specifc properties of the software update configuration.", + "description": "Update specific properties of the software update configuration.", "properties": { "operatingSystem": { "description": "operating system of target machines", diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json index f50ae709bc78..2c377a447753 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationMachineRun.json @@ -273,7 +273,7 @@ }, "creationTime": { "type": "string", - "description": "Creation time of theresource, which only appears in the response.", + "description": "Creation time of the resource, which only appears in the response.", "format": "date-time", "x-nullable": false, "readOnly": true @@ -296,7 +296,7 @@ "readOnly": true }, "error": { - "description": "detailes of provisioning error", + "description": "Details of provisioning error", "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" } } diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json index 9285acfd9912..0769bb0f3e95 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfigurationRun.json @@ -241,7 +241,7 @@ }, "creationTime": { "type": "string", - "description": "Creation time of theresource, which only appears in the response.", + "description": "Creation time of the resource, which only appears in the response.", "format": "date-time", "x-nullable": false, "readOnly": true diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json index 5020260f31a6..c697aac08465 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControl.json @@ -323,7 +323,7 @@ "items": { "$ref": "#/definitions/SourceControl" }, - "description": "The list of souce controls." + "description": "The list of source controls." }, "nextLink": { "type": "string", diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json index c5479ea3938a..930d251408f8 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/sourceControlSyncJob.json @@ -337,7 +337,7 @@ }, "exception": { "type": "string", - "description": "The exceptions that occured while running the sync job." + "description": "The exceptions that occurred while running the sync job." } }, "description": "Definition of source control sync job properties." diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json index 86ce028c111b..3cc338d3857f 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/connectionType.json @@ -42,7 +42,7 @@ "ConnectionType" ], "operationId": "ConnectionType_Delete", - "description": "Delete the connectiontype.", + "description": "Delete the connection type.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, @@ -63,7 +63,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of connectiontype." + "description": "The name of connection type." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -92,7 +92,7 @@ "ConnectionType" ], "operationId": "ConnectionType_Get", - "description": "Retrieve the connectiontype identified by connectiontype name.", + "description": "Retrieve the connection type identified by connection type name.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, @@ -113,7 +113,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of connectiontype." + "description": "The name of connection type." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -142,7 +142,7 @@ "ConnectionType" ], "operationId": "ConnectionType_CreateOrUpdate", - "description": "Create a connectiontype.", + "description": "Create a connection type.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, @@ -163,7 +163,7 @@ "in": "path", "required": true, "type": "string", - "description": "The parameters supplied to the create or update connectiontype operation." + "description": "The parameters supplied to the create or update connection type operation." }, { "name": "parameters", @@ -172,7 +172,7 @@ "schema": { "$ref": "#/definitions/ConnectionTypeCreateOrUpdateParameters" }, - "description": "The parameters supplied to the create or update connectiontype operation." + "description": "The parameters supplied to the create or update connection type operation." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -209,7 +209,7 @@ "ConnectionType" ], "operationId": "ConnectionType_ListByAutomationAccount", - "description": "Retrieve a list of connectiontypes.", + "description": "Retrieve a list of connection types.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/connectiontypeoperations" }, diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json index 48c5a28eaaf7..6827344a65b1 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/credential.json @@ -325,7 +325,7 @@ "userName", "password" ], - "description": "The properties of the create cerdential operation." + "description": "The properties of the create credential operation." }, "CredentialCreateOrUpdateParameters": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json index 04cffd4f97e2..f2a9cfc0f52c 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json @@ -536,7 +536,7 @@ }, "isMandatory": { "type": "boolean", - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." + "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json index c00713074db4..ee4f668f6105 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNode.json @@ -599,10 +599,10 @@ "properties": { "name": { "type": "string", - "description": "Gets or sets the name of the dsc nodeconfiguration." + "description": "Gets or sets the name of the dsc node configuration." } }, - "description": "The dsc nodeconfiguration property associated with the entity." + "description": "The dsc node configuration property associated with the entity." }, "DscNodeReportListResult": { "properties": { @@ -863,7 +863,7 @@ "description": "Gets or sets the id." } }, - "description": "Definition of the agent registration infomration type." + "description": "Definition of the agent registration information type." }, "DscNode": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json index 258cff1dad94..4ec18edd741a 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/hybridRunbookWorkerGroup.json @@ -259,7 +259,7 @@ "description": "Gets or sets the name of the credential." } }, - "description": "Definition of runas credential to use for hybrid worker." + "description": "Definition of RunAs credential to use for hybrid worker." }, "HybridRunbookWorker": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json index 247c2a567486..5965f7e7442b 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/runbook.json @@ -1401,7 +1401,7 @@ "type": "string" } }, - "description": "The response model for the undoedit runbook operation." + "description": "The response model for the undo edit runbook operation." }, "RunbookDraft": { "properties": { @@ -1449,7 +1449,7 @@ }, "isMandatory": { "type": "boolean", - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." + "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", @@ -1590,7 +1590,7 @@ "runbookType", "draft" ], - "description": "The parameters supplied to the create or update dratft runbook properties." + "description": "The parameters supplied to the create or update draft runbook properties." }, "RunbookCreateOrUpdateDraftParameters": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json index 29c3074579ee..359536450396 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/variable.json @@ -360,7 +360,7 @@ "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], - "description": "Definition of the varible." + "description": "Definition of the variable." }, "VariableListResult": { "properties": { @@ -433,7 +433,7 @@ "description": "Gets or sets the description." } }, - "description": "Definition of the varible properties" + "description": "Definition of the variable properties" } }, "parameters": {} diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json index a569b4507507..6e62148cc491 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNode.json @@ -837,7 +837,7 @@ "description": "Gets or sets the id." } }, - "description": "Definition of the agent registration infomration type." + "description": "Definition of the agent registration information type." }, "AgentRegistrationKeys": { "properties": { @@ -938,10 +938,10 @@ "properties": { "name": { "type": "string", - "description": "Gets or sets the name of the dsc nodeconfiguration." + "description": "Gets or sets the name of the dsc node configuration." } }, - "description": "The dsc nodeconfiguration property associated with the entity." + "description": "The dsc node configuration property associated with the entity." }, "AgentRegistrationRegenerateKeyParameter": { "properties": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json index f81a73b5f6fb..0d187be3f4a7 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-01-15/dscNodeConfiguration.json @@ -371,7 +371,7 @@ "nodeCount":{ "type": "integer", "format": "int64", - "description": "Number of nodes with this nodeconfiguration assigned" + "description": "Number of nodes with this node configuration assigned" }, "incrementNodeConfigurationBuild": { "type": "boolean", diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json index 0c215f28ea28..3e5746376679 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json @@ -1475,7 +1475,7 @@ "type": "string" } }, - "description": "The response model for the undoedit runbook operation." + "description": "The response model for the undo edit runbook operation." }, "RunbookDraft": { "properties": { @@ -1523,7 +1523,7 @@ }, "isMandatory": { "type": "boolean", - "description": "Gets or sets a Boolean value to indicate whether the parameter is madatory or not." + "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", @@ -1664,7 +1664,7 @@ "runbookType", "draft" ], - "description": "The parameters supplied to the create or update dratft runbook properties." + "description": "The parameters supplied to the create or update draft runbook properties." }, "RunbookCreateOrUpdateDraftParameters": { "properties": { From b7f6170795515f6351bd35880178872508278fb5 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 17:13:37 -0500 Subject: [PATCH 238/464] typo: Microsoft.Blueprint (#4633) - fullfillment -> fulfillment - deinition -> definition - policyAssginment -> policyAssignment --- .../preview/2017-11-11-preview/blueprintAssignment.json | 2 +- .../preview/2017-11-11-preview/blueprintDefinition.json | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json index fe32bc4b17bd..9c4b7530d349 100644 --- a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintAssignment.json @@ -335,7 +335,7 @@ "type": "object", "properties": {}, "additionalProperties": { - "description": "keyValue pair of parameter fullfillment.", + "description": "keyValue pair of parameter fulfillment.", "$ref": "#/definitions/ParameterValueBase" } }, diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json index 2a4c12664a30..cc7b0701efd8 100644 --- a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json @@ -130,7 +130,7 @@ ], "responses": { "200": { - "description": "OK -- blueprint deinition deleted", + "description": "OK -- blueprint definition deleted", "schema": { "$ref": "#/definitions/Blueprint" } @@ -987,7 +987,7 @@ "x-ms-discriminator-value": "policyAssignment", "properties": { "properties": { - "description": "properties for policyAssginment Artifact", + "description": "properties for policyAssignment Artifact", "x-ms-client-flatten": true, "$ref": "#/definitions/PolicyAssignmentArtifactProperties" } @@ -1006,7 +1006,7 @@ "type": "object", "properties": {}, "additionalProperties": { - "description": "keyValue pair of parameter fullfillment.", + "description": "keyValue pair of parameter fulfillment.", "$ref": "#/definitions/ParameterValueBase" } }, From c64f4588884fc0bed2f8980c08a3977a52c09595 Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Fri, 30 Nov 2018 14:23:10 -0800 Subject: [PATCH 239/464] Add offlineDataTransferStatus (#4598) --- .../2018-10-01/examples/ServerEndpoints_Get.json | 3 ++- .../examples/ServerEndpoints_ListBySyncGroup.json | 6 ++++-- .../examples/ServerEndpoints_Update.json | 3 ++- .../preview/2018-10-01/storagesync.json | 14 ++++++++++++++ 4 files changed, 22 insertions(+), 4 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json index 6cd5540ed2aa..1f4d3fcd3c08 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Get.json @@ -42,7 +42,8 @@ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", "lastSyncPerItemErrorCount": 0 }, - "currentProgress": null + "currentProgress": null, + "offlineDataTransferStatus": "NotRunning" }, "offlineDataTransfer": "on", "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json index 076baf7fe3dc..82ead36534fb 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_ListBySyncGroup.json @@ -42,7 +42,8 @@ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", "lastSyncPerItemErrorCount": 0 }, - "currentProgress": null + "currentProgress": null, + "offlineDataTransferStatus": "NotRunning" }, "offlineDataTransfer": "on", "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", @@ -80,7 +81,8 @@ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", "lastSyncPerItemErrorCount": 0 }, - "currentProgress": null + "currentProgress": null, + "offlineDataTransferStatus": "NotRunning" }, "offlineDataTransfer": "off" }, diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json index a1875bc3e672..191dc27c285e 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/examples/ServerEndpoints_Update.json @@ -51,7 +51,8 @@ "lastSyncSuccessTimestamp": "2018-06-11T23:28:33.9217334Z", "lastSyncPerItemErrorCount": 0 }, - "currentProgress": null + "currentProgress": null, + "offlineDataTransferStatus": "NotRunning" }, "offlineDataTransfer": "off", "offlineDataTransferStorageAccountResourceId": "/subscriptions/744f4d70-6d17-4921-8970-a765d14f763f/resourceGroups/myRG/providers/Microsoft.Storage/storageAccounts/mysa", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index 230434c6450a..85109f747819 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -3413,6 +3413,10 @@ "currentProgress": { "$ref": "#/definitions/SyncProgressStatus", "description": "Current progress" + }, + "offlineDataTransferStatus": { + "$ref": "#/definitions/OfflineDataTransferState", + "description": "Offline Data Transfer State" } } }, @@ -3518,6 +3522,16 @@ "NoActivity" ] }, + "OfflineDataTransferState": { + "type": "string", + "description": "Type of the Health state", + "enum": [ + "InProgress", + "Stopping", + "NotRunning", + "Complete" + ] + }, "WorkflowStatus": { "type": "string", "description": "Type of the Workflow Status", From a1d1c199d0aeee081315f772e10dd8184475fa3d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 30 Nov 2018 17:23:51 -0500 Subject: [PATCH 240/464] typo: network/resource-manager/Microsoft.Network/expressRouteCircuit (#4530) - opertion -> operation - ExpressRouteServiceProdiver -> ExpressRouteServiceProvider - Spepcified -> Specified - Succeded -> Succeeded --- .../stable/2015-06-15/expressRouteCircuit.json | 8 ++++---- .../stable/2016-09-01/expressRouteCircuit.json | 2 +- .../stable/2016-12-01/expressRouteCircuit.json | 2 +- .../stable/2017-03-01/expressRouteCircuit.json | 2 +- .../stable/2017-06-01/expressRouteCircuit.json | 4 ++-- .../stable/2017-08-01/expressRouteCircuit.json | 4 ++-- .../stable/2017-09-01/expressRouteCircuit.json | 4 ++-- .../stable/2017-10-01/expressRouteCircuit.json | 4 ++-- .../stable/2017-11-01/expressRouteCircuit.json | 4 ++-- .../stable/2018-01-01/expressRouteCircuit.json | 4 ++-- .../stable/2018-02-01/expressRouteCircuit.json | 8 ++++---- .../stable/2018-04-01/expressRouteCircuit.json | 8 ++++---- .../stable/2018-06-01/expressRouteCircuit.json | 8 ++++---- .../stable/2018-07-01/expressRouteCircuit.json | 8 ++++---- .../stable/2018-08-01/expressRouteCircuit.json | 8 ++++---- 15 files changed, 39 insertions(+), 39 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json index 11cbd6da6927..210f662aedca 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2015-06-15/expressRouteCircuit.json @@ -568,7 +568,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListArpTable", - "description": "The ListArpTable from ExpressRouteCircuit opertion retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListArpTable from ExpressRouteCircuit operation retrieves the currently advertised arp table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -610,7 +610,7 @@ "ExpressRouteCircuits" ], "operationId": "ExpressRouteCircuits_ListRoutesTable", - "description": "The ListRoutesTable from ExpressRouteCircuit opertion retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", + "description": "The ListRoutesTable from ExpressRouteCircuit operation retrieves the currently advertised routes table associated with the ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -652,7 +652,7 @@ "ExpressRouteCircuitStats" ], "operationId": "ExpressRouteCircuits_ListStats", - "description": "The Liststats ExpressRouteCircuit opertion retrieves all the stats from a ExpressRouteCircuits in a resource group.", + "description": "The ListStats ExpressRouteCircuit operation retrieves all the stats from a ExpressRouteCircuits in a resource group.", "parameters": [ { "name": "resourceGroupName", @@ -768,7 +768,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/expressRouteCircuit.json index 82d2a2802218..ba4f28159006 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-09-01/expressRouteCircuit.json @@ -897,7 +897,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/expressRouteCircuit.json index 2ada476f6deb..87869baabb09 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2016-12-01/expressRouteCircuit.json @@ -897,7 +897,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json index ae0a7808e0bc..7997c1fb8078 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-03-01/expressRouteCircuit.json @@ -897,7 +897,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/expressRouteCircuit.json index 71218d3f8030..d12bec574696 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/expressRouteCircuit.json @@ -897,7 +897,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -987,7 +987,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/expressRouteCircuit.json index 9b1a2923d6e3..47762908dddd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/expressRouteCircuit.json @@ -897,7 +897,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -987,7 +987,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json index 6acfc710aeec..66eb6522827e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/expressRouteCircuit.json @@ -947,7 +947,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1037,7 +1037,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json index 240d3b2c37ab..5266b1b15ad3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/expressRouteCircuit.json @@ -947,7 +947,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1037,7 +1037,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json index 278d2eeaa759..c8cc5c062843 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/expressRouteCircuit.json @@ -947,7 +947,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1037,7 +1037,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json index d03cb19fe98f..c7950f3c8c28 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/expressRouteCircuit.json @@ -947,7 +947,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1037,7 +1037,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCircuit.json index 2eba84329f7f..94c3ade53d43 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/expressRouteCircuit.json @@ -587,7 +587,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1139,7 +1139,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1229,7 +1229,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1503,7 +1503,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json index f0ef5e3987dd..de6fe358fb5a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/expressRouteCircuit.json @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -1189,7 +1189,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1282,7 +1282,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1556,7 +1556,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCircuit.json index 1da7d004ace3..c203762fb739 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/expressRouteCircuit.json @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -1189,7 +1189,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1282,7 +1282,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1556,7 +1556,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCircuit.json index 9ac3a3ddff2a..ba40aecf6ce0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/expressRouteCircuit.json @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -1189,7 +1189,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1282,7 +1282,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1556,7 +1556,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json index 94be802019aa..eb518eeba43f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/expressRouteCircuit.json @@ -607,7 +607,7 @@ "schema": { "$ref": "#/definitions/ExpressRouteCircuitConnection" }, - "description": "Parameters supplied to the create or update express route circuit circuit connection operation." + "description": "Parameters supplied to the create or update express route circuit connection operation." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -1189,7 +1189,7 @@ ], "responses": { "200": { - "description": "Request successful. The operation returns a list of ExpressRouteServiceProdiver resources.", + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", "schema": { "$ref": "#/definitions/ExpressRouteServiceProviderListResult" } @@ -1282,7 +1282,7 @@ "items": { "type": "string" }, - "description": "The communities of bgp peering. Spepcified for microsoft peering" + "description": "The communities of bgp peering. Specified for microsoft peering" }, "advertisedPublicPrefixesState": { "type": "string", @@ -1560,7 +1560,7 @@ "provisioningState": { "type": "string", "readOnly": true, - "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeded', 'Updating', 'Deleting', and 'Failed'." + "description": "Provisioning state of the circuit connection resource. Possible values are: 'Succeeded', 'Updating', 'Deleting', and 'Failed'." } } }, From 3aaf27bb847082a83041a84d64659a322623321b Mon Sep 17 00:00:00 2001 From: hari-bodicherla <43284966+hari-bodicherla@users.noreply.github.com> Date: Fri, 30 Nov 2018 17:11:37 -0800 Subject: [PATCH 241/464] updated Reimage API documentation in compute json for ephemeral os disks (#4644) * Added diffDiskSettings property as part of Swagger changes needed for Ephemeral VM\VMSS * updated comment * updated swagger specs for diffdisksettings property * updated swagger spec comments for diff disk settings [property * added example to create Diff OS disk scaleset * updated 2018-10-01 version specs with diffdisk property * added example file for creating VM with diffdisksettings property * updated swagger changes for reimage operation in single vm * update examples * udpated examples * fixed validation errors * updated comments for reimage operation documentation --- .../stable/2018-06-01/compute.json | 20 ++++++++-------- .../stable/2018-10-01/compute.json | 24 +++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index 8f2567920268..a5c553e4825b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -1566,7 +1566,7 @@ "Create a custom-image vm from an unmanaged generalized os image.": { "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" }, - "Create a vm with differencing os disk.": { + "Create a vm with ephemeral os disk.": { "$ref": "./examples/CreateAVmWithADiffOsDisk.json" } } @@ -2143,7 +2143,7 @@ "VirtualMachines" ], "operationId": "VirtualMachines_Reimage", - "description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", "parameters": [ { "name": "resourceGroupName", @@ -2321,7 +2321,7 @@ "Create a scale set with virtual machines in different zones.": { "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" }, - "Create a scale set with differencing os disks.": { + "Create a scale set with ephemeral os disks.": { "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" } } @@ -3239,7 +3239,7 @@ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Reimage", - "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", "parameters": [ { "name": "resourceGroupName", @@ -4918,7 +4918,7 @@ "properties": { "tempDisk": { "type": "boolean", - "description": "Specified whether to reimage temp disk. Default value: false." + "description": "Specifies whether to reimage temp disk. Default value: false." } }, "description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true." @@ -5309,7 +5309,7 @@ }, "DiffDiskOption": { "type": "string", - "description": "Specifies the differencing disk option for operating system disk.", + "description": "Specifies the ephemeral disk option for operating system disk.", "enum": [ "Local" ], @@ -5322,10 +5322,10 @@ "properties": { "option": { "$ref": "#/definitions/DiffDiskOption", - "description": "Specifies the differencing disk settings for operating system disk." + "description": "Specifies the ephemeral disk settings for operating system disk." } }, - "description": "Describes the parameters of differencing disk settings that can be be specified for operating system disk.

NOTE: The differencing disk settings can only be specified for managed disk." + "description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." }, "ManagedDiskParameters": { "properties": { @@ -5381,7 +5381,7 @@ }, "diffDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine." + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." }, "createOption": { "$ref": "#/definitions/CreateOption", @@ -6552,7 +6552,7 @@ }, "diffDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." }, "diskSizeGB": { "type": "integer", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index b0115f09d8f5..92c5580eca94 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -1566,7 +1566,7 @@ "Create a custom-image vm from an unmanaged generalized os image.": { "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" }, - "Create a vm with differencing os disk.": { + "Create a vm with ephemeral os disk.": { "$ref": "./examples/CreateAVmWithADiffOsDisk.json" } } @@ -2143,7 +2143,7 @@ "VirtualMachines" ], "operationId": "VirtualMachines_Reimage", - "description": "Reimages (upgrade the operating system) virtual machine. This operation is only supported for differencing OS disks.", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", "parameters": [ { "name": "resourceGroupName", @@ -2152,7 +2152,7 @@ "type": "string", "description": "The name of the resource group." }, - { + { "name": "vmName", "in": "path", "required": true, @@ -2321,7 +2321,7 @@ "Create a scale set with virtual machines in different zones.": { "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" }, - "Create a scale set with differencing os disks.": { + "Create a scale set with ephemeral os disks.": { "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" } } @@ -3239,7 +3239,7 @@ "VirtualMachineScaleSets" ], "operationId": "VirtualMachineScaleSets_Reimage", - "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set.", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", "parameters": [ { "name": "resourceGroupName", @@ -4933,10 +4933,10 @@ "properties": { "tempDisk": { "type": "boolean", - "description": "Specified whether to reimage temp disk. Default value: false." + "description": "Specifies whether to reimage temp disk. Default value: false." } }, - "description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true." + "description": "Paramaters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" }, "VirtualMachineCaptureParameters": { "properties": { @@ -5324,7 +5324,7 @@ }, "DiffDiskOption": { "type": "string", - "description": "Specifies the differencing disk option for operating system disk.", + "description": "Specifies the ephemeral disk option for operating system disk.", "enum": [ "Local" ], @@ -5337,10 +5337,10 @@ "properties": { "option": { "$ref": "#/definitions/DiffDiskOption", - "description": "Specifies the differencing disk settings for operating system disk." + "description": "Specifies the ephemeral disk settings for operating system disk." } }, - "description": "Describes the parameters of differencing disk settings that can be be specified for operating system disk.

NOTE: The differencing disk settings can only be specified for managed disk." + "description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." }, "ManagedDiskParameters": { "properties": { @@ -5396,7 +5396,7 @@ }, "diffDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine." + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." }, "createOption": { "$ref": "#/definitions/CreateOption", @@ -6567,7 +6567,7 @@ }, "diffDiskSettings": { "$ref": "#/definitions/DiffDiskSettings", - "description": "Specifies the differencing Disk Settings for the operating system disk used by the virtual machine scale set." + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." }, "diskSizeGB": { "type": "integer", From 87fb4990791393d7e3693b3389630e1f04210cb5 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:19:59 -0500 Subject: [PATCH 242/464] typo: monitor/resource-manager/microsoft.insights (#4717) - datatimes ->datetimes - calcualte -> calculate - timezones -> time zones - blongs -> belongs - defintions -> definitions - definitons -> definitions - defitinitons -> definitions - Speficies -> Specifies - webook -> webhook - Acount -> Account - scheduledquery -> scheduled query - Frequnecy -> Frequency - Specifiy -> Specify --- .../preview/2017-05-01-preview/metrics_API.json | 6 +++--- .../preview/2017-11-01-preview/baseline_API.json | 4 ++-- .../2017-11-01-preview/calculateBaseline_API.json | 8 ++++---- .../stable/2015-04-01/autoscale_API.json | 4 ++-- .../stable/2018-01-01/metricDefinitions_API.json | 2 +- .../stable/2018-01-01/metrics_API.json | 6 +++--- .../stable/2018-03-01/metricAlert_API.json | 8 ++++---- .../stable/2018-04-16/scheduledQueryRule_API.json | 12 ++++++------ .../stable/2018-09-01/baseline_API.json | 4 ++-- .../stable/2018-09-01/calculateBaseline_API.json | 8 ++++---- 10 files changed, 31 insertions(+), 31 deletions(-) diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json index 7c0b450fdab7..c02c2f86f83f 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json @@ -45,7 +45,7 @@ "description": "**Lists the metric values for a resource**.", "parameters": [ { - "$ref": "#/parameters/ResourceUriParameter" + "$ref": "#/parameters/ResourceUriParameter" }, { "$ref": "#/parameters/TimespanParameter" @@ -253,7 +253,7 @@ }, "timespan": { "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." }, "interval": { "type": "string", @@ -267,7 +267,7 @@ }, "description": "the value of the collection." } - }, + }, "required": [ "timespan", "value" ], "description": "The response to a metrics query." }, diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json index 003d8a45ad34..caba765e16e5 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json @@ -45,7 +45,7 @@ "description": "**Gets the baseline values for a specific metric**.", "parameters": [ { - "$ref": "#/parameters/ExtendedResourceUriParameter" + "$ref": "#/parameters/ExtendedResourceUriParameter" }, { "$ref": "#/parameters/MetricNameParameter" @@ -162,7 +162,7 @@ "properties": { "timespan": { "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." }, "interval": { "type": "string", diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json index 57463504ac45..c2e9065d56f5 100644 --- a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json @@ -45,7 +45,7 @@ "description": "**Lists the baseline values for a resource**.", "parameters": [ { - "$ref": "#/parameters/ExtendedResourceUriParameter" + "$ref": "#/parameters/ExtendedResourceUriParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -150,9 +150,9 @@ }, "description": "the baseline values for each sensitivity." } - }, + }, "required": [ "type", "baseline" ], - "description": "The response to a calcualte baseline call." + "description": "The response to a calculate baseline call." }, "Baseline": { "type": "object", @@ -202,7 +202,7 @@ "description": "The identifier of the resource. It has the following structure: subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceName}. For example: subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true - }, + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json index e154f6651b8e..bfc43dd3c7f4 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json @@ -491,7 +491,7 @@ "properties": { "timeZone": { "type": "string", - "description": "the timezone of the start and end times for the profile. Some examples of valid timezones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" + "description": "the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" }, "start": { "type": "string", @@ -512,7 +512,7 @@ "properties": { "timeZone": { "type": "string", - "description": "the timezone for the hours of the profile. Some examples of valid timezones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" + "description": "the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time" }, "days": { "type": "array", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json index a497924351d5..8a13c0cb6a7f 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json @@ -155,7 +155,7 @@ }, "namespace": { "type": "string", - "description": "the namespace the metric blongs to." + "description": "the namespace the metric belongs to." }, "name": { "$ref": "#/definitions/LocalizableString", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json index 415950a31efc..2aba4142c955 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json @@ -45,7 +45,7 @@ "description": "**Lists the metric values for a resource**.", "parameters": [ { - "$ref": "#/parameters/ResourceUriParameter" + "$ref": "#/parameters/ResourceUriParameter" }, { "$ref": "#/parameters/TimespanParameter" @@ -212,7 +212,7 @@ }, "timespan": { "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." }, "interval": { "type": "string", @@ -234,7 +234,7 @@ }, "description": "the value of the collection." } - }, + }, "required": [ "timespan", "value" ], "description": "The response to a metrics query." }, diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json index e3dcb173e5d5..1380d5987407 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json @@ -63,7 +63,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts": { "get": { "tags": [ "MetricAlerts" ], - "description": "Retrieve alert rule defintions in a resource group.", + "description": "Retrieve alert rule definitions in a resource group.", "operationId": "MetricAlerts_ListByResourceGroup", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -93,7 +93,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}": { "get": { "tags": [ "MetricAlerts" ], - "description": "Retrieve an alert rule definiton.", + "description": "Retrieve an alert rule definition.", "operationId": "MetricAlerts_Get", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -195,7 +195,7 @@ }, "delete": { "tags": [ "MetricAlerts" ], - "description": "Delete an alert rule defitiniton.", + "description": "Delete an alert rule definition.", "operationId": "MetricAlerts_Delete", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" }, @@ -657,7 +657,7 @@ "description": "the list of multiple metric criteria for this 'all of' operation. " } }, - "description": "Speficies the metric alert criteria for multiple resource that has multiple metric criteria." + "description": "Specifies the metric alert criteria for multiple resource that has multiple metric criteria." }, "MultiMetricCriteria": { "type": "object", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json index 6993a69f06d9..9f99151b5137 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json @@ -463,7 +463,7 @@ }, "customWebhookPayload": { "type": "string", - "description": "Custom payload to be sent for all webook URI in Azure action group" + "description": "Custom payload to be sent for all webhook URI in Azure action group" } }, "description": "Azure action group" @@ -540,7 +540,7 @@ "name": "QueryType", "modelAsString": true }, - "description": "Set value to 'ResultAcount'" + "description": "Set value to 'ResultAccount'" }, "LogSearchRule": { "description": "Log Search Rule Definition", @@ -580,7 +580,7 @@ "name": "provisioningState", "modelAsString": true }, - "description": "Provisioning state of the scheduledquery rule" + "description": "Provisioning state of the scheduled query rule" }, "source": { "$ref": "#/definitions/Source", @@ -588,7 +588,7 @@ }, "schedule": { "$ref": "#/definitions/Schedule", - "description": "Schedule (Frequnecy, Time Window) for rule. Required for action type - AlertingAction" + "description": "Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction" }, "action": { "$ref": "#/definitions/Action", @@ -632,7 +632,7 @@ "description": "Action descriptor." }, "AlertingAction": { - "description": "Specifiy action need to be taken when rule type is Alert", + "description": "Specify action need to be taken when rule type is Alert", "x-ms-discriminator-value": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.AlertingAction", "type": "object", "allOf": [ @@ -719,7 +719,7 @@ ] }, "LogToMetricAction": { - "description": "Specifiy action need to be taken when rule type is converting log to metric", + "description": "Specify action need to be taken when rule type is converting log to metric", "x-ms-discriminator-value": "Microsoft.WindowsAzure.Management.Monitoring.Alerts.Models.Microsoft.AppInsights.Nexus.DataContracts.Resources.ScheduledQueryRules.LogToMetricAction", "type": "object", "allOf": [ diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json index fcaea83582a3..0e31a4c3be92 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json @@ -75,7 +75,7 @@ "name": "$filter", "in": "query", "type": "string", - "description": "The **$filter** is used to describe a set of dimensions with their concrete values which produce a specific metric’s time series, in which a baseline is requested for.", + "description": "The **$filter** is used to describe a set of dimensions with their concrete values which produce a specific metric�s time series, in which a baseline is requested for.", "required": false } ], @@ -172,7 +172,7 @@ "properties": { "timespan": { "type": "string", - "description": "The timespan for which the data was retrieved. Its value consists of two datatimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." + "description": "The timespan for which the data was retrieved. Its value consists of two datetimes concatenated, separated by '/'. This may be adjusted in the future and returned back from what was originally requested." }, "interval": { "type": "string", diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json index 0df4d96788f9..c6e0e614c5e5 100644 --- a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json +++ b/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json @@ -45,7 +45,7 @@ "description": "**Lists the baseline values for a resource**.", "parameters": [ { - "$ref": "#/parameters/ExtendedResourceUriParameter" + "$ref": "#/parameters/ExtendedResourceUriParameter" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -150,9 +150,9 @@ }, "description": "The baseline values for each sensitivity." } - }, + }, "required": [ "type", "baseline" ], - "description": "The response to a calcualte baseline call." + "description": "The response to a calculate baseline call." }, "Baseline": { "type": "object", @@ -202,7 +202,7 @@ "description": "The identifier of the resource. It has the following structure: subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/{providerName}/{resourceName}. For example: subscriptions/b368ca2f-e298-46b7-b0ab-012281956afa/resourceGroups/vms/providers/Microsoft.Compute/virtualMachines/vm1", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true - }, + }, "ApiVersionParameter": { "name": "api-version", "in": "query", From c837ca0ee6f526b9a56c3bf1088b6983b9f85620 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:22:12 -0500 Subject: [PATCH 243/464] typo: machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute (#4707) - Operationalizaton -> Operationalization - configuartion -> configuration - Trim trailing whitespace --- .../preview/2017-06-01-preview/machineLearningCompute.json | 6 +++--- .../preview/2017-08-01-preview/machineLearningCompute.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json b/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json index f86fc8ca5fcb..70aab7bc8d8c 100644 --- a/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json +++ b/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-06-01-preview/machineLearningCompute.json @@ -328,7 +328,7 @@ ], "operationId": "OperationalizationClusters_UpdateSystem", "x-ms-examples": { - "Update System Services in an Operationalizaton Cluster": { + "Update System Services in an Operationalization Cluster": { "$ref": "examples/OperationalizationClusters_UpdateSystem.json" } }, @@ -759,7 +759,7 @@ "x-ms-enum": { "name": "AgentVMSizeTypes", "modelAsString": true - } + } } } }, @@ -826,7 +826,7 @@ "properties": { "etag": { "type": "string", - "description": "The configuartion ETag for updates." + "description": "The configuration ETag for updates." }, "ssl": { "description": "The SSL configuration properties", diff --git a/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json b/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json index 71603d77668e..86b1a70c4317 100644 --- a/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json +++ b/specification/machinelearningcompute/resource-manager/Microsoft.MachineLearningCompute/preview/2017-08-01-preview/machineLearningCompute.json @@ -303,7 +303,7 @@ ], "operationId": "OperationalizationClusters_UpdateSystemServices", "x-ms-examples": { - "Update System Services in an Operationalizaton Cluster": { + "Update System Services in an Operationalization Cluster": { "$ref": "examples/OperationalizationClusters_UpdateSystemServices.json" } }, @@ -705,7 +705,7 @@ "description": "The number of master nodes in the container service.", "minimum": 1, "maximum": 5, - "default": 1 + "default": 1 }, "agentCount": { "type": "integer", @@ -854,7 +854,7 @@ "properties": { "etag": { "type": "string", - "description": "The configuartion ETag for updates." + "description": "The configuration ETag for updates." }, "ssl": { "description": "The SSL configuration properties", From f091b39237f7e28ca2b277adf5a02ea291c7e197 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:22:50 -0500 Subject: [PATCH 244/464] typo: Microsoft.HDInsight (#4697) - compatibilty -> compatibility - capabilty -> capability --- .../preview/2015-03-01-preview/locations.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json index fa4b6acbf035..9fdd59dab21d 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/locations.json @@ -258,7 +258,7 @@ } }, "regions": { - "description": "The virtual machine size compatibilty features.", + "description": "The virtual machine size compatibility features.", "type": "object", "additionalProperties": { "$ref": "#/definitions/RegionsCapability" @@ -272,14 +272,14 @@ } }, "vmSize_filters": { - "description": "The virtual machine size compatibilty filters.", + "description": "The virtual machine size compatibility filters.", "type": "array", "items": { "$ref": "#/definitions/VmSizeCompatibilityFilter" } }, "features": { - "description": "The capabilty features.", + "description": "The capability features.", "type": "array", "items": { "type": "string" From da97586e9195d531743701c6eb46296a65990da4 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:23:26 -0500 Subject: [PATCH 245/464] typo: Microsoft.EventGrid (#4690) - Double word "key" - eventtime -> eventTime - upto -> up to --- .../preview/2017-06-15-preview/EventGrid.json | 2 +- .../preview/2017-09-15-preview/EventGrid.json | 2 +- .../preview/2018-05-01-preview/EventGrid.json | 4 ++-- .../preview/2018-09-15-preview/EventGrid.json | 6 +++--- .../Microsoft.EventGrid/stable/2018-01-01/EventGrid.json | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json index 140789674ab6..5c447e047a8d 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json @@ -1773,7 +1773,7 @@ } }, "TopicRegenerateKeyRequest": { - "description": "Topic regenerate share access key key request", + "description": "Topic regenerate share access key request", "required": [ "keyName" ], diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json index c99840fbb7e5..9f41e25d9652 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json @@ -1892,7 +1892,7 @@ } }, "TopicRegenerateKeyRequest": { - "description": "Topic regenerate share access key key request", + "description": "Topic regenerate share access key request", "required": [ "keyName" ], diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json index 6b8170656987..55b2bf40833f 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json @@ -2018,7 +2018,7 @@ } }, "JsonField": { - "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventtime' properties. This represents a field in the input event schema.", + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.", "type": "object", "properties": { "sourceField": { @@ -2028,7 +2028,7 @@ } }, "JsonFieldWithDefault": { - "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.", + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.", "type": "object", "properties": { "sourceField": { diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json index e6356ff4740c..47025ae3e02d 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/preview/2018-09-15-preview/EventGrid.json @@ -2659,7 +2659,7 @@ } }, "key": { - "description": "The filter key. Represents an event property with upto two levels of nesting.", + "description": "The filter key. Represents an event property with up to two levels of nesting.", "type": "string" } }, @@ -3033,7 +3033,7 @@ } }, "JsonField": { - "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventtime' properties. This represents a field in the input event schema.", + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id','topic' and 'eventTime' properties. This represents a field in the input event schema.", "type": "object", "properties": { "sourceField": { @@ -3043,7 +3043,7 @@ } }, "JsonFieldWithDefault": { - "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventtype' and 'dataversion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.", + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'subject','eventType' and 'dataVersion' properties. This represents a field in the input event schema along with a default value to be used, and at least one of these two properties should be provided.", "type": "object", "properties": { "sourceField": { diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json index f4f658fc7970..3a5365e63ee6 100644 --- a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json @@ -1883,7 +1883,7 @@ } }, "TopicRegenerateKeyRequest": { - "description": "Topic regenerate share access key key request", + "description": "Topic regenerate share access key request", "required": [ "keyName" ], From 1c141c60a6d0a7f91949295c97cfdc58340613fc Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:24:18 -0500 Subject: [PATCH 246/464] typo: Microsoft.DataMigration (#4681) - exising -> existing - capabilites -> capabilities - eligiblity -> eligibility - propery -> property - ertificate -> certificate --- .../preview/2017-11-15-preview/datamigration.json | 2 +- .../preview/2017-11-15-preview/definitions/ResourceSkus.json | 2 +- .../preview/2018-03-15-preview/datamigration.json | 2 +- .../preview/2018-03-15-preview/definitions/ResourceSkus.json | 2 +- .../preview/2018-03-31-preview/datamigration.json | 2 +- .../definitions/ConnectToSourceSqlServerTask.json | 4 ++-- .../preview/2018-03-31-preview/definitions/ResourceSkus.json | 2 +- .../preview/2018-07-15-preview/datamigration.json | 2 +- .../definitions/ConnectToSourceSqlServerTask.json | 4 ++-- .../preview/2018-07-15-preview/definitions/Files.json | 2 +- .../definitions/GetTdeCertificatesSqlTask.json | 2 +- .../preview/2018-07-15-preview/definitions/ResourceSkus.json | 2 +- .../stable/2018-04-19/datamigration.json | 2 +- .../2018-04-19/definitions/ConnectToSourceSqlServerTask.json | 4 ++-- .../stable/2018-04-19/definitions/ResourceSkus.json | 2 +- 15 files changed, 18 insertions(+), 18 deletions(-) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json index 23ace0177ff7..d633cff0dfc0 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/datamigration.json @@ -614,7 +614,7 @@ ], "put": { "summary": "Create or update task", - "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.", "tags": [ "Task resource", "Standard operation", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ResourceSkus.json index 5c685a89d464..07c8b24ce4d1 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ResourceSkus.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2017-11-15-preview/definitions/ResourceSkus.json @@ -168,7 +168,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/datamigration.json index 6734fd03c8cb..41315a2dcb2d 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/datamigration.json @@ -614,7 +614,7 @@ ], "put": { "summary": "Create or update task", - "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.", "tags": [ "Task resource", "Standard operation", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ResourceSkus.json index 3ab6f31d0e24..d342dff0fe39 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ResourceSkus.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-15-preview/definitions/ResourceSkus.json @@ -168,7 +168,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json index 760018adc339..f4a403272170 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/datamigration.json @@ -614,7 +614,7 @@ ], "put": { "summary": "Create or update task", - "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.", "tags": [ "Task resource", "Standard operation", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json index 5a7c4efec27b..30e63b388c0f 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ConnectToSourceSqlServerTask.json @@ -184,7 +184,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of login for migration.", + "description": "Information about eligibility of login for migration.", "readOnly": true } }, @@ -227,7 +227,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of agent job for migration.", + "description": "Information about eligibility of agent job for migration.", "readOnly": true } }, diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ResourceSkus.json index 2ba60af1c147..c1755ec7cdf5 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ResourceSkus.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-03-31-preview/definitions/ResourceSkus.json @@ -168,7 +168,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json index 1a5e8201b4df..73364af78acc 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/datamigration.json @@ -614,7 +614,7 @@ ], "put": { "summary": "Create or update task", - "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.", "tags": [ "Task resource", "Standard operation", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json index faa7051efdf2..292e118e49e8 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json @@ -196,7 +196,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of login for migration.", + "description": "Information about eligibility of login for migration.", "readOnly": true } }, @@ -247,7 +247,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of agent job for migration.", + "description": "Information about eligibility of agent job for migration.", "readOnly": true } }, diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json index 06a51036440a..3fb111285387 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Files.json @@ -36,7 +36,7 @@ "readOnly": true }, "mediaType": { - "description": "File content type. This propery can be modified to reflect the file content type.", + "description": "File content type. This property can be modified to reflect the file content type.", "type": "string" }, "size": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json index 528e628bfb19..2fe4bc688041 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetTdeCertificatesSqlTask.json @@ -70,7 +70,7 @@ }, "SelectedCertificateInput": { "type": "object", - "description": "Info for ertificate to be exported for TDE enabled databases.", + "description": "Info for certificate to be exported for TDE enabled databases.", "properties": { "certificateName": { "type": "string", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ResourceSkus.json index 289727a45ca8..4aaebb1eb558 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ResourceSkus.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ResourceSkus.json @@ -168,7 +168,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json index d91194f27e3b..c802de3ec8c8 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/datamigration.json @@ -614,7 +614,7 @@ ], "put": { "summary": "Create or update task", - "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an exising one.", + "description": "The tasks resource is a nested, proxy-only resource representing work performed by a DMS instance. The PUT method creates a new task or updates an existing one, although since tasks have no mutable custom properties, there is little reason to update an existing one.", "tags": [ "Task resource", "Standard operation", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json index 0f945eb50672..d76bd87acbbd 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json @@ -183,7 +183,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of login for migration.", + "description": "Information about eligibility of login for migration.", "readOnly": true } }, @@ -226,7 +226,7 @@ }, "migrationEligibility": { "$ref": "./TasksCommon.json#/definitions/MigrationEligibilityInfo", - "description": "Information about eligiblity of agent job for migration.", + "description": "Information about eligibility of agent job for migration.", "readOnly": true } }, diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json index f89c91824603..8b5abb579848 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ResourceSkus.json @@ -168,7 +168,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { From 072ed2250f943f51b090be972b111e231cb8ce81 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:24:52 -0500 Subject: [PATCH 247/464] typo: Microsoft.DataBox (#4672) - consitent use of "DataBox", "DataBoxHeavy", and "DataBoxDisk" - hasnt -> hasn't - transfered -> transferred - Storsimple -> StorSimple --- .../stable/2018-01-01/databox.json | 62 +++++++++---------- 1 file changed, 31 insertions(+), 31 deletions(-) diff --git a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json index bdc93069e144..9545d1d9b568 100644 --- a/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json +++ b/specification/databox/resource-manager/Microsoft.DataBox/stable/2018-01-01/databox.json @@ -147,7 +147,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/locations/{location}/validateAddress": { "post": { "tags": [ @@ -305,7 +305,7 @@ }, "JobsGet5": { "$ref": "./examples/JobsGet5.json" - } + } } }, "put": { @@ -773,15 +773,15 @@ "values": [ { "value": "DataBox", - "description": "Databox." + "description": "DataBox." }, { "value": "DataBoxDisk", - "description": "DataboxDisk." + "description": "DataBoxDisk." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy." + "description": "DataBoxHeavy." } ] } @@ -880,15 +880,15 @@ "values": [ { "value": "DataBox", - "description": "Databox orders." + "description": "DataBox orders." }, { "value": "DataBoxDisk", - "description": "DataboxDisk orders." + "description": "DataBoxDisk orders." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy orders." + "description": "DataBoxHeavy orders." } ] } @@ -1024,7 +1024,7 @@ "values": [ { "value": "NotStarted", - "description": "Data copy hasnt started yet." + "description": "Data copy hasn't started yet." }, { "value": "InProgress", @@ -1129,7 +1129,7 @@ "x-ms-discriminator-value": "DataBoxDisk" }, "DataBoxHeavyAccountCopyLogDetails": { - "description": "Copy log details for a storage account for Databox heavy", + "description": "Copy log details for a storage account for DataBoxHeavy", "type": "object", "allOf": [ { @@ -1154,7 +1154,7 @@ "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavyJobDetails": { - "description": "Databox Heavy Device Job Details", + "description": "DataBoxHeavy Device Job Details", "required": [ "contactDetails", "shippingAddress", @@ -1180,7 +1180,7 @@ "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavyJobSecrets": { - "description": "The secrets related to a databox heavy job.", + "description": "The secrets related to a DataBoxHeavy job.", "type": "object", "allOf": [ { @@ -1189,7 +1189,7 @@ ], "properties": { "cabinetPodSecrets": { - "description": "Contains the list of secret objects for a databox heavy job.", + "description": "Contains the list of secret objects for a DataBoxHeavy job.", "type": "array", "items": { "$ref": "#/definitions/DataBoxHeavySecret" @@ -1200,7 +1200,7 @@ "x-ms-discriminator-value": "DataBoxHeavy" }, "DataBoxHeavySecret": { - "description": "The secrets related to a databox heavy.", + "description": "The secrets related to a DataBoxHeavy.", "type": "object", "properties": { "deviceSerialNumber": { @@ -1237,7 +1237,7 @@ } }, "DataBoxJobDetails": { - "description": "Databox Job Details", + "description": "DataBox Job Details", "required": [ "contactDetails", "shippingAddress", @@ -1263,7 +1263,7 @@ "x-ms-discriminator-value": "DataBox" }, "DataboxJobSecrets": { - "description": "The secrets related to a databox job.", + "description": "The secrets related to a DataBox job.", "type": "object", "allOf": [ { @@ -1464,7 +1464,7 @@ "properties": { "expectedDataSizeInTeraBytes": { "format": "int32", - "description": "The expected size of the data, which needs to be transfered in this job, in tera bytes.", + "description": "The expected size of the data, which needs to be transferred in this job, in terabytes.", "type": "integer" }, "jobStages": { @@ -1522,15 +1522,15 @@ "values": [ { "value": "DataBox", - "description": "Databox orders." + "description": "DataBox orders." }, { "value": "DataBoxDisk", - "description": "DataboxDisk orders." + "description": "DataBoxDisk orders." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy orders." + "description": "DataBoxHeavy orders." } ] } @@ -1794,15 +1794,15 @@ "values": [ { "value": "DataBox", - "description": "Databox orders." + "description": "DataBox orders." }, { "value": "DataBoxDisk", - "description": "DataboxDisk orders." + "description": "DataBoxDisk orders." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy orders." + "description": "DataBoxHeavy orders." } ] } @@ -2156,7 +2156,7 @@ } }, "x-ms-azure-resource": true - }, + }, "ShareCredentialDetails": { "description": "Credential details of the shares in account.", "type": "object", @@ -2188,7 +2188,7 @@ }, { "value": "HCS", - "description": "Storsimple data format." + "description": "StorSimple data format." }, { "value": "BlockBlob", @@ -2384,15 +2384,15 @@ "values": [ { "value": "DataBox", - "description": "Databox." + "description": "DataBox." }, { "value": "DataBoxDisk", - "description": "DataboxDisk." + "description": "DataBoxDisk." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy." + "description": "DataBoxHeavy." } ] } @@ -2639,15 +2639,15 @@ "values": [ { "value": "DataBox", - "description": "Databox." + "description": "DataBox." }, { "value": "DataBoxDisk", - "description": "DataboxDisk." + "description": "DataBoxDisk." }, { "value": "DataBoxHeavy", - "description": "DataboxHeavy." + "description": "DataBoxHeavy." } ] } From 7237f4792c80e10c215fb3e6d599dfe7d505b2dd Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:25:39 -0500 Subject: [PATCH 248/464] typo: Microsoft.ContainerService (#4659) - FDQN -> FQDN --- .../preview/2015-11-01-preview/containerService.json | 4 ++-- .../stable/2016-03-30/containerService.json | 4 ++-- .../stable/2016-09-30/containerService.json | 4 ++-- .../stable/2017-01-31/containerService.json | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json b/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json index c7d52df88830..0d13d14e98dd 100644 --- a/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json +++ b/specification/compute/resource-manager/Microsoft.ContainerService/preview/2015-11-01-preview/containerService.json @@ -281,7 +281,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master" + "description": "FQDN for the master" } }, "required": [ @@ -366,7 +366,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool" + "description": "FQDN for the agent pool" } }, "required": [ diff --git a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json index f0d7ec663d6c..a09cb216a1b9 100644 --- a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json +++ b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json @@ -290,7 +290,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -375,7 +375,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ diff --git a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json index 3d65d2e69b3f..39d97dbc3e87 100644 --- a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json +++ b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json @@ -324,7 +324,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -410,7 +410,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ diff --git a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json index 203f1728ccb7..cf7a1df8e4a7 100644 --- a/specification/compute/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json +++ b/specification/compute/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json @@ -367,7 +367,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -453,7 +453,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ From 4c2d01b3405033022dc5f62229e365f29ed2d2b6 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 01:27:02 -0500 Subject: [PATCH 249/464] typo: ContentModerator (#4650) - classication -> classification --- .../ContentModerator/stable/v1.0/ContentModerator.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json b/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json index 40a2a7a37003..2c9b910707d1 100644 --- a/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json +++ b/specification/cognitiveservices/data-plane/ContentModerator/stable/v1.0/ContentModerator.json @@ -2789,7 +2789,7 @@ "type": "boolean" }, "RacyClassificationScore": { - "description": "The racy classication score.", + "description": "The racy classification score.", "type": "number" }, "IsImageRacyClassified": { From 254c62e2d3754650d72aa57e6998d7b0eccd4d66 Mon Sep 17 00:00:00 2001 From: Boris Baryshnikov Date: Sun, 2 Dec 2018 22:36:38 -0800 Subject: [PATCH 250/464] Update RHEL and CentOS to latest versions (#4640) --- arm-compute/quickstart-templates/aliases.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/arm-compute/quickstart-templates/aliases.json b/arm-compute/quickstart-templates/aliases.json index 8c6004242747..2ee860c911c4 100644 --- a/arm-compute/quickstart-templates/aliases.json +++ b/arm-compute/quickstart-templates/aliases.json @@ -14,7 +14,7 @@ "CentOS":{ "publisher":"OpenLogic", "offer":"CentOS", - "sku":"7.3", + "sku":"7.5", "version":"latest" }, "CoreOS":{ @@ -38,7 +38,7 @@ "RHEL":{ "publisher":"RedHat", "offer":"RHEL", - "sku":"7.3", + "sku":"7-RAW", "version":"latest" }, "SLES":{ From ba0114066f261fe19adbc5542a9d27140ac6d3da Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:06:07 -0500 Subject: [PATCH 251/464] typo: operationalinsights/resource-manager/Microsoft.OperationalInsights (#4723) - managmement -> management - Searchs -> Searches - lanuage -> language - occurences -> occurrences - Trim trailing space --- .../OperationalInsights.json | 94 +++++++++---------- .../2015-03-20/OperationalInsights.json | 62 ++++++------ 2 files changed, 78 insertions(+), 78 deletions(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json index 6367b6d270ee..4d92d3ca149c 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/OperationalInsights.json @@ -99,7 +99,7 @@ ], "x-ms-examples": { "LinkedServicesDelete": { "$ref": "./examples/LinkedServicesDelete.json" } - }, + }, "operationId": "LinkedServices_Delete", "description": "Deletes a linked service instance.", "parameters": [ @@ -142,7 +142,7 @@ ], "x-ms-examples": { "LinkedServicesGet": { "$ref": "./examples/LinkedServicesGet.json" } - }, + }, "operationId": "LinkedServices_Get", "description": "Gets a linked service instance.", "parameters": [ @@ -187,7 +187,7 @@ ], "x-ms-examples": { "LinkedServicesListByWorkspace": { "$ref": "./examples/LinkedServicesListByWorkspace.json" } - }, + }, "operationId": "LinkedServices_ListByWorkspace", "description": "Gets the linked services instances in a workspace.", "parameters": [ @@ -278,7 +278,7 @@ "$ref": "#/definitions/DataSource" } } - } + } }, "delete": { "tags": [ @@ -286,7 +286,7 @@ ], "x-ms-examples": { "DataSourcesDelete": { "$ref": "./examples/DataSourcesDelete.json" } - }, + }, "operationId": "DataSources_Delete", "description": "Deletes a data source instance.", "parameters": [ @@ -329,7 +329,7 @@ ], "x-ms-examples": { "DataSourcesGet": { "$ref": "./examples/DataSourcesGet.json" } - }, + }, "operationId": "DataSources_Get", "description": "Gets a datasource instance.", "parameters": [ @@ -374,7 +374,7 @@ ], "x-ms-examples": { "DataSourcesListByWorkspace": { "$ref": "./examples/DataSourcesListByWorkspace.json" } - }, + }, "operationId": "DataSources_ListByWorkspace", "description": "Gets the first page of data source instances in a workspace with the link to the next page.", "parameters": [ @@ -430,7 +430,7 @@ ], "x-ms-examples": { "IntelligencePacksDisable": { "$ref": "./examples/WorkspacesDisableIntelligencePack.json" } - }, + }, "operationId": "Workspaces_DisableIntelligencePack", "description": "Disables an intelligence pack for a given workspace.", "parameters": [ @@ -472,7 +472,7 @@ ], "x-ms-examples": { "IntelligencePacksEnable": { "$ref": "./examples/WorkspacesEnableIntelligencePack.json" } - }, + }, "operationId": "Workspaces_EnableIntelligencePack", "description": "Enables an intelligence pack for a given workspace.", "parameters": [ @@ -514,7 +514,7 @@ ], "x-ms-examples": { "IntelligencePacksList": { "$ref": "./examples/WorkspacesListIntelligencePacks.json" } - }, + }, "operationId": "Workspaces_ListIntelligencePacks", "description": "Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.", "parameters": [ @@ -555,7 +555,7 @@ ], "x-ms-examples": { "SharedKeysList": { "$ref": "./examples/WorkspacesGetSharedKeys.json" } - }, + }, "operationId": "Workspaces_GetSharedKeys", "description": "Gets the shared keys for a workspace.", "parameters": [ @@ -593,7 +593,7 @@ ], "x-ms-examples": { "UsagesList": { "$ref": "./examples/WorkspacesListUsages.json" } - }, + }, "operationId": "Workspaces_ListUsages", "description": "Gets a list of usage metrics for a workspace.", "parameters": [ @@ -634,7 +634,7 @@ ], "x-ms-examples": { "WorkspacesListManagementGroups": { "$ref": "./examples/WorkspacesListManagementGroups.json" } - }, + }, "operationId": "Workspaces_ListManagementGroups", "description": "Gets a list of management groups connected to a workspace.", "parameters": [ @@ -675,7 +675,7 @@ ], "x-ms-examples": { "WorkspacesGet": { "$ref": "./examples/WorkspacesListByResourceGroup.json" } - }, + }, "operationId": "Workspaces_ListByResourceGroup", "description": "Gets workspaces in a resource group.", "parameters": [ @@ -709,7 +709,7 @@ ], "x-ms-examples": { "WorkspacesSubscriptionList": { "$ref": "./examples/WorkspacesSubscriptionList.json" } - }, + }, "operationId": "Workspaces_List", "description": "Gets the workspaces in a subscription.", "parameters": [ @@ -740,7 +740,7 @@ ], "x-ms-examples": { "WorkspacesCreate": { "$ref": "./examples/WorkspacesCreate.json" } - }, + }, "operationId": "Workspaces_CreateOrUpdate", "description": "Create or update a workspace.", "parameters": [ @@ -799,7 +799,7 @@ ], "x-ms-examples": { "WorkspacesDelete": { "$ref": "./examples/WorkspacesDelete.json" } - }, + }, "operationId": "Workspaces_Delete", "description": "Deletes a workspace instance.", "parameters": [ @@ -839,7 +839,7 @@ ], "x-ms-examples": { "WorkspaceGet": { "$ref": "./examples/WorkspacesGet.json" } - }, + }, "operationId": "Workspaces_Get", "description": "Gets a workspace instance.", "parameters": [ @@ -879,7 +879,7 @@ ], "x-ms-examples": { "WorkspacesPatch": { "$ref": "./examples/WorkspacesUpdate.json" } - }, + }, "operationId": "Workspaces_Update", "description": "Updates a workspace.", "parameters": [ @@ -924,7 +924,7 @@ } } } - } + } }, "/providers/Microsoft.OperationalInsights/operations": { "get": { @@ -971,7 +971,7 @@ } }, "Operation": { - "description": "Supported operation of OperationalInsights resource provider.", + "description": "Supported operation of OperationalInsights resource provider.", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", @@ -1007,7 +1007,7 @@ "resourceId" ], "description": "Linked service properties." - }, + }, "LinkedService": { "properties": { "properties": { @@ -1025,7 +1025,7 @@ } ], "description": "The top level Linked service resource container.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, "LinkedServiceListResult": { "properties": { @@ -1088,7 +1088,7 @@ } ], "description": "Datasources under OMS Workspace.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, "DataSourceFilter": { "properties": { @@ -1261,7 +1261,7 @@ "description": "Gets or sets a list of management groups attached to the workspace." } }, - "description": "The list workspace managmement groups operation response." + "description": "The list workspace management groups operation response." }, "Sku": { "properties": { @@ -1337,7 +1337,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties", - "description":"Workspace properties." + "description":"Workspace properties." }, "eTag": { "type": "string", @@ -1348,9 +1348,9 @@ { "$ref": "#/definitions/Resource" } - ], + ], "description": "The top level Workspace resource container.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, "WorkspaceListResult": { "properties": { @@ -1399,24 +1399,24 @@ } }, "description": "The resource definition.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, - "ProxyResource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." + "ProxyResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." }, "tags": { "type": "object", @@ -1425,8 +1425,8 @@ }, "description": "Resource tags" } - }, - "description": "Common properties of proxy resource." + }, + "description": "Common properties of proxy resource." } }, "parameters": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json index d861865d5f82..1e5b84d939d5 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/stable/2015-03-20/OperationalInsights.json @@ -326,7 +326,7 @@ ], "x-ms-examples": { "SavedSearchesGet": { "$ref": "./examples/WorkspacesSavedSearchesGet.json" } - }, + }, "operationId": "SavedSearches_Get", "description": "Gets the specified saved search for a given workspace.", "parameters": [ @@ -400,7 +400,7 @@ "SavedSearches" ], "x-ms-examples": { - "SaveSearchsListResults": { "$ref": "./examples/SavedSearchesGetResults.json" } + "SaveSearchesListResults": { "$ref": "./examples/SavedSearchesGetResults.json" } }, "operationId": "SavedSearches_GetResults", "description": "Gets the results from a saved search for a given workspace.", @@ -579,7 +579,7 @@ }, { "$ref": "#/parameters/WorkspacePurgeParameter" - } + } ], "responses": { "202": { @@ -624,7 +624,7 @@ }, { "$ref": "#/parameters/WorkspacePurgeIdParameter" - } + } ], "responses": { "200": { @@ -648,7 +648,7 @@ ], "x-ms-examples": { "SharedKeysList": { "$ref": "./examples/WorkspacesListKeys.json" } - }, + }, "operationId": "Workspaces_ListKeys", "description": "Gets the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.", "parameters": [ @@ -682,7 +682,7 @@ ], "x-ms-examples": { "SharedKeysList": { "$ref": "./examples/WorkspacesRegenerateSharedKeys.json" } - }, + }, "operationId": "Workspaces_RegenerateSharedKeys", "description": "Regenerates the shared keys for a Log Analytics Workspace. These keys are used to connect Microsoft Operational Insights agents to the workspace.", "parameters": [ @@ -749,7 +749,7 @@ } }, "Operation": { - "description": "Supported operation of OperationalInsights resource provider.", + "description": "Supported operation of OperationalInsights resource provider.", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", @@ -832,7 +832,7 @@ "format": "int64", "minimum": 1, "maximum": 2, - "description": "The version number of the query lanuage. The current version is 2 and is the default." + "description": "The version number of the query language. The current version is 2 and is the default." }, "tags": { "type": "array", @@ -862,7 +862,7 @@ } }, "required": [ - "numberOfDocuments" + "numberOfDocuments" ], "description": "The core summary of a search." }, @@ -1019,7 +1019,7 @@ "properties" ], "description": "Value object for saved search results.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, "SavedSearchesListResult": { "properties": { @@ -1157,7 +1157,7 @@ }, "highlight": { "$ref": "#/definitions/SearchHighlight", - "description": "The highlight that looks for all occurences of a string." + "description": "The highlight that looks for all occurrences of a string." }, "query": { "type": "string", @@ -1269,7 +1269,7 @@ } ], "description": "The top level storage insight resource container.", - "x-ms-azure-resource": true + "x-ms-azure-resource": true }, "StorageInsightListResult": { "properties": { @@ -1323,22 +1323,22 @@ "description": "The resource definition.", "x-ms-azure-resource": true }, - "ProxyResource": { - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource ID." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." + "ProxyResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." }, "tags": { "type": "object", @@ -1347,8 +1347,8 @@ }, "description": "Resource tags" } - }, - "description": "Common properties of proxy resource." + }, + "description": "Common properties of proxy resource." }, "WorkspacePurgeBody": { "description": "Describes the body of a purge request for an App Insights Workspace", @@ -1385,7 +1385,7 @@ "description": "the value for the operator to function over. This can be a number (e.g., > 100), a string (timestamp >= '2017-09-01') or array of values." }, "key": { - "description": "When filtering over custom dimensions, this key will be used as the name of the custom dimension.", + "description": "When filtering over custom dimensions, this key will be used as the name of the custom dimension.", "type": "string" } } From 4d79feb28d5352f8352419ecf68f4b909728026e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:07:03 -0500 Subject: [PATCH 252/464] typo: marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering (#4711) - reponse -> response --- .../stable/2015-06-01/Agreements.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json index 49d0e5cba527..a2644211529e 100644 --- a/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json +++ b/specification/marketplaceordering/resource-manager/Microsoft.MarketplaceOrdering/stable/2015-06-01/Agreements.json @@ -267,7 +267,7 @@ "description": "Agreement Terms definition" }, "ErrorResponse": { - "description": "Error reponse indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Microsoft.MarketplaceOrdering service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "error": { From be66f7a383a943d8ec64ee5dd48dbadeb1afe978 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:08:59 -0500 Subject: [PATCH 253/464] typo: resource-manager/Microsoft.KeyVault (#4701) - Double word "the" - availabity -> availability - accesibility -> accessibility - Decription -> Description --- .../preview/2018-02-14-preview/keyvault.json | 16 ++++++++-------- .../preview/2018-02-14-preview/providers.json | 2 +- .../stable/2016-10-01/keyvault.json | 6 +++--- .../stable/2016-10-01/providers.json | 2 +- .../stable/2018-02-14/keyvault.json | 16 ++++++++-------- .../stable/2018-02-14/providers.json | 2 +- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/keyvault.json index f61edb762d61..44b234ba882a 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/keyvault.json @@ -1054,7 +1054,7 @@ "x-ms-azure-resource": true }, "VaultAccessPolicyParameters": { - "properties": { + "properties": { "id": { "readOnly": true, "type": "string", @@ -1073,7 +1073,7 @@ "location": { "readOnly": true, "type": "string", - "description": "The resource type of the the access policy." + "description": "The resource type of the access policy." }, "properties": { "$ref": "#/definitions/VaultAccessPolicyProperties", @@ -1232,7 +1232,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the vault name." + "description": "The parameters used to check the availability of the vault name." }, "CheckNameAvailabilityResult": { "properties": { @@ -1264,7 +1264,7 @@ }, "NetworkRuleSet": { "properties": { - "bypass": { + "bypass": { "type": "string", "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", "enum": [ @@ -1287,14 +1287,14 @@ "name": "NetworkRuleAction", "modelAsString": true } - }, + }, "ipRules": { "type": "array", "items": { "$ref": "#/definitions/IPRule" }, "description": "The list of IP address rules." - }, + }, "virtualNetworkRules": { "type": "array", "items": { @@ -1315,7 +1315,7 @@ "required": [ "value" ], - "description": "A rule governing the accesibility of a vault from a specific ip address or ip range." + "description": "A rule governing the accessibility of a vault from a specific ip address or ip range." }, "VirtualNetworkRule": { "properties": { @@ -1327,7 +1327,7 @@ "required": [ "id" ], - "description": "A rule governing the accesibility of a vault from a specific virtual network." + "description": "A rule governing the accessibility of a vault from a specific virtual network." } }, "parameters": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/providers.json index d87f095207da..b5dd4628c0a0 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2018-02-14-preview/providers.json @@ -94,7 +94,7 @@ "type": "string" }, "description": { - "description": "Decription of operation.", + "description": "Description of operation.", "type": "string" } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json index 5d0d7737044c..b79c8fa319b0 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/keyvault.json @@ -1040,7 +1040,7 @@ "x-ms-azure-resource": true }, "VaultAccessPolicyParameters": { - "properties": { + "properties": { "id": { "readOnly": true, "type": "string", @@ -1059,7 +1059,7 @@ "location": { "readOnly": true, "type": "string", - "description": "The resource type of the the access policy." + "description": "The resource type of the access policy." }, "properties": { "$ref": "#/definitions/VaultAccessPolicyProperties", @@ -1218,7 +1218,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the vault name." + "description": "The parameters used to check the availability of the vault name." }, "CheckNameAvailabilityResult": { "properties": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json index dadd4d5b663a..06d65801a2b3 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2016-10-01/providers.json @@ -94,7 +94,7 @@ "type": "string" }, "description": { - "description": "Decription of operation.", + "description": "Description of operation.", "type": "string" } } diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/keyvault.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/keyvault.json index ceab8ffd7e0a..1b6ddabcaaec 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/keyvault.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/keyvault.json @@ -1054,7 +1054,7 @@ "x-ms-azure-resource": true }, "VaultAccessPolicyParameters": { - "properties": { + "properties": { "id": { "readOnly": true, "type": "string", @@ -1073,7 +1073,7 @@ "location": { "readOnly": true, "type": "string", - "description": "The resource type of the the access policy." + "description": "The resource type of the access policy." }, "properties": { "$ref": "#/definitions/VaultAccessPolicyProperties", @@ -1232,7 +1232,7 @@ "name", "type" ], - "description": "The parameters used to check the availabity of the vault name." + "description": "The parameters used to check the availability of the vault name." }, "CheckNameAvailabilityResult": { "properties": { @@ -1264,7 +1264,7 @@ }, "NetworkRuleSet": { "properties": { - "bypass": { + "bypass": { "type": "string", "description": "Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'.", "enum": [ @@ -1287,14 +1287,14 @@ "name": "NetworkRuleAction", "modelAsString": true } - }, + }, "ipRules": { "type": "array", "items": { "$ref": "#/definitions/IPRule" }, "description": "The list of IP address rules." - }, + }, "virtualNetworkRules": { "type": "array", "items": { @@ -1315,7 +1315,7 @@ "required": [ "value" ], - "description": "A rule governing the accesibility of a vault from a specific ip address or ip range." + "description": "A rule governing the accessibility of a vault from a specific ip address or ip range." }, "VirtualNetworkRule": { "properties": { @@ -1327,7 +1327,7 @@ "required": [ "id" ], - "description": "A rule governing the accesibility of a vault from a specific virtual network." + "description": "A rule governing the accessibility of a vault from a specific virtual network." } }, "parameters": { diff --git a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/providers.json b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/providers.json index 05bf1fd36499..075369d5d281 100644 --- a/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/providers.json +++ b/specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2018-02-14/providers.json @@ -94,7 +94,7 @@ "type": "string" }, "description": { - "description": "Decription of operation.", + "description": "Description of operation.", "type": "string" } } From a813aae82816609f8131d3335d303264639b498e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:10:10 -0500 Subject: [PATCH 254/464] typo: graphrbac (#4693) - otherwsie -> otherwise - Objectit -> Object - Reqired -> Required --- .../graphrbac/data-plane/stable/1.6/graphrbac.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json index e679678e640f..4b9d1e131555 100644 --- a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json +++ b/specification/graphrbac/data-plane/stable/1.6/graphrbac.json @@ -731,7 +731,7 @@ ], "responses": { "200": { - "description": "OK. Indicates success. Returns true if the user, contact, group, or service principal is a direct or a transitive member of the specified group; otherwsie, false.", + "description": "OK. Indicates success. Returns true if the user, contact, group, or service principal is a direct or a transitive member of the specified group; otherwise, false.", "schema": { "$ref": "#/definitions/CheckGroupMembershipResult" } @@ -2001,7 +2001,7 @@ "in" : "body", "name" : "body", "required" : false, - "description": "The relevant app Service Principal Object Id and the Service Principal Objecit Id you want to grant.", + "description": "The relevant app Service Principal Object Id and the Service Principal Object Id you want to grant.", "schema" : { "$ref" : "#/definitions/Permissions" }, @@ -2526,7 +2526,7 @@ "required": [ "resourceAccess" ], - "description": "Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of ReqiredResourceAccess." + "description": "Specifies the set of OAuth 2.0 permission scopes and app roles under the specified resource that an application requires access to. The specified OAuth 2.0 permission scopes may be requested by client applications (through the requiredResourceAccess collection) when calling a resource application. The requiredResourceAccess property of the Application entity is a collection of RequiredResourceAccess." }, "ResourceAccess": { "type": "object", From 61cbb03ea879c3e12433e89f9637cfbdbf9e7f5b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:11:08 -0500 Subject: [PATCH 255/464] typo: Microsoft.DocumentDB (#4665) - defintions -> definitions - Trim trailing whitespace --- .../stable/2015-04-08/cosmos-db.json | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json index 8a26a888c30a..b0d4c3b3298e 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2015-04-08/cosmos-db.json @@ -590,7 +590,7 @@ "operationId": "DatabaseAccounts_ListMetrics", "x-ms-examples": { "CosmosDBDatabaseAccountGetMetrics": { "$ref": "./examples/CosmosDBDatabaseAccountGetMetrics.json" } - }, + }, "x-ms-pageable": { "nextLinkName": null }, @@ -1129,7 +1129,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages": { @@ -1169,7 +1169,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages": { @@ -1212,7 +1212,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages": { @@ -1292,7 +1292,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions": { @@ -1332,7 +1332,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions": { @@ -1341,7 +1341,7 @@ "x-ms-examples": { "CosmosDBDatabaseAccountGetMetricDefinitions": { "$ref": "./examples/CosmosDBDatabaseAccountGetMetricDefinitions.json" } }, - "description": "Retrieves metric defintions for the given database account.", + "description": "Retrieves metric definitions for the given database account.", "parameters": [ { "$ref": "#/parameters/subscriptionIdParameter" @@ -1366,7 +1366,7 @@ }, "x-ms-pageable": { "nextLinkName": null - } + } } } }, @@ -2275,13 +2275,13 @@ "type": "number", "format": "double", "description": "The 50th percentile value for the metric." - }, + }, "P75": { "readOnly": true, "type": "number", "format": "double", "description": "The 75th percentile value for the metric." - }, + }, "P90": { "readOnly": true, "type": "number", @@ -2293,7 +2293,7 @@ "type": "number", "format": "double", "description": "The 95th percentile value for the metric." - }, + }, "P99": { "readOnly": true, "type": "number", From 0caa4bd3aec3b1634d668c3bbacb680d07e35abb Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:11:52 -0500 Subject: [PATCH 256/464] typo: coginitiveservices/data-plane/LocalSearch (#4655) - delimiated -> delimited - countr -> country --- .../data-plane/LocalSearch/stable/v1.0/LocalSearch.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json index 4361421ff602..f060f7a358c3 100644 --- a/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json +++ b/specification/cognitiveservices/data-plane/LocalSearch/stable/v1.0/LocalSearch.json @@ -137,7 +137,7 @@ "name": "localcategories", "x-ms-client-name": "LocalCategories", "in": "query", - "description": "comma-delimiated list of business categories to search for. Supported categories can be high-level such as EatDrink, Shop, SeeDo.", + "description": "comma-delimited list of business categories to search for. Supported categories can be high-level such as EatDrink, Shop, SeeDo.", "required": false, "type": "string" }, @@ -906,7 +906,7 @@ "type": "string" }, "countryIso": { - "description": "The two letter ISO code of this countr. For example, US.", + "description": "The two letter ISO code of this country. For example, US.", "readOnly": true, "type": "string" }, From 09229f4962d311fad5bff3b67ce8ddb5c5c8430a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 11:13:11 -0500 Subject: [PATCH 257/464] typo: Microsoft.Update.Admin (#4615) - Inforamtion -> Information --- .../Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/azsadmin/resource-manager/update/Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json b/specification/azsadmin/resource-manager/update/Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json index bf1477a5588d..178de82929e0 100644 --- a/specification/azsadmin/resource-manager/update/Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json +++ b/specification/azsadmin/resource-manager/update/Microsoft.Update.Admin/preview/2016-05-01/UpdateRuns.json @@ -198,7 +198,7 @@ } }, "Step": { - "description": "Inforamtion about each step of the update process.", + "description": "Information about each step of the update process.", "type": "object", "properties": { "name": { From 14fa67a52e5c51329ba0a462e487d8e9e55ecc6e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:20:22 -0500 Subject: [PATCH 258/464] typo: Microsoft.Compute (#4658) - incremental -> Incremental - setings -> settings - maintainance -> maintenance - UppercaseThumbpring -> UppercaseThumbprint - SubcriptionId -> SubscriptionId - Resoure -> Resource - capabilites -> capabilities - stictly -> strictly - VM's -> VMs - Double word "by" - Paramaters -> Parameters - Double word "be" - updateable -> updatable --- .../quickstart-templates/vm-simple.json | 2 +- .../preview/2016-04-30-preview/compute.json | 10 +++++----- .../preview/2016-04-30-preview/disk.json | 2 +- .../stable/2015-06-15/compute.json | 10 +++++----- .../stable/2016-03-30/compute.json | 10 +++++----- .../stable/2017-03-30/compute.json | 12 +++++------ .../stable/2017-03-30/disk.json | 2 +- .../stable/2017-09-01/skus.json | 2 +- .../stable/2017-12-01/compute.json | 16 +++++++-------- .../stable/2018-04-01/compute.json | 16 +++++++-------- .../stable/2018-04-01/disk.json | 2 +- .../stable/2018-06-01/compute.json | 20 +++++++++---------- .../stable/2018-06-01/disk.json | 2 +- .../stable/2018-06-01/gallery.json | 16 +++++++-------- .../stable/2018-10-01/compute.json | 20 +++++++++---------- .../compute/resource-manager/readme.md | 2 +- 16 files changed, 72 insertions(+), 72 deletions(-) diff --git a/specification/compute/quickstart-templates/vm-simple.json b/specification/compute/quickstart-templates/vm-simple.json index 09740bc83f0e..f10f94a44020 100644 --- a/specification/compute/quickstart-templates/vm-simple.json +++ b/specification/compute/quickstart-templates/vm-simple.json @@ -22,7 +22,7 @@ "name": "nestedTemplate", "type": "Microsoft.Resources/deployments", "properties": { - "mode": "incremental", + "mode": "Incremental", "templateLink": { "uri": "[variables('templatelink')]", "contentVersion": "1.0.0.0" diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json index eeddd52c8a4f..2e6f4fbf774d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/compute.json @@ -3207,7 +3207,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetListResult": { "properties": { @@ -4201,7 +4201,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -4484,7 +4484,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -4945,7 +4945,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -5444,7 +5444,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, diff --git a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json index f94a86bfce9c..2e83ab063660 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/preview/2016-04-30-preview/disk.json @@ -904,7 +904,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "DiskUpdateProperties": { "properties": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json index 34cf40899229..ecf037f0279d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json @@ -2736,7 +2736,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetListResult": { "properties": { @@ -3672,7 +3672,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -3929,7 +3929,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -4123,7 +4123,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -4589,7 +4589,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "type": "string", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json index 2e7d148e1a89..3bf31e40bb76 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json @@ -2810,7 +2810,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetListResult": { "properties": { @@ -3769,7 +3769,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -4052,7 +4052,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -4283,7 +4283,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -4774,7 +4774,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json index 000180840f8c..8a8e5e5e9ab4 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json @@ -3830,7 +3830,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetListResult": { "properties": { @@ -4858,7 +4858,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5199,7 +5199,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -5634,7 +5634,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { @@ -5992,7 +5992,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -6850,7 +6850,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json index f105482f5460..5484f19b36c2 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/disk.json @@ -930,7 +930,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "DiskUpdateProperties": { "properties": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-09-01/skus.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-09-01/skus.json index ff8befe46b36..bf69ca9fec22 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-09-01/skus.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-09-01/skus.json @@ -136,7 +136,7 @@ "description": "An invariant if the feature is measured by quantity." } }, - "description": "Describes The SKU capabilites object." + "description": "Describes The SKU capabilities object." }, "ResourceSkuRestrictions": { "properties": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json index 0b9727c1d4f3..a2db64ba6b8d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json @@ -4507,7 +4507,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetUpdate": { "properties": { @@ -5630,7 +5630,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5993,7 +5993,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -6655,7 +6655,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -7213,7 +7213,7 @@ }, "zoneBalance": { "type": "boolean", - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." }, "platformFaultDomainCount": { "type": "integer", @@ -7579,7 +7579,7 @@ "progress": { "$ref": "#/definitions/RollingUpgradeProgressInfo", "readOnly": true, - "description": "Counts of the VM's in each state." + "description": "Counts of the VMs in each state." }, "error": { "$ref": "#/definitions/ApiError", @@ -7691,7 +7691,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -8182,7 +8182,7 @@ }, "groupByOperationName": { "type": "boolean", - "description": "Group query result by by Operation Name." + "description": "Group query result by Operation Name." }, "groupByResourceName": { "type": "boolean", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json index 299fcb221983..40ae01b53db6 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json @@ -4324,7 +4324,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetUpdate": { "properties": { @@ -5459,7 +5459,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -5827,7 +5827,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -6499,7 +6499,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -7077,7 +7077,7 @@ }, "zoneBalance": { "type": "boolean", - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." }, "platformFaultDomainCount": { "type": "integer", @@ -7443,7 +7443,7 @@ "progress": { "$ref": "#/definitions/RollingUpgradeProgressInfo", "readOnly": true, - "description": "Counts of the VM's in each state." + "description": "Counts of the VMs in each state." }, "error": { "$ref": "#/definitions/ApiError", @@ -7555,7 +7555,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -8013,7 +8013,7 @@ }, "groupByOperationName": { "type": "boolean", - "description": "Group query result by by Operation Name." + "description": "Group query result by Operation Name." }, "groupByResourceName": { "type": "boolean", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json index e66db223e982..63102c9aa072 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/disk.json @@ -939,7 +939,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "DiskUpdateProperties": { "properties": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index a5c553e4825b..ed951d06a3cd 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -4450,7 +4450,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetUpdate": { "properties": { @@ -4921,7 +4921,7 @@ "description": "Specifies whether to reimage temp disk. Default value: false." } }, - "description": "Paramaters for Reimaging Virtual Machine. Default value for OSDisk : true." + "description": "Parameters for Reimaging Virtual Machine. Default value for OSDisk : true." }, "VirtualMachineCaptureParameters": { "properties": { @@ -5325,7 +5325,7 @@ "description": "Specifies the ephemeral disk settings for operating system disk." } }, - "description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." }, "ManagedDiskParameters": { "properties": { @@ -5632,7 +5632,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -6020,7 +6020,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -6708,7 +6708,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -7308,7 +7308,7 @@ }, "zoneBalance": { "type": "boolean", - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." }, "platformFaultDomainCount": { "type": "integer", @@ -7699,7 +7699,7 @@ "progress": { "$ref": "#/definitions/RollingUpgradeProgressInfo", "readOnly": true, - "description": "Counts of the VM's in each state." + "description": "Counts of the VMs in each state." }, "error": { "$ref": "#/definitions/ApiError", @@ -7815,7 +7815,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -8273,7 +8273,7 @@ }, "groupByOperationName": { "type": "boolean", - "description": "Group query result by by Operation Name." + "description": "Group query result by Operation Name." }, "groupByResourceName": { "type": "boolean", diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json index cb0bdfad60b4..05cee4453694 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/disk.json @@ -994,7 +994,7 @@ "description": "Resource Id" } }, - "description": "The vault id is an Azure Resource Manager Resoure id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" }, "DiskUpdateProperties": { "properties": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json index 2f01f93941a4..b5979cd12a0e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/gallery.json @@ -800,7 +800,7 @@ "properties": { "description": { "type": "string", - "description": "The description of this Shared Image Gallery resource. This property is updateable." + "description": "The description of this Shared Image Gallery resource. This property is updatable." }, "identifier": { "$ref": "#/definitions/GalleryIdentifier" @@ -850,7 +850,7 @@ "properties": { "description": { "type": "string", - "description": "The description of this gallery Image Definition resource. This property is updateable." + "description": "The description of this gallery Image Definition resource. This property is updatable." }, "eula": { "type": "string", @@ -891,7 +891,7 @@ "endOfLifeDate": { "type": "string", "format": "date-time", - "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updateable." + "description": "The end of life date of the gallery Image Definition. This property can be used for decommissioning purposes. This property is updatable." }, "identifier": { "$ref": "#/definitions/GalleryImageIdentifier" @@ -958,7 +958,7 @@ "$ref": "#/definitions/ResourceRange" } }, - "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updateable." + "description": "The properties describe the recommended machine configuration for this Image Definition. These properties are updatable." }, "ResourceRange": { "properties": { @@ -1058,7 +1058,7 @@ "items": { "$ref": "#/definitions/TargetRegion" }, - "description": "The target regions where the Image Version is going to be replicated to. This property is updateable." + "description": "The target regions where the Image Version is going to be replicated to. This property is updatable." }, "source": { "$ref": "#/definitions/GalleryArtifactSource" @@ -1078,7 +1078,7 @@ "regionalReplicaCount": { "type": "integer", "format": "int32", - "description": "The number of replicas of the Image Version to be created per region. This property is updateable." + "description": "The number of replicas of the Image Version to be created per region. This property is updatable." } }, "required": [ @@ -1114,7 +1114,7 @@ "replicaCount": { "type": "integer", "format": "int32", - "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updateable." + "description": "The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable." }, "excludeFromLatest": { "type": "boolean", @@ -1129,7 +1129,7 @@ "endOfLifeDate": { "type": "string", "format": "date-time", - "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updateable." + "description": "The end of life date of the gallery Image Version. This property can be used for decommissioning purposes. This property is updatable." } }, "allOf": [ diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 92c5580eca94..f39b5734dff2 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -4450,7 +4450,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "AvailabilitySetUpdate": { "properties": { @@ -4936,7 +4936,7 @@ "description": "Specifies whether to reimage temp disk. Default value: false." } }, - "description": "Paramaters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" }, "VirtualMachineCaptureParameters": { "properties": { @@ -5340,7 +5340,7 @@ "description": "Specifies the ephemeral disk settings for operating system disk." } }, - "description": "Describes the parameters of ephemeral disk settings that can be be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." }, "ManagedDiskParameters": { "properties": { @@ -5647,7 +5647,7 @@ }, "certificateStore": { "type": "string", - "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." } }, "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." @@ -6035,7 +6035,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -6723,7 +6723,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -7323,7 +7323,7 @@ }, "zoneBalance": { "type": "boolean", - "description": "Whether to force stictly even Virtual Machine distribution cross x-zones in case there is zone outage." + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." }, "platformFaultDomainCount": { "type": "integer", @@ -7714,7 +7714,7 @@ "progress": { "$ref": "#/definitions/RollingUpgradeProgressInfo", "readOnly": true, - "description": "Counts of the VM's in each state." + "description": "Counts of the VMs in each state." }, "error": { "$ref": "#/definitions/ApiError", @@ -7830,7 +7830,7 @@ }, "availabilitySet": { "$ref": "#/definitions/SubResource", - "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintainance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." }, "provisioningState": { "readOnly": true, @@ -8288,7 +8288,7 @@ }, "groupByOperationName": { "type": "boolean", - "description": "Group query result by by Operation Name." + "description": "Group query result by Operation Name." }, "groupByResourceName": { "type": "boolean", diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 84d30596a34c..b8a23076a955 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -437,7 +437,7 @@ input-file: ### Tag: package-container-service-2015-11-preview -These setings apply only when `--tag=package-container-service-2015-11-preview` is specified on the command line. +These settings apply only when `--tag=package-container-service-2015-11-preview` is specified on the command line. ``` yaml $(tag) == 'package-container-service-2015-11-preview' input-file: From b8a5a5059595e46f366e6e565ca217ef88896659 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:23:56 -0500 Subject: [PATCH 259/464] typo: Microsoft.DeploymentManager (#4683) - Individial -> Individual --- .../preview/2018-09-01-preview/deploymentmanager.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json index 374b64550baa..24e4f928fb11 100644 --- a/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json +++ b/specification/deploymentmanager/resource-manager/Microsoft.DeploymentManager/preview/2018-09-01-preview/deploymentmanager.json @@ -1163,7 +1163,7 @@ "artifactRoot": { "type": "string", "description": "The path from the location that the 'authentication' property [say, a SAS URI to the blob container] refers to, to the location of the artifacts. This can be used to differentiate different versions of the artifacts. Or, different types of artifacts like binaries or templates. The location referenced by the authentication property concatenated with this optional artifactRoot path forms the artifact source location where the artifacts are expected to be found.", - "example": "binaries/2018.09.24" + "example": "binaries/2018.09.24" }, "authentication": { "description": "The authentication method to use to access the artifact source.", @@ -1576,7 +1576,7 @@ } }, "ResourceOperation": { - "description": "Individial resource operation information.", + "description": "Individual resource operation information.", "properties": { "resourceName": { "type": "string", From 2c095ea285e849307f3ade0a29601b6af368b756 Mon Sep 17 00:00:00 2001 From: lshai06 Date: Mon, 3 Dec 2018 23:11:56 +0530 Subject: [PATCH 260/464] Migration APIs (#4425) * Migration APIs * Taken ARM review feedback --- .../examples/MigrationRecoveryPoints_Get.json | 25 + ...oints_ListByReplicationMigrationItems.json | 37 + .../ReplicationMigrationItems_Create.json | 54 + .../ReplicationMigrationItems_Delete.json | 17 + .../ReplicationMigrationItems_Get.json | 44 + .../ReplicationMigrationItems_List.json | 45 + ...ListByReplicationProtectionContainers.json | 47 + .../ReplicationMigrationItems_Migrate.json | 53 + ...ReplicationMigrationItems_TestMigrate.json | 53 + ...tionMigrationItems_TestMigrateCleanup.json | 51 + .../ReplicationMigrationItems_Update.json | 53 + ...ationRecoveryServicesProviders_Create.json | 54 + .../stable/2018-01-10/service.json | 2968 ++++++++++++++--- 13 files changed, 2954 insertions(+), 547 deletions(-) create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Create.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Delete.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Get.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_List.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Migrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrate.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrateCleanup.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Update.json create mode 100644 specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationRecoveryServicesProviders_Create.json diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_Get.json new file mode 100644 index 000000000000..554075080088 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_Get.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationRecoveryPointName": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "name": "b22134ea-620c-474b-9fa5-3c1cb47708e3", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/b22134ea-620c-474b-9fa5-3c1cb47708e3", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json new file mode 100644 index 000000000000..225aef277fe0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "648336ef-2d70-4d98-b100-8c299f97cd41", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/648336ef-2d70-4d98-b100-8c299f97cd41", + "properties": { + "recoveryPointTime": "2017-04-26T06:37:50.8082715Z", + "recoveryPointType": "CrashConsistent" + } + }, + { + "name": "34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems/migrationRecoveryPoints", + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1/migrationRecoveryPoints/34cb2d05-e730-4d3f-b96b-a60a5e92acb2", + "properties": { + "recoveryPointTime": "2017-04-26T07:37:30.9722019Z", + "recoveryPointType": "CrashConsistent" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Create.json new file mode 100644 index 000000000000..70c5deab9141 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Delete.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Delete.json new file mode 100644 index 000000000000..570f5b20e3a6 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "202": { + }, + "204": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Get.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Get.json new file mode 100644 index 000000000000..a33393f60f51 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_List.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_List.json new file mode 100644 index 000000000000..9db384f8dde0 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_List.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json new file mode 100644 index 000000000000..5628feeb165b --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + ] + } + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Migrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Migrate.json new file mode 100644 index 000000000000..c2822dd85a3a --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Migrate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "migrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrate.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrate.json new file mode 100644 index 000000000000..4f8c750843ea --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateInput": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrateCleanup.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrateCleanup.json new file mode 100644 index 000000000000..c361c8060fd3 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_TestMigrateCleanup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "testMigrateCleanupInput": { + "properties": { + "comments": "Test Failover Cleanup" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Update.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Update.json new file mode 100644 index 000000000000..404d0e0f77cc --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationMigrationItems_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "migrationItemName": "virtualmachine1", + "protectionContainerName": "vmwareContainer1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "input": { + "properties": { + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationProtectionContainers/vmwareContainer1/replicationMigrationItems/virtualmachine1", + "name": "virtualmachine1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationMigrationItems", + "properties": { + "machineName": "vm-0520-2", + "migrationState": "Replicating", + "migrationStateDescription": "Ready to migrate", + "testMigrateState": "None", + "testMigrateStateDescription": "None", + "policyFriendlyName": "vmwarepolicy1", + "policyId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationPolicies/vmwarepolicy1", + "allowedOperations": [ + "Migrate", + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup" + ], + "currentJob": { + "jobName": "None", + "jobId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationJobs/None", + "startTime": "2017-04-26T06:37:50.8082715Z" + }, + "providerSpecificDetails": { + "instanceType": "VMwareCbt" + }, + "recoveryServicesProviderId": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/45b55118-f42d-505f-8bde-f3745258171f" + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationRecoveryServicesProviders_Create.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationRecoveryServicesProviders_Create.json new file mode 100644 index 000000000000..9500aafc02e5 --- /dev/null +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/examples/ReplicationRecoveryServicesProviders_Create.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-01-10", + "providerName": "vmwareprovider1", + "fabricName": "vmwarefabric1", + "resourceName": "migrationvault", + "resourceGroupName": "resourcegroup1", + "subscriptionId": "cb53d0c3-bd59-4721-89bc-06916a9147ef", + "addProviderInput": { + "properties": { + "machineName": "vmwareprovider1", + "authenticationIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + }, + "resourceAccessIdentityInput": { + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "applicationId": "f66fce08-c0c6-47a1-beeb-0ede5ea94f90", + "objectId": "141360b8-5686-4240-a027-5e24e6affeba", + "audience": "https://microsoft.onmicrosoft.com/cf19e349-644c-4c6a-bcae-9c8f35357874", + "aadAuthority": "https://login.microsoftonline.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/Subscriptions/cb53d0c3-bd59-4721-89bc-06916a9147ef/resourceGroups/resourcegroup1/providers/Microsoft.RecoveryServices/vaults/migrationvault/replicationFabrics/vmwarefabric1/replicationRecoveryServicesProviders/vmwareprovider1", + "type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationRecoveryServicesProviders", + "name": "vmwareprovider1", + "properties": { + "fabricType": "VMwareV2", + "friendlyName": "vmwareprovider1", + "providerVersion": "5.1.3688.0", + "serverVersion": "3.2.7510.0", + "providerVersionState": "Latest", + "fabricFriendlyName": "vmwarefabric1", + "lastHeartBeat": "2017-04-27T09:16:04.9405768Z", + "connectionStatus": "Connected", + "protectedItemCount": 2, + "allowedScenarios": [ + "Refresh" + ] + } + } + }, + "202": { + } + } +} diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json index 4380a76e3b10..3445404c5856 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json @@ -1606,14 +1606,14 @@ } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems": { "get": { "tags": [ - "ReplicationProtectableItems" + "ReplicationMigrationItems" ], - "summary": "Gets the list of protectable items.", - "description": "Lists the protectable items in a protection container.", - "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", + "summary": "Gets the list of migration items in the protection container.", + "description": "Gets the list of ASR migration items in the protection container.", + "operationId": "ReplicationMigrationItems_ListByReplicationProtectionContainers", "produces": [ "application/json" ], @@ -1643,42 +1643,33 @@ "description": "Protection container name.", "required": true, "type": "string" - }, - { - "name": "$filter", - "in": "query", - "description": "OData filter options.", - "required": false, - "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ProtectableItemCollection" + "$ref": "#/definitions/MigrationItemCollection" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, - "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", "x-ms-examples": { - "Gets the list of protectable items.": { - "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" + "Gets the list of migration items in the protection container.": { + "$ref": "./examples/ReplicationMigrationItems_ListByReplicationProtectionContainers.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}": { "get": { "tags": [ - "ReplicationProtectableItems" + "ReplicationMigrationItems" ], - "summary": "Gets the details of a protectable item.", - "description": "The operation to get the details of a protectable item.", - "operationId": "ReplicationProtectableItems_Get", + "summary": "Gets the details of a migration item.", + "operationId": "ReplicationMigrationItems_Get", "produces": [ "application/json" ], @@ -1698,7 +1689,7 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "Fabric unique name.", "required": true, "type": "string" }, @@ -1710,9 +1701,9 @@ "type": "string" }, { - "name": "protectableItemName", + "name": "migrationItemName", "in": "path", - "description": "Protectable item name.", + "description": "Migration item name.", "required": true, "type": "string" } @@ -1721,25 +1712,26 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ProtectableItem" + "$ref": "#/definitions/MigrationItem" } } }, "x-ms-examples": { - "Gets the details of a protectable item.": { - "$ref": "./examples/ReplicationProtectableItems_Get.json" + "Gets the details of a migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Get.json" } } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { - "get": { + }, + "put": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" + ], + "summary": "Enables migration.", + "description": "The operation to create an ASR migration item (enable migration).", + "operationId": "ReplicationMigrationItems_Create", + "consumes": [ + "application/json" ], - "summary": "Gets the list of Replication protected items.", - "description": "Gets the list of ASR replication protected items in the protection container.", - "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", "produces": [ "application/json" ], @@ -1769,34 +1761,49 @@ "description": "Protection container name.", "required": true, "type": "string" + }, + { + "name": "migrationItemName", + "in": "path", + "description": "Migration item name.", + "required": true, + "type": "string" + }, + { + "name": "input", + "in": "body", + "description": "Enable migration input.", + "required": true, + "schema": { + "$ref": "#/definitions/EnableMigrationInput" + } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItemCollection" + "$ref": "#/definitions/MigrationItem" } + }, + "202": { + "description": "Accepted" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gets the list of Replication protected items.": { - "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" + "Enables migration.": { + "$ref": "./examples/ReplicationMigrationItems_Create.json" } } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { - "get": { + }, + "delete": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" ], - "summary": "Gets the details of a Replication protected item.", - "description": "Gets the details of an ASR replication protected item.", - "operationId": "ReplicationProtectedItems_Get", + "summary": "Delete the migration item.", + "description": "The operation to delete an ASR migration item.", + "operationId": "ReplicationMigrationItems_Delete", "produces": [ "application/json" ], @@ -1816,7 +1823,7 @@ { "name": "fabricName", "in": "path", - "description": "Fabric unique name.", + "description": "Fabric name.", "required": true, "type": "string" }, @@ -1828,34 +1835,42 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "Replication protected item name.", + "description": "Migration item name.", "required": true, "type": "string" + }, + { + "name": "deleteOption", + "in": "query", + "description": "The delete option.", + "required": false, + "type": "string" } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" - } + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" } }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gets the details of a Replication protected item.": { - "$ref": "./examples/ReplicationProtectedItems_Get.json" + "Delete the migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Delete.json" } } }, - "put": { + "patch": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" ], - "summary": "Enables protection.", - "description": "The operation to create an ASR replication protected item (Enable replication).", - "operationId": "ReplicationProtectedItems_Create", + "summary": "Updates migration item.", + "description": "The operation to update the recovery settings of an ASR migration item.", + "operationId": "ReplicationMigrationItems_Update", "consumes": [ "application/json" ], @@ -1878,7 +1893,7 @@ { "name": "fabricName", "in": "path", - "description": "Name of the fabric.", + "description": "Fabric name.", "required": true, "type": "string" }, @@ -1890,19 +1905,19 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "A name for the replication protected item.", + "description": "Migration item name.", "required": true, "type": "string" }, { "name": "input", "in": "body", - "description": "Enable Protection Input.", + "description": "Update migration item input.", "required": true, "schema": { - "$ref": "#/definitions/EnableProtectionInput" + "$ref": "#/definitions/UpdateMigrationItemInput" } } ], @@ -1910,7 +1925,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" + "$ref": "#/definitions/MigrationItem" } }, "202": { @@ -1919,18 +1934,23 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Enables protection.": { - "$ref": "./examples/ReplicationProtectedItems_Create.json" + "Updates migration item.": { + "$ref": "./examples/ReplicationMigrationItems_Update.json" } } - }, - "delete": { + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrate": { + "post": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" + ], + "summary": "Migrate item.", + "description": "The operation to initiate migration of the item.", + "operationId": "ReplicationMigrationItems_Migrate", + "consumes": [ + "application/json" ], - "summary": "Purges protection.", - "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", - "operationId": "ReplicationProtectedItems_Purge", "produces": [ "application/json" ], @@ -1962,38 +1982,48 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "Replication protected item name.", + "description": "Migration item name.", "required": true, "type": "string" + }, + { + "name": "migrateInput", + "in": "body", + "description": "Migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/MigrateInput" + } } ], "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItem" + } + }, "202": { "description": "Accepted" - }, - "204": { - "description": "NoContent" } }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Purges protection.": { - "$ref": "./examples/ReplicationProtectedItems_Purge.json" + "Migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_Migrate.json" } } - }, - "patch": { + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints": { + "get": { "tags": [ - "ReplicationProtectedItems" - ], - "summary": "Updates protection.", - "description": "The operation to update the recovery settings of an ASR replication protected item.", - "operationId": "ReplicationProtectedItems_Update", - "consumes": [ - "application/json" + "MigrationRecoveryPoints" ], + "summary": "Gets the recovery points for a migration item.", + "operationId": "MigrationRecoveryPoints_ListByReplicationMigrationItems", "produces": [ "application/json" ], @@ -2013,7 +2043,7 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "Fabric unique name.", "required": true, "type": "string" }, @@ -2025,52 +2055,38 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "Replication protected item name.", + "description": "Migration item name.", "required": true, "type": "string" - }, - { - "name": "updateProtectionInput", - "in": "body", - "description": "Update protection input.", - "required": true, - "schema": { - "$ref": "#/definitions/UpdateReplicationProtectedItemInput" - } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" + "$ref": "#/definitions/MigrationRecoveryPointCollection" } - }, - "202": { - "description": "Accepted" } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Updates protection.": { - "$ref": "./examples/ReplicationProtectedItems_Update.json" + "Gets the recovery points for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_ListByReplicationMigrationItems.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { - "post": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/migrationRecoveryPoints/{migrationRecoveryPointName}": { + "get": { "tags": [ - "ReplicationProtectedItems" - ], - "summary": "Change or apply recovery point.", - "description": "The operation to change the recovery point of a failed over replication protected item.", - "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", - "consumes": [ - "application/json" + "MigrationRecoveryPoints" ], + "summary": "Gets a recovery point for a migration item.", + "operationId": "MigrationRecoveryPoints_Get", "produces": [ "application/json" ], @@ -2090,61 +2106,58 @@ { "name": "fabricName", "in": "path", - "description": "The ARM fabric name.", + "description": "Fabric unique name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "The protection container name.", + "description": "Protection container name.", "required": true, "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "The replicated protected item's name.", + "description": "Migration item name.", "required": true, "type": "string" }, { - "name": "applyRecoveryPointInput", - "in": "body", - "description": "The ApplyRecoveryPointInput.", + "name": "migrationRecoveryPointName", + "in": "path", + "description": "The migration recovery point name.", "required": true, - "schema": { - "$ref": "#/definitions/ApplyRecoveryPointInput" - } + "type": "string" } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" + "$ref": "#/definitions/MigrationRecoveryPoint" } - }, - "202": { - "description": "Accepted" } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Change or apply recovery point.": { - "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" + "Gets a recovery point for a migration item.": { + "$ref": "./examples/MigrationRecoveryPoints_Get.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrate": { "post": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" + ], + "summary": "Test migrate item.", + "description": "The operation to initiate test migration of the item.", + "operationId": "ReplicationMigrationItems_TestMigrate", + "consumes": [ + "application/json" ], - "summary": "Execute commit failover", - "description": "Operation to commit the failover of the replication protected item.", - "operationId": "ReplicationProtectedItems_FailoverCommit", "produces": [ "application/json" ], @@ -2164,7 +2177,7 @@ { "name": "fabricName", "in": "path", - "description": "Unique fabric name.", + "description": "Fabric name.", "required": true, "type": "string" }, @@ -2176,18 +2189,27 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "Replication protected item name.", + "description": "Migration item name.", "required": true, "type": "string" + }, + { + "name": "testMigrateInput", + "in": "body", + "description": "Test migrate input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestMigrateInput" + } } ], "responses": { "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" + "$ref": "#/definitions/MigrationItem" } }, "202": { @@ -2196,20 +2218,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute commit failover": { - "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" + "Test migrate item.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrate.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationMigrationItems/{migrationItemName}/testMigrateCleanup": { "post": { "tags": [ - "ReplicationProtectedItems" + "ReplicationMigrationItems" ], - "summary": "Execute planned failover", - "description": "Operation to initiate a planned failover of the replication protected item.", - "operationId": "ReplicationProtectedItems_PlannedFailover", + "summary": "Test migrate cleanup.", + "description": "The operation to initiate test migrate cleanup.", + "operationId": "ReplicationMigrationItems_TestMigrateCleanup", "consumes": [ "application/json" ], @@ -2232,7 +2254,7 @@ { "name": "fabricName", "in": "path", - "description": "Unique fabric name.", + "description": "Fabric name.", "required": true, "type": "string" }, @@ -2244,19 +2266,19 @@ "type": "string" }, { - "name": "replicatedProtectedItemName", + "name": "migrationItemName", "in": "path", - "description": "Replication protected item name.", + "description": "Migration item name.", "required": true, "type": "string" }, { - "name": "failoverInput", + "name": "testMigrateCleanupInput", "in": "body", - "description": "Disable protection input.", + "description": "Test migrate cleanup input.", "required": true, "schema": { - "$ref": "#/definitions/PlannedFailoverInput" + "$ref": "#/definitions/TestMigrateCleanupInput" } } ], @@ -2264,7 +2286,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ReplicationProtectedItem" + "$ref": "#/definitions/MigrationItem" } }, "202": { @@ -2273,20 +2295,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute planned failover": { - "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" + "Test migrate cleanup.": { + "$ref": "./examples/ReplicationMigrationItems_TestMigrateCleanup.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems": { "get": { "tags": [ - "RecoveryPoints" + "ReplicationProtectableItems" ], - "summary": "Get recovery points for a replication protected item.", - "description": "Lists the available recovery points for a replication protected item.", - "operationId": "RecoveryPoints_ListByReplicationProtectedItems", + "summary": "Gets the list of protectable items.", + "description": "Lists the protectable items in a protection container.", + "operationId": "ReplicationProtectableItems_ListByReplicationProtectionContainers", "produces": [ "application/json" ], @@ -2306,22 +2328,22 @@ { "name": "fabricName", "in": "path", - "description": "The fabric name.", + "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "The protection container name.", + "description": "Protection container name.", "required": true, "type": "string" }, { - "name": "replicatedProtectedItemName", - "in": "path", - "description": "The replication protected item's name.", - "required": true, + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, "type": "string" } ], @@ -2329,28 +2351,29 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RecoveryPointCollection" + "$ref": "#/definitions/ProtectableItemCollection" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/ProtectableItemQueryParameter", "x-ms-examples": { - "Get recovery points for a replication protected item.": { - "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" + "Gets the list of protectable items.": { + "$ref": "./examples/ReplicationProtectableItems_ListByReplicationProtectionContainers.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectableItems/{protectableItemName}": { "get": { "tags": [ - "RecoveryPoints" + "ReplicationProtectableItems" ], - "summary": "Get a recovery point.", - "description": "Get the details of specified recovery point.", - "operationId": "RecoveryPoints_Get", + "summary": "Gets the details of a protectable item.", + "description": "The operation to get the details of a protectable item.", + "operationId": "ReplicationProtectableItems_Get", "produces": [ "application/json" ], @@ -2370,28 +2393,21 @@ { "name": "fabricName", "in": "path", - "description": "The fabric name.", + "description": "Fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "The protection container name.", - "required": true, - "type": "string" - }, - { - "name": "replicatedProtectedItemName", - "in": "path", - "description": "The replication protected item's name.", + "description": "Protection container name.", "required": true, "type": "string" }, { - "name": "recoveryPointName", + "name": "protectableItemName", "in": "path", - "description": "The recovery point name.", + "description": "Protectable item name.", "required": true, "type": "string" } @@ -2400,28 +2416,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/RecoveryPoint" + "$ref": "#/definitions/ProtectableItem" } } }, "x-ms-examples": { - "Get a recovery point.": { - "$ref": "./examples/RecoveryPoints_Get.json" + "Gets the details of a protectable item.": { + "$ref": "./examples/ReplicationProtectableItems_Get.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { - "post": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems": { + "get": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Disables protection.", - "description": "The operation to disable replication on a replication protected item. This will also remove the item.", - "operationId": "ReplicationProtectedItems_Delete", - "consumes": [ - "application/json" - ], + "summary": "Gets the list of Replication protected items.", + "description": "Gets the list of ASR replication protected items in the protection container.", + "operationId": "ReplicationProtectedItems_ListByReplicationProtectionContainers", "produces": [ "application/json" ], @@ -2451,48 +2464,34 @@ "description": "Protection container name.", "required": true, "type": "string" - }, - { - "name": "replicatedProtectedItemName", - "in": "path", - "description": "Replication protected item name.", - "required": true, - "type": "string" - }, - { - "name": "disableProtectionInput", - "in": "body", - "description": "Disable protection input.", - "required": true, - "schema": { - "$ref": "#/definitions/DisableProtectionInput" - } } ], "responses": { - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItemCollection" + } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Disables protection.": { - "$ref": "./examples/ReplicationProtectedItems_Delete.json" + "Gets the list of Replication protected items.": { + "$ref": "./examples/ReplicationProtectedItems_ListByReplicationProtectionContainers.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { - "post": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}": { + "get": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Resynchronize or repair replication.", - "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", - "operationId": "ReplicationProtectedItems_RepairReplication", + "summary": "Gets the details of a Replication protected item.", + "description": "Gets the details of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Get", "produces": [ "application/json" ], @@ -2512,21 +2511,21 @@ { "name": "fabricName", "in": "path", - "description": "The name of the fabric.", + "description": "Fabric unique name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "The name of the container.", + "description": "Protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", - "description": "The name of the replication protected item.", + "description": "Replication protected item name.", "required": true, "type": "string" } @@ -2537,27 +2536,21 @@ "schema": { "$ref": "#/definitions/ReplicationProtectedItem" } - }, - "202": { - "description": "Accepted" } }, - "x-ms-long-running-operation": true, "x-ms-examples": { - "Resynchronize or repair replication.": { - "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" + "Gets the details of a Replication protected item.": { + "$ref": "./examples/ReplicationProtectedItems_Get.json" } } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { - "post": { + }, + "put": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Execute Reverse Replication\\Reprotect", - "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", - "operationId": "ReplicationProtectedItems_Reprotect", + "summary": "Enables protection.", + "description": "The operation to create an ASR replication protected item (Enable replication).", + "operationId": "ReplicationProtectedItems_Create", "consumes": [ "application/json" ], @@ -2580,7 +2573,7 @@ { "name": "fabricName", "in": "path", - "description": "Unique fabric name.", + "description": "Name of the fabric.", "required": true, "type": "string" }, @@ -2594,17 +2587,17 @@ { "name": "replicatedProtectedItemName", "in": "path", - "description": "Replication protected item name.", + "description": "A name for the replication protected item.", "required": true, "type": "string" }, { - "name": "rrInput", + "name": "input", "in": "body", - "description": "Disable protection input.", + "description": "Enable Protection Input.", "required": true, "schema": { - "$ref": "#/definitions/ReverseReplicationInput" + "$ref": "#/definitions/EnableProtectionInput" } } ], @@ -2621,20 +2614,18 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute Reverse Replication\\Reprotect": { - "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" + "Enables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Create.json" } } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { - "get": { + }, + "delete": { "tags": [ - "TargetComputeSizes" + "ReplicationProtectedItems" ], - "summary": "Gets the list of target compute sizes for the replication protected item.", - "description": "Lists the available target compute sizes for a replication protected item.", - "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", + "summary": "Purges protection.", + "description": "The operation to delete or purge a replication protected item. This operation will force delete the replication protected item. Use the remove operation on replication protected item to perform a clean disable replication for the item.", + "operationId": "ReplicationProtectedItems_Purge", "produces": [ "application/json" ], @@ -2661,7 +2652,7 @@ { "name": "protectionContainerName", "in": "path", - "description": "protection container name.", + "description": "Protection container name.", "required": true, "type": "string" }, @@ -2674,31 +2665,27 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/TargetComputeSizeCollection" - } + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" } }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, + "x-ms-long-running-operation": true, "x-ms-examples": { - "Gets the list of target compute sizes for the replication protected item.": { - "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" + "Purges protection.": { + "$ref": "./examples/ReplicationProtectedItems_Purge.json" } } - } - }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { - "post": { + }, + "patch": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Execute test failover", - "description": "Operation to perform a test failover of the replication protected item.", - "operationId": "ReplicationProtectedItems_TestFailover", + "summary": "Updates protection.", + "description": "The operation to update the recovery settings of an ASR replication protected item.", + "operationId": "ReplicationProtectedItems_Update", "consumes": [ "application/json" ], @@ -2721,7 +2708,7 @@ { "name": "fabricName", "in": "path", - "description": "Unique fabric name.", + "description": "Fabric name.", "required": true, "type": "string" }, @@ -2740,12 +2727,12 @@ "type": "string" }, { - "name": "failoverInput", + "name": "updateProtectionInput", "in": "body", - "description": "Test failover input.", + "description": "Update protection input.", "required": true, "schema": { - "$ref": "#/definitions/TestFailoverInput" + "$ref": "#/definitions/UpdateReplicationProtectedItemInput" } } ], @@ -2762,20 +2749,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute test failover": { - "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + "Updates protection.": { + "$ref": "./examples/ReplicationProtectedItems_Update.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/applyRecoveryPoint": { "post": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Execute test failover cleanup.", - "description": "Operation to clean up the test failover of a replication protected item.", - "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "summary": "Change or apply recovery point.", + "description": "The operation to change the recovery point of a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_ApplyRecoveryPoint", "consumes": [ "application/json" ], @@ -2798,31 +2785,31 @@ { "name": "fabricName", "in": "path", - "description": "Unique fabric name.", + "description": "The ARM fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "Protection container name.", + "description": "The protection container name.", "required": true, "type": "string" }, { "name": "replicatedProtectedItemName", "in": "path", - "description": "Replication protected item name.", + "description": "The replicated protected item's name.", "required": true, "type": "string" }, { - "name": "cleanupInput", + "name": "applyRecoveryPointInput", "in": "body", - "description": "Test failover cleanup input.", + "description": "The ApplyRecoveryPointInput.", "required": true, "schema": { - "$ref": "#/definitions/TestFailoverCleanupInput" + "$ref": "#/definitions/ApplyRecoveryPointInput" } } ], @@ -2839,23 +2826,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute test failover cleanup.": { - "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + "Change or apply recovery point.": { + "$ref": "./examples/ReplicationProtectedItems_ApplyRecoveryPoint.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/failoverCommit": { "post": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Execute unplanned failover", - "description": "Operation to initiate a failover of the replication protected item.", - "operationId": "ReplicationProtectedItems_UnplannedFailover", - "consumes": [ - "application/json" - ], + "summary": "Execute commit failover", + "description": "Operation to commit the failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_FailoverCommit", "produces": [ "application/json" ], @@ -2892,15 +2876,6 @@ "description": "Replication protected item name.", "required": true, "type": "string" - }, - { - "name": "failoverInput", - "in": "body", - "description": "Disable protection input.", - "required": true, - "schema": { - "$ref": "#/definitions/UnplannedFailoverInput" - } } ], "responses": { @@ -2916,22 +2891,22 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Execute unplanned failover": { - "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + "Execute commit failover": { + "$ref": "./examples/ReplicationProtectedItems_FailoverCommit.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicationProtectedItemName}/updateMobilityService": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/plannedFailover": { "post": { "tags": [ "ReplicationProtectedItems" ], - "summary": "Update the mobility service on a protected item.", - "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", - "operationId": "ReplicationProtectedItems_UpdateMobilityService", - "consumes": [ - "application/json" + "summary": "Execute planned failover", + "description": "Operation to initiate a planned failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_PlannedFailover", + "consumes": [ + "application/json" ], "produces": [ "application/json" @@ -2952,31 +2927,31 @@ { "name": "fabricName", "in": "path", - "description": "The name of the fabric containing the protected item.", + "description": "Unique fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "The name of the container containing the protected item.", + "description": "Protection container name.", "required": true, "type": "string" }, { - "name": "replicationProtectedItemName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "The name of the protected item on which the agent is to be updated.", + "description": "Replication protected item name.", "required": true, "type": "string" }, { - "name": "updateMobilityServiceRequest", + "name": "failoverInput", "in": "body", - "description": "Request to update the mobility service on the protected item.", + "description": "Disable protection input.", "required": true, "schema": { - "$ref": "#/definitions/UpdateMobilityServiceRequest" + "$ref": "#/definitions/PlannedFailoverInput" } } ], @@ -2993,20 +2968,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Update the mobility service on a protected item.": { - "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + "Execute planned failover": { + "$ref": "./examples/ReplicationProtectedItems_PlannedFailover.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints": { "get": { "tags": [ - "ReplicationProtectionContainerMappings" + "RecoveryPoints" ], - "summary": "Gets the list of protection container mappings for a protection container.", - "description": "Lists the protection container mappings for a protection container.", - "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "summary": "Get recovery points for a replication protected item.", + "description": "Lists the available recovery points for a replication protected item.", + "operationId": "RecoveryPoints_ListByReplicationProtectedItems", "produces": [ "application/json" ], @@ -3026,14 +3001,21 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "The fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "Protection container name.", + "description": "The protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "The replication protected item's name.", "required": true, "type": "string" } @@ -3042,7 +3024,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ProtectionContainerMappingCollection" + "$ref": "#/definitions/RecoveryPointCollection" } } }, @@ -3050,20 +3032,20 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Gets the list of protection container mappings for a protection container.": { - "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + "Get recovery points for a replication protected item.": { + "$ref": "./examples/RecoveryPoints_ListByReplicationProtectedItems.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/recoveryPoints/{recoveryPointName}": { "get": { "tags": [ - "ReplicationProtectionContainerMappings" + "RecoveryPoints" ], - "summary": "Gets a protection container mapping/", - "description": "Gets the details of a protection container mapping.", - "operationId": "ReplicationProtectionContainerMappings_Get", + "summary": "Get a recovery point.", + "description": "Get the details of specified recovery point.", + "operationId": "RecoveryPoints_Get", "produces": [ "application/json" ], @@ -3083,21 +3065,28 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "The fabric name.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "Protection container name.", + "description": "The protection container name.", "required": true, "type": "string" }, { - "name": "mappingName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "Protection Container mapping name.", + "description": "The replication protected item's name.", + "required": true, + "type": "string" + }, + { + "name": "recoveryPointName", + "in": "path", + "description": "The recovery point name.", "required": true, "type": "string" } @@ -3106,23 +3095,25 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ProtectionContainerMapping" + "$ref": "#/definitions/RecoveryPoint" } } }, "x-ms-examples": { - "Gets a protection container mapping/": { - "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + "Get a recovery point.": { + "$ref": "./examples/RecoveryPoints_Get.json" } } - }, - "put": { + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/remove": { + "post": { "tags": [ - "ReplicationProtectionContainerMappings" + "ReplicationProtectedItems" ], - "summary": "Create protection container mapping.", - "description": "The operation to create a protection container mapping.", - "operationId": "ReplicationProtectionContainerMappings_Create", + "summary": "Disables protection.", + "description": "The operation to disable replication on a replication protected item. This will also remove the item.", + "operationId": "ReplicationProtectedItems_Delete", "consumes": [ "application/json" ], @@ -3157,47 +3148,46 @@ "type": "string" }, { - "name": "mappingName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "Protection container mapping name.", + "description": "Replication protected item name.", "required": true, "type": "string" }, { - "name": "creationInput", + "name": "disableProtectionInput", "in": "body", - "description": "Mapping creation input.", + "description": "Disable protection input.", "required": true, "schema": { - "$ref": "#/definitions/CreateProtectionContainerMappingInput" + "$ref": "#/definitions/DisableProtectionInput" } } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ProtectionContainerMapping" - } - }, "202": { "description": "Accepted" + }, + "204": { + "description": "NoContent" } }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Create protection container mapping.": { - "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + "Disables protection.": { + "$ref": "./examples/ReplicationProtectedItems_Delete.json" } } - }, - "delete": { + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/repairReplication": { + "post": { "tags": [ - "ReplicationProtectionContainerMappings" + "ReplicationProtectedItems" ], - "summary": "Purge protection container mapping.", - "description": "The operation to purge(force delete) a protection container mapping", - "operationId": "ReplicationProtectionContainerMappings_Purge", + "summary": "Resynchronize or repair replication.", + "description": "The operation to start resynchronize/repair replication for a replication protected item requiring resynchronization.", + "operationId": "ReplicationProtectedItems_RepairReplication", "produces": [ "application/json" ], @@ -3217,47 +3207,52 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "The name of the fabric.", "required": true, "type": "string" }, { "name": "protectionContainerName", "in": "path", - "description": "Protection container name.", + "description": "The name of the container.", "required": true, "type": "string" }, { - "name": "mappingName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "Protection container mapping name.", + "description": "The name of the replication protected item.", "required": true, "type": "string" } ], "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, "202": { "description": "Accepted" - }, - "204": { - "description": "NoContent" } }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Purge protection container mapping.": { - "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + "Resynchronize or repair replication.": { + "$ref": "./examples/ReplicationProtectedItems_RepairReplication.json" } } - }, - "patch": { + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/reProtect": { + "post": { "tags": [ - "ReplicationProtectionContainerMappings" + "ReplicationProtectedItems" ], - "summary": "Update protection container mapping.", - "description": "The operation to update protection container mapping.", - "operationId": "ReplicationProtectionContainerMappings_Update", + "summary": "Execute Reverse Replication\\Reprotect", + "description": "Operation to reprotect or reverse replicate a failed over replication protected item.", + "operationId": "ReplicationProtectedItems_Reprotect", "consumes": [ "application/json" ], @@ -3280,7 +3275,7 @@ { "name": "fabricName", "in": "path", - "description": "Fabric name.", + "description": "Unique fabric name.", "required": true, "type": "string" }, @@ -3292,19 +3287,19 @@ "type": "string" }, { - "name": "mappingName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "Protection container mapping name.", + "description": "Replication protected item name.", "required": true, "type": "string" }, { - "name": "updateInput", + "name": "rrInput", "in": "body", - "description": "Mapping update input.", + "description": "Disable protection input.", "required": true, "schema": { - "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + "$ref": "#/definitions/ReverseReplicationInput" } } ], @@ -3312,7 +3307,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/ProtectionContainerMapping" + "$ref": "#/definitions/ReplicationProtectedItem" } }, "202": { @@ -3321,23 +3316,20 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Update protection container mapping.": { - "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + "Execute Reverse Replication\\Reprotect": { + "$ref": "./examples/ReplicationProtectedItems_Reprotect.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { - "post": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/targetComputeSizes": { + "get": { "tags": [ - "ReplicationProtectionContainerMappings" - ], - "summary": "Remove protection container mapping.", - "description": "The operation to delete or remove a protection container mapping.", - "operationId": "ReplicationProtectionContainerMappings_Delete", - "consumes": [ - "application/json" + "TargetComputeSizes" ], + "summary": "Gets the list of target compute sizes for the replication protected item.", + "description": "Lists the available target compute sizes for a replication protected item.", + "operationId": "TargetComputeSizes_ListByReplicationProtectedItems", "produces": [ "application/json" ], @@ -3364,51 +3356,44 @@ { "name": "protectionContainerName", "in": "path", - "description": "Protection container name.", + "description": "protection container name.", "required": true, "type": "string" }, { - "name": "mappingName", + "name": "replicatedProtectedItemName", "in": "path", - "description": "Protection container mapping name.", + "description": "Replication protected item name.", "required": true, "type": "string" - }, - { - "name": "removalInput", - "in": "body", - "description": "Removal input.", - "required": true, - "schema": { - "$ref": "#/definitions/RemoveProtectionContainerMappingInput" - } } ], "responses": { - "202": { - "description": "Accepted" - }, - "204": { - "description": "NoContent" + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TargetComputeSizeCollection" + } } }, - "x-ms-long-running-operation": true, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "x-ms-examples": { - "Remove protection container mapping.": { - "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + "Gets the list of target compute sizes for the replication protected item.": { + "$ref": "./examples/TargetComputeSizes_ListByReplicationProtectedItems.json" } } } }, - "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailover": { "post": { "tags": [ - "ReplicationProtectionContainers" + "ReplicationProtectedItems" ], - "summary": "Switches protection from one container to another or one replication provider to another.", - "description": "Operation to switch protection from one container to another or one replication provider to another.", - "operationId": "ReplicationProtectionContainers_SwitchProtection", + "summary": "Execute test failover", + "description": "Operation to perform a test failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailover", "consumes": [ "application/json" ], @@ -3443,12 +3428,722 @@ "type": "string" }, { - "name": "switchInput", + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", "in": "body", - "description": "Switch protection input.", + "description": "Test failover input.", "required": true, "schema": { - "$ref": "#/definitions/SwitchProtectionInput" + "$ref": "#/definitions/TestFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover": { + "$ref": "./examples/ReplicationProtectedItems_TestFailover.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/testFailoverCleanup": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute test failover cleanup.", + "description": "Operation to clean up the test failover of a replication protected item.", + "operationId": "ReplicationProtectedItems_TestFailoverCleanup", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "cleanupInput", + "in": "body", + "description": "Test failover cleanup input.", + "required": true, + "schema": { + "$ref": "#/definitions/TestFailoverCleanupInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute test failover cleanup.": { + "$ref": "./examples/ReplicationProtectedItems_TestFailoverCleanup.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicatedProtectedItemName}/unplannedFailover": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Execute unplanned failover", + "description": "Operation to initiate a failover of the replication protected item.", + "operationId": "ReplicationProtectedItems_UnplannedFailover", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "replicatedProtectedItemName", + "in": "path", + "description": "Replication protected item name.", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "in": "body", + "description": "Disable protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/UnplannedFailoverInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Execute unplanned failover": { + "$ref": "./examples/ReplicationProtectedItems_UnplannedFailover.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectedItems/{replicationProtectedItemName}/updateMobilityService": { + "post": { + "tags": [ + "ReplicationProtectedItems" + ], + "summary": "Update the mobility service on a protected item.", + "description": "The operation to update(push update) the installed mobility service software on a replication protected item to the latest available version.", + "operationId": "ReplicationProtectedItems_UpdateMobilityService", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "The name of the fabric containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "The name of the container containing the protected item.", + "required": true, + "type": "string" + }, + { + "name": "replicationProtectedItemName", + "in": "path", + "description": "The name of the protected item on which the agent is to be updated.", + "required": true, + "type": "string" + }, + { + "name": "updateMobilityServiceRequest", + "in": "body", + "description": "Request to update the mobility service on the protected item.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateMobilityServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ReplicationProtectedItem" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update the mobility service on a protected item.": { + "$ref": "./examples/ReplicationProtectedItems_UpdateMobilityService.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets the list of protection container mappings for a protection container.", + "description": "Lists the protection container mappings for a protection container.", + "operationId": "ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMappingCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets the list of protection container mappings for a protection container.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_ListByReplicationProtectionContainers.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}": { + "get": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Gets a protection container mapping/", + "description": "Gets the details of a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection Container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + } + }, + "x-ms-examples": { + "Gets a protection container mapping/": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Get.json" + } + } + }, + "put": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Create protection container mapping.", + "description": "The operation to create a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "creationInput", + "in": "body", + "description": "Mapping creation input.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Create.json" + } + } + }, + "delete": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Purge protection container mapping.", + "description": "The operation to purge(force delete) a protection container mapping", + "operationId": "ReplicationProtectionContainerMappings_Purge", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Purge protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Purge.json" + } + } + }, + "patch": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Update protection container mapping.", + "description": "The operation to update protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "updateInput", + "in": "body", + "description": "Mapping update input.", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateProtectionContainerMappingInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProtectionContainerMapping" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Update.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/replicationProtectionContainerMappings/{mappingName}/remove": { + "post": { + "tags": [ + "ReplicationProtectionContainerMappings" + ], + "summary": "Remove protection container mapping.", + "description": "The operation to delete or remove a protection container mapping.", + "operationId": "ReplicationProtectionContainerMappings_Delete", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "mappingName", + "in": "path", + "description": "Protection container mapping name.", + "required": true, + "type": "string" + }, + { + "name": "removalInput", + "in": "body", + "description": "Removal input.", + "required": true, + "schema": { + "$ref": "#/definitions/RemoveProtectionContainerMappingInput" + } + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Remove protection container mapping.": { + "$ref": "./examples/ReplicationProtectionContainerMappings_Delete.json" + } + } + } + }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationFabrics/{fabricName}/replicationProtectionContainers/{protectionContainerName}/switchprotection": { + "post": { + "tags": [ + "ReplicationProtectionContainers" + ], + "summary": "Switches protection from one container to another or one replication provider to another.", + "description": "Operation to switch protection from one container to another or one replication provider to another.", + "operationId": "ReplicationProtectionContainers_SwitchProtection", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Unique fabric name.", + "required": true, + "type": "string" + }, + { + "name": "protectionContainerName", + "in": "path", + "description": "Protection container name.", + "required": true, + "type": "string" + }, + { + "name": "switchInput", + "in": "body", + "description": "Switch protection input.", + "required": true, + "schema": { + "$ref": "#/definitions/SwitchProtectionInput" } } ], @@ -3574,6 +4269,74 @@ } } }, + "put": { + "tags": [ + "ReplicationRecoveryServicesProviders" + ], + "summary": "Adds a recovery services provider.", + "description": "The operation to add a recovery services provider.", + "operationId": "ReplicationRecoveryServicesProviders_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "fabricName", + "in": "path", + "description": "Fabric name.", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Recovery services provider name.", + "required": true, + "type": "string" + }, + { + "name": "addProviderInput", + "in": "body", + "description": "Add provider input.", + "required": true, + "schema": { + "$ref": "#/definitions/AddRecoveryServicesProviderInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryServicesProvider" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Adds a recovery services provider.": { + "$ref": "./examples/ReplicationRecoveryServicesProviders_Create.json" + } + } + }, "delete": { "tags": [ "ReplicationRecoveryServicesProviders" @@ -4710,6 +5473,63 @@ } } }, + "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationMigrationItems": { + "get": { + "tags": [ + "ReplicationMigrationItems" + ], + "summary": "Gets the list of migration items in the vault.", + "operationId": "ReplicationMigrationItems_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ResourceName" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "skipToken", + "in": "query", + "description": "The pagination token.", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MigrationItemCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/MigrationItemsQueryParameter", + "x-ms-examples": { + "Gets the list of migration items in the vault.": { + "$ref": "./examples/ReplicationMigrationItems_List.json" + } + } + } + }, "/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{resourceName}/replicationNetworkMappings": { "get": { "tags": [ @@ -6924,6 +7744,42 @@ } } }, + "AddRecoveryServicesProviderInput": { + "description": "Input required to add a provider.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AddRecoveryServicesProviderInputProperties", + "description": "The properties of an add provider request." + } + } + }, + "AddRecoveryServicesProviderInputProperties": { + "description": "The properties of an add provider request.", + "required": [ + "machineName", + "authenticationIdentityInput", + "resourceAccessIdentityInput" + ], + "type": "object", + "properties": { + "machineName": { + "description": "The name of the machine where the provider is getting added.", + "type": "string" + }, + "authenticationIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for DRA authentication." + }, + "resourceAccessIdentityInput": { + "$ref": "#/definitions/IdentityProviderInput", + "description": "The identity provider input for resource access." + } + } + }, "AddVCenterRequest": { "description": "Input required to add vCenter.", "type": "object", @@ -7548,6 +8404,25 @@ } } }, + "CurrentJobDetails": { + "description": "Current job details of the migraton item.", + "type": "object", + "properties": { + "jobName": { + "description": "The job name.", + "type": "string" + }, + "jobId": { + "description": "The ARM Id of the job being executed.", + "type": "string" + }, + "startTime": { + "format": "date-time", + "description": "The start time of the job.", + "type": "string" + } + } + }, "CurrentScenarioDetails": { "description": "Current scenario details of the protected entity.", "type": "object", @@ -7706,11 +8581,11 @@ "type": "object", "properties": { "secretIdentifier": { - "description": "The secret url / identifier.", + "description": "The secret url / identifier.", "type": "string" }, "keyVaultResourceArmId": { - "description": "The KeyVault resource ARM id for secret.", + "description": "The KeyVault resource ARM id for secret.", "type": "string" } } @@ -7751,6 +8626,51 @@ } } }, + "EnableMigrationInput": { + "description": "Enable migration input.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/EnableMigrationInputProperties", + "description": "Enable migration input properties." + } + } + }, + "EnableMigrationInputProperties": { + "description": "Enable migration input properties.", + "required": [ + "policyId", + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "policyId": { + "description": "The policy Id.", + "type": "string" + }, + "providerSpecificDetails": { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "EnableMigrationProviderSpecificInput": { + "description": "Enable migration provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, "EnableProtectionInput": { "description": "Enable protection input.", "type": "object", @@ -9395,24 +10315,46 @@ "modelAsString": true } } - }, - "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "x-ms-discriminator-value": "HyperVVirtualMachine" + }, + "IdentityProviderDetails": { + "description": "Identity provider details.", + "type": "object", + "properties": { + "tenantId": { + "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "applicationId": { + "description": "The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "objectId": { + "description": "The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "audience": { + "description": "The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services.", + "type": "string" + }, + "aadAuthority": { + "description": "The base authority for Azure Active Directory authentication.", + "type": "string" + } + } }, - "IdentityInformation": { - "description": "Identity details.", + "IdentityProviderInput": { + "description": "Identity provider input.", + "required": [ + "tenantId", + "applicationId", + "objectId", + "audience", + "aadAuthority" + ], "type": "object", "properties": { - "identityProviderType": { - "description": "The identity provider type. Value is the ToString() of a IdentityProviderType value.", - "enum": [ - "RecoveryServicesActiveDirectory" - ], - "type": "string", - "x-ms-enum": { - "name": "IdentityProviderType", - "modelAsString": true - } - }, "tenantId": { "description": "The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services.", "type": "string" @@ -9432,10 +10374,6 @@ "aadAuthority": { "description": "The base authority for Azure Active Directory authentication.", "type": "string" - }, - "certificateThumbprint": { - "description": "The certificate thumbprint. Applicable only if IdentityProviderType is RecoveryServicesActiveDirectory.", - "type": "string" } } }, @@ -11065,11 +12003,11 @@ }, "affectedObjectTypes": { "description": "The type of objects.", - "type": "string" + "type": "string" }, "jobStatus": { "description": "The states of the job to be filtered can be in.", - "type": "string" + "type": "string" } } }, @@ -11122,11 +12060,11 @@ "type": "object", "properties": { "keyIdentifier": { - "description": "The key url / identifier.", + "description": "The key url / identifier.", "type": "string" }, "keyVaultResourceArmId": { - "description": "The KeyVault resource ARM id for key.", + "description": "The KeyVault resource ARM id for key.", "type": "string" } } @@ -11303,6 +12241,276 @@ } } }, + "MigrateInput": { + "description": "Input for migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MigrateInputProperties", + "description": "Migrate input properties." + } + } + }, + "MigrateInputProperties": { + "description": "Migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/MigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "MigrateProviderSpecificInput": { + "description": "Migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, + "MigrationItem": { + "description": "Migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationItemProperties", + "description": "The migration item properties." + } + } + }, + "MigrationItemCollection": { + "description": "Migration item collection.", + "type": "object", + "properties": { + "value": { + "description": "The list of migration items.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationItem" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationItemProperties": { + "description": "Migration item properties.", + "type": "object", + "properties": { + "machineName": { + "description": "The on-premise virtual machine name.", + "type": "string", + "readOnly": true + }, + "policyId": { + "description": "The ARM Id of policy governing this item.", + "type": "string", + "readOnly": true + }, + "policyFriendlyName": { + "description": "The name of policy governing this item.", + "type": "string", + "readOnly": true + }, + "recoveryServicesProviderId": { + "description": "The recovery services provider ARM Id.", + "type": "string", + "readOnly": true + }, + "migrationState": { + "description": "The migration status.", + "enum": [ + "None", + "EnableMigrationInProgress", + "EnableMigrationFailed", + "DisableMigrationInProgress", + "DisableMigrationFailed", + "InitialSeedingInProgress", + "InitialSeedingFailed", + "Replicating", + "MigrationInProgress", + "MigrationSucceeded", + "MigrationFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationState", + "modelAsString": true + } + }, + "migrationStateDescription": { + "description": "The migration state description.", + "type": "string", + "readOnly": true + }, + "testMigrateState": { + "description": "The test migrate state.", + "enum": [ + "None", + "TestMigrationInProgress", + "TestMigrationSucceeded", + "TestMigrationFailed", + "TestMigrationCleanupInProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TestMigrationState", + "modelAsString": true + } + }, + "testMigrateStateDescription": { + "description": "The test migrate state description.", + "type": "string", + "readOnly": true + }, + "health": { + "description": "The consolidated health.", + "type": "string", + "readOnly": true + }, + "healthErrors": { + "description": "The list of health errors.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthError" + }, + "readOnly": true + }, + "allowedOperations": { + "description": "The allowed operations on the migration item, based on the current migration state of the item.", + "type": "array", + "items": { + "enum": [ + "DisableMigration", + "TestMigrate", + "TestMigrateCleanup", + "Migrate" + ], + "type": "string", + "x-ms-enum": { + "name": "MigrationItemOperation", + "modelAsString": true + } + }, + "readOnly": true + }, + "currentJob": { + "$ref": "#/definitions/CurrentJobDetails", + "description": "The current job details.", + "readOnly": true + }, + "providerSpecificDetails": { + "$ref": "#/definitions/MigrationProviderSpecificSettings", + "description": "The migration provider custom settings." + } + } + }, + "MigrationItemsQueryParameter": { + "description": "Query parameter to enumerate migration items.", + "type": "object", + "properties": { + "sourceFabricName": { + "description": "The source fabric name filter.", + "type": "string" + }, + "instanceType": { + "description": "The replication provider type.", + "type": "string" + } + } + }, + "MigrationProviderSpecificSettings": { + "description": "Migration provider specific settings.", + "type": "object", + "properties": { + "instanceType": { + "description": "Gets the instance type.", + "type": "string", + "readOnly": true + } + }, + "discriminator": "instanceType" + }, + "MigrationRecoveryPoint": { + "description": "Recovery point for a migration item.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MigrationRecoveryPointProperties", + "description": "Recovery point properties." + } + } + }, + "MigrationRecoveryPointCollection": { + "description": "Collection of migration recovery points.", + "type": "object", + "properties": { + "value": { + "description": "The migration recovery point details.", + "type": "array", + "items": { + "$ref": "#/definitions/MigrationRecoveryPoint" + } + }, + "nextLink": { + "description": "The value of next link.", + "type": "string" + } + } + }, + "MigrationRecoveryPointProperties": { + "description": "Migration item recovery point properties.", + "type": "object", + "properties": { + "recoveryPointTime": { + "format": "date-time", + "description": "The recovery point time.", + "type": "string", + "readOnly": true + }, + "recoveryPointType": { + "description": "The recovery point type.", + "enum": [ + "NotSpecified", + "ApplicationConsistent", + "CrashConsistent" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MigrationRecoveryPointType", + "modelAsString": true + } + } + } + }, "MobilityServiceUpdate": { "description": "The Mobility Service update details.", "type": "object", @@ -13068,9 +14276,13 @@ "description": "The DRA Id.", "type": "string" }, - "identityDetails": { - "$ref": "#/definitions/IdentityInformation", - "description": "The identity details." + "authenticationIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The authentication identity details." + }, + "resourceAccessIdentityDetails": { + "$ref": "#/definitions/IdentityProviderDetails", + "description": "The resource access identity details." }, "providerVersionDetails": { "$ref": "#/definitions/VersionDetails", @@ -13934,7 +15146,70 @@ } } }, - "x-ms-discriminator-value": "TestFailoverJobDetails" + "x-ms-discriminator-value": "TestFailoverJobDetails" + }, + "TestMigrateCleanupInput": { + "description": "Input for test migrate cleanup.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateCleanupInputProperties", + "description": "Test migrate cleanup input properties." + } + } + }, + "TestMigrateCleanupInputProperties": { + "description": "Test migrate cleanup input properties.", + "type": "object", + "properties": { + "comments": { + "description": "Test migrate cleanup comments.", + "type": "string" + } + } + }, + "TestMigrateInput": { + "description": "Input for test migrate.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TestMigrateInputProperties", + "description": "Test migrate input properties." + } + } + }, + "TestMigrateInputProperties": { + "description": "Test migrate input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/TestMigrateProviderSpecificInput", + "description": "The provider specific details." + } + } + }, + "TestMigrateProviderSpecificInput": { + "description": "Test migrate provider specific input.", + "required": [ + "instanceType" + ], + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" }, "UnplannedFailoverInput": { "description": "Input definition for planned failover.", @@ -13964,6 +15239,40 @@ } } }, + "UpdateMigrationItemInput": { + "description": "Update migration item input.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UpdateMigrationItemInputProperties", + "description": "Update migration item input properties." + } + } + }, + "UpdateMigrationItemInputProperties": { + "description": "Update migration item input properties.", + "required": [ + "providerSpecificDetails" + ], + "type": "object", + "properties": { + "providerSpecificDetails": { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput", + "description": "The provider specific input to update migration item." + } + } + }, + "UpdateMigrationItemProviderSpecificInput": { + "description": "Update migration item provider specific input.", + "type": "object", + "properties": { + "instanceType": { + "description": "The class type.", + "type": "string" + } + }, + "discriminator": "instanceType" + }, "UpdateMobilityServiceRequest": { "description": "Request to update the mobility service on a protected item.", "type": "object", @@ -14537,92 +15846,471 @@ "description": "VM network name.", "type": "string" }, - "recoveryVMNetworkId": { - "description": "Recovery VM network Id.", + "recoveryVMNetworkId": { + "description": "Recovery VM network Id.", + "type": "string" + }, + "recoveryVMSubnetName": { + "description": "Recovery VM subnet name.", + "type": "string" + }, + "ipAddressType": { + "description": "Ip address type.", + "type": "string" + }, + "primaryNicStaticIPAddress": { + "description": "Primary nic static IP address.", + "type": "string" + }, + "replicaNicStaticIPAddress": { + "description": "Replica nic static IP address.", + "type": "string" + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "recoveryNicIpAddressType": { + "description": "IP allocation type for recovery VM.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "A value indicating whether the NIC has accerated networking enabled.", + "type": "boolean" + } + } + }, + "VMNicInputDetails": { + "description": "Hyper V VM network input details.", + "type": "object", + "properties": { + "nicId": { + "description": "The nic Id.", + "type": "string" + }, + "recoveryVMSubnetName": { + "description": "Recovery VM subnet name.", + "type": "string" + }, + "replicaNicStaticIPAddress": { + "description": "Replica nic static IP address.", + "type": "string" + }, + "selectionType": { + "description": "Selection type for failover.", + "type": "string" + }, + "enableAcceleratedNetworkingOnRecovery": { + "description": "Whether the NIC has accerated networking enabled.", + "type": "boolean" + } + } + }, + "VmNicUpdatesTaskDetails": { + "description": "This class represents the vm NicUpdates task details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TaskTypeDetails" + } + ], + "properties": { + "vmId": { + "description": "Virtual machine Id.", + "type": "string" + }, + "nicId": { + "description": "Nic Id.", + "type": "string" + }, + "name": { + "description": "Name of the Nic.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + }, + "VMwareCbtContainerCreationInput": { + "description": "VMwareCbt container creation input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerCreationInput" + } + ], + "properties": {}, + "x-ms-discriminator-value": "6c7da455-506f-43ff-a16a-8eb101aebb70" + }, + "VMwareCbtContainerMappingInput": { + "description": "VMwareCbt container mapping input.", + "required": [ + "keyVaultId", + "keyVaultUri", + "storageAccountId", + "storageAccountSasSecretName", + "serviceBusConnectionStringSecretName", + "targetLocation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReplicationProviderSpecificContainerMappingInput" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string" + }, + "keyVaultUri": { + "description": "The target key vault URL.", + "type": "string" + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string" + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string" + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string" + }, + "targetLocation": { + "description": "The target location.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtDiskInput": { + "description": "VMwareCbt disk input.", + "required": [ + "diskId", + "isOSDisk", + "logStorageAccountId", + "logStorageAccountSasSecretName" + ], + "type": "object", + "properties": { + "diskId": { + "description": "The disk Id.", + "type": "string" + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string" + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string" + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string" + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskAccountType", + "modelAsString": true + } + } + } + }, + "VMwareCbtEnableMigrationInput": { + "description": "VMwareCbt specific enable migration input.", + "required": [ + "vmwareMachineId", + "disksToInclude", + "dataMoverRunAsAccountId", + "snapshotRunAsAccountId", + "targetResourceGroupId", + "targetNetworkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EnableMigrationProviderSpecificInput" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string" + }, + "disksToInclude": { + "description": "The disks to include list.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtDiskInput" + } + }, + "licenseType": { + "description": "License type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "dataMoverRunAsAccountId": { + "description": "The data mover runas account Id.", + "type": "string" + }, + "snapshotRunAsAccountId": { + "description": "The snapshot runas account Id.", + "type": "string" + }, + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "targetSubnetName": { + "description": "The target subnet name.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrateInput": { + "description": "VMwareCbt specific migrate input.", + "required": [ + "performShutdown", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrateProviderSpecificInput" + } + ], + "properties": { + "performShutdown": { + "description": "A value indicating whether VM is to be shutdown.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtMigrationDetails": { + "description": "VMwareCbt provider specific settings", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/MigrationProviderSpecificSettings" + } + ], + "properties": { + "vmwareMachineId": { + "description": "The ARM Id of the VM discovered in VMware.", + "type": "string", + "readOnly": true + }, + "osType": { + "description": "The type of the OS on the VM.", + "type": "string", + "readOnly": true + }, + "licenseType": { + "description": "License Type of the VM to be used.", + "type": "string" + }, + "dataMoverRunAsAccountId": { + "description": "The data mover runas account Id.", + "type": "string", + "readOnly": true + }, + "snapshotRunAsAccountId": { + "description": "The snapshot runas account Id.", + "type": "string", + "readOnly": true + }, + "targetVmName": { + "description": "Target VM name.", "type": "string" }, - "recoveryVMSubnetName": { - "description": "Recovery VM subnet name.", + "targetVmSize": { + "description": "The target VM size.", "type": "string" }, - "ipAddressType": { - "description": "Ip address type.", - "type": "string" + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true }, - "primaryNicStaticIPAddress": { - "description": "Primary nic static IP address.", + "targetResourceGroupId": { + "description": "The target resource group Id.", "type": "string" }, - "replicaNicStaticIPAddress": { - "description": "Replica nic static IP address.", + "targetAvailabilitySetId": { + "description": "The target availability set Id.", "type": "string" }, - "selectionType": { - "description": "Selection type for failover.", + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", "type": "string" }, - "recoveryNicIpAddressType": { - "description": "IP allocation type for recovery VM.", + "protectedDisks": { + "description": "The list of protected disks.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtProtectedDiskDetails" + } + }, + "targetNetworkId": { + "description": "The target network Id.", "type": "string" }, - "enableAcceleratedNetworkingOnRecovery": { - "description": "A value indicating whether the NIC has accerated networking enabled.", - "type": "boolean" + "vmNics": { + "description": "The network details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicDetails" + } + }, + "migrationRecoveryPointId": { + "description": "The recovery point Id to which the VM was migrated.", + "type": "string", + "readOnly": true + }, + "lastRecoveryPointReceived": { + "format": "date-time", + "description": "The last recovery point received time.", + "type": "string", + "readOnly": true } - } + }, + "x-ms-discriminator-value": "VMwareCbt" }, - "VMNicInputDetails": { - "description": "Hyper V VM network input details.", + "VMwareCbtNicDetails": { + "description": "VMwareCbt NIC details.", "type": "object", "properties": { "nicId": { - "description": "The nic Id.", - "type": "string" + "description": "The NIC Id.", + "type": "string", + "readOnly": true }, - "recoveryVMSubnetName": { - "description": "Recovery VM subnet name.", + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", "type": "string" }, - "replicaNicStaticIPAddress": { - "description": "Replica nic static IP address.", + "sourceIPAddress": { + "description": "The source IP address.", + "type": "string", + "readOnly": true + }, + "sourceIPAddressType": { + "description": "The source IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "sourceNetworkId": { + "description": "Source network Id.", + "type": "string", + "readOnly": true + }, + "targetIPAddress": { + "description": "The target IP address.", "type": "string" }, - "selectionType": { - "description": "Selection type for failover.", + "targetIPAddressType": { + "description": "The target IP address type.", + "enum": [ + "Dynamic", + "Static" + ], + "type": "string", + "x-ms-enum": { + "name": "EthernetAddressType", + "modelAsString": true + } + }, + "targetSubnetName": { + "description": "Target subnet name.", "type": "string" }, - "enableAcceleratedNetworkingOnRecovery": { - "description": "Whether the NIC has accerated networking enabled.", - "type": "boolean" + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", + "type": "string" } } }, - "VmNicUpdatesTaskDetails": { - "description": "This class represents the vm NicUpdates task details.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TaskTypeDetails" - } + "VMwareCbtNicInput": { + "description": "VMwareCbt NIC input.", + "required": [ + "nicId", + "isPrimaryNic" ], + "type": "object", "properties": { - "vmId": { - "description": "Virtual machine Id.", + "nicId": { + "description": "The NIC Id.", "type": "string" }, - "nicId": { - "description": "Nic Id.", + "isPrimaryNic": { + "description": "A value indicating whether this is the primary NIC.", "type": "string" }, - "name": { - "description": "Name of the Nic.", + "targetSubnetName": { + "description": "Target subnet name.", + "type": "string" + }, + "targetStaticIPAddress": { + "description": "The static IP address.", + "type": "string" + }, + "isSelectedForMigration": { + "description": "A value indicating whether this NIC is selected for migration.", "type": "string" } - }, - "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" + } }, "VMwareCbtPolicyCreationInput": { - "description": "VMware Cbt Policy creation input.", + "description": "VMware Cbt policy creation input.", "type": "object", "allOf": [ { @@ -14630,7 +16318,7 @@ } ], "properties": { - "recoveryPointHistory": { + "recoveryPointHistoryInMinutes": { "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored.", "type": "integer" @@ -14657,12 +16345,7 @@ } ], "properties": { - "recoveryPointThresholdInMinutes": { - "format": "int32", - "description": "The recovery point threshold in minutes.", - "type": "integer" - }, - "recoveryPointHistory": { + "recoveryPointHistoryInMinutes": { "format": "int32", "description": "The duration in minutes until which the recovery points need to be stored.", "type": "integer" @@ -14680,6 +16363,194 @@ }, "x-ms-discriminator-value": "VMwareCbt" }, + "VMwareCbtProtectedDiskDetails": { + "description": "VMwareCbt protected disk details.", + "type": "object", + "properties": { + "diskId": { + "description": "The disk id.", + "type": "string", + "readOnly": true + }, + "diskName": { + "description": "The disk name.", + "type": "string", + "readOnly": true + }, + "diskPath": { + "description": "The disk path.", + "type": "string", + "readOnly": true + }, + "isOSDisk": { + "description": "A value indicating whether the disk is the OS disk.", + "type": "string", + "readOnly": true + }, + "capacityInBytes": { + "format": "int64", + "description": "The disk capacity in bytes.", + "type": "integer", + "readOnly": true + }, + "logStorageAccountId": { + "description": "The log storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "logStorageAccountSasSecretName": { + "description": "The key vault secret name of the log storage account.", + "type": "string", + "readOnly": true + }, + "seedManagedDiskId": { + "description": "The ARM Id of the seed managed disk.", + "type": "string", + "readOnly": true + }, + "targetManagedDiskId": { + "description": "The ARM Id of the target managed disk.", + "type": "string", + "readOnly": true + }, + "diskType": { + "description": "The disk type.", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS" + ], + "type": "string", + "x-ms-enum": { + "name": "DiskType", + "modelAsString": true + } + } + } + }, + "VMwareCbtProtectionContainerMappingDetails": { + "description": "VMwareCbt provider specific container mapping details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProtectionContainerMappingProviderSpecificDetails" + } + ], + "properties": { + "keyVaultId": { + "description": "The target key vault ARM Id.", + "type": "string", + "readOnly": true + }, + "keyVaultUri": { + "description": "The target key vault URI.", + "type": "string", + "readOnly": true + }, + "storageAccountId": { + "description": "The storage account ARM Id.", + "type": "string", + "readOnly": true + }, + "storageAccountSasSecretName": { + "description": "The secret name of the storage account.", + "type": "string", + "readOnly": true + }, + "serviceBusConnectionStringSecretName": { + "description": "The secret name of the service bus connection string.", + "type": "string", + "readOnly": true + }, + "targetLocation": { + "description": "The target location.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtTestMigrateInput": { + "description": "VMwareCbt specific test migrate input.", + "required": [ + "recoveryPointId", + "networkId", + "instanceType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TestMigrateProviderSpecificInput" + } + ], + "properties": { + "recoveryPointId": { + "description": "The recovery point Id.", + "type": "string" + }, + "networkId": { + "description": "The test network Id.", + "type": "string" + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, + "VMwareCbtUpdateMigrationItemInput": { + "description": "VMwareCbt specific update migration item input.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/UpdateMigrationItemProviderSpecificInput" + } + ], + "properties": { + "targetVmName": { + "description": "The target VM name.", + "type": "string" + }, + "targetVmSize": { + "description": "The target VM size.", + "type": "string" + }, + "targetResourceGroupId": { + "description": "The target resource group ARM Id.", + "type": "string" + }, + "targetAvailabilitySetId": { + "description": "The target availability set ARM Id.", + "type": "string" + }, + "targetBootDiagnosticsStorageAccountId": { + "description": "The target boot diagnostics storage account ARM Id.", + "type": "string" + }, + "targetNetworkId": { + "description": "The target network ARM Id.", + "type": "string" + }, + "vmNics": { + "description": "The list of NIC details.", + "type": "array", + "items": { + "$ref": "#/definitions/VMwareCbtNicInput" + } + }, + "licenseType": { + "description": "The license type.", + "enum": [ + "NotSpecified", + "NoLicenseType", + "WindowsServer" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + } + }, + "x-ms-discriminator-value": "VMwareCbt" + }, "VMwareDetails": { "description": "Store the fabric details specific to the VMware fabric.", "type": "object", @@ -14838,7 +16709,11 @@ "x-ms-discriminator-value": "VMware" }, "VMwareV2FabricCreationInput": { - "description": "Fabric provider specific settings.", + "description": "VMwareV2 fabric provider specific settings.", + "required": [ + "vmwareSiteId", + "migrationSolutionId" + ], "type": "object", "allOf": [ { @@ -14846,19 +16721,19 @@ } ], "properties": { - "keyVaultUrl": { - "description": "The Key Vault URL.", + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", "type": "string" }, - "keyVaultResourceArmId": { - "description": "The Key Vault ARM Id.", + "migrationSolutionId": { + "description": "The ARM Id of the migration solution.", "type": "string" } }, "x-ms-discriminator-value": "VMwareV2" }, "VMwareV2FabricSpecificDetails": { - "description": "VMwareV2 fabric Specific Details.", + "description": "VMwareV2 fabric specific details.", "type": "object", "allOf": [ { @@ -14866,21 +16741,20 @@ } ], "properties": { - "srsServiceEndpoint": { - "description": "The endpoint for making requests to the SRS Service.", - "type": "string" - }, - "rcmServiceEndpoint": { - "description": "The endpoint for making requests to the RCM Service.", - "type": "string" + "vmwareSiteId": { + "description": "The ARM Id of the VMware site.", + "type": "string", + "readOnly": true }, - "keyVaultUrl": { - "description": "The Key Vault URL.", - "type": "string" + "migrationSolutionId": { + "description": "The Migration solution ARM Id.", + "type": "string", + "readOnly": true }, - "keyVaultResourceArmId": { - "description": "The Key Vault ARM Id.", - "type": "string" + "serviceEndpoint": { + "description": "The service endpoint.", + "type": "string", + "readOnly": true } }, "x-ms-discriminator-value": "VMwareV2" @@ -14923,7 +16797,7 @@ "type": "string" }, "discoveryType": { - "description": "A value inidicating the discovery type of the machine. Value can be vCenter or physical.", + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", "type": "string" }, "diskDetails": { @@ -14994,4 +16868,4 @@ ] } ] -} +} \ No newline at end of file From 0e6e86f48ea0e7f09b9045d842a38c6fc116bb43 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Tue, 4 Dec 2018 01:43:14 +0800 Subject: [PATCH 261/464] [HDInsight] - Initial commit for Swagger-based Job SDK (#4489) --- .../examples/HDI_Job_Get.json | 76 ++ .../examples/HDI_Job_GetAppState.json | 13 + .../examples/HDI_Job_Kill.json | 84 ++ .../examples/HDI_Job_List.json | 82 ++ .../examples/HDI_Job_ListAfterJobId.json | 212 ++++ .../examples/HDI_Job_SubmitHiveJob.json | 14 + .../examples/HDI_Job_SubmitMapReduceJob.json | 14 + .../HDI_Job_SubmitMapReduceStreamingJob.json | 14 + .../examples/HDI_Job_SubmitPigJob.json | 14 + .../examples/HDI_Job_SubmitSqoopJob.json | 14 + .../preview/2018-11-01-preview/job.json | 929 ++++++++++++++++++ .../hdinsight/data-plane/readme.go.md | 26 + specification/hdinsight/data-plane/readme.md | 134 +++ .../hdinsight/resource-manager/readme.md | 2 +- 14 files changed, 1627 insertions(+), 1 deletion(-) create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json create mode 100644 specification/hdinsight/data-plane/readme.go.md create mode 100644 specification/hdinsight/data-plane/readme.md diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json new file mode 100644 index 000000000000..384ae6859aa0 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0024", + "fields": "*" + }, + "responses": { + "200": { + "status": { + "mapProgress": 1.0, + "reduceProgress": 1.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 2, + "startTime": 1542088206436, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", + "finishTime": 1542088277769, + "historyFile": "", + "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0024", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 24, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0024", + "username": "testuser11750", + "state": "SUCCEEDED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0024_conf.xml", + "url": null, + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 24, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0024" + }, + "id": "job_1542085634998_0024", + "parentId": null, + "percentComplete": null, + "exitValue": 0, + "user": "testuser11750", + "callback": null, + "completed": "done", + "userargs": { + "statusdir": "2018-11-13T05-49-52-4418fce1-e92e-4732-bc12-f2a3b8ef4432", + "file": null, + "enablejobreconnect": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json new file mode 100644 index 000000000000..1cbee0d0b8e0 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "appId": "application_1462754318084_0071", + "clusterDnsName": "cluster.azurehdinsight.net" + }, + "responses": { + "200": { + "body": { + "state": "ACCEPTED" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json new file mode 100644 index 000000000000..a29a26f4a0c0 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0007" + }, + "responses": { + "200": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 5, + "startTime": 1542087304445, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", + "finishTime": 1542087305443, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 7, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0007", + "username": "testuser11750", + "state": "KILLED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0007/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/cluster/app/application_1542085634998_0007", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 7, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0007" + }, + "id": "job_1542085634998_0007", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": { + "statusdir": "2018-11-13T05-35-01-6f79af0f-6157-494a-a03e-eabb190a0c10", + "enablejobreconnect": null, + "arg": [ + "10", + "1000" + ], + "define": [ + "mapreduce.map.maxattempts=10", + "mapreduce.reduce.maxattempts=10", + "mapreduce.task.timeout=60000" + ], + "enablelog": "false", + "libjars": null, + "files": null, + "callback": null, + "jar": "/example/jars/hadoop-mapreduce-examples.jar", + "class": "pi" + }, + "msg": null + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json new file mode 100644 index 000000000000..cd36507adc1a --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "fields": "*", + "showall": "true" + }, + "responses": { + "200": { + "body": [ + { + "id": "job_1542085634998_0027", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 4, + "startTime": 1542088296429, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027", + "username": "testuser11750", + "state": "PREP", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027" + }, + "id": "job_1542085634998_0027", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json new file mode 100644 index 000000000000..c4fb3acecd14 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json @@ -0,0 +1,212 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "jobId": "job_1542085634998_0029", + "numrecords": 3, + "fields": "*", + "showall": "true" + }, + "responses": { + "200": { + "body": [ + { + "id": "job_1542085634998_0028", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 1.0, + "runState": 1, + "startTime": 1542088315731, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 28, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0028", + "username": "yarn", + "state": "RUNNING", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "yarn", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0028/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0028/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 28, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0028" + }, + "id": "job_1542085634998_0028", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "yarn", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + }, + { + "id": "job_1542085634998_0027", + "detail": { + "status": { + "mapProgress": 0.0, + "reduceProgress": 0.0, + "cleanupProgress": 0.0, + "setupProgress": 1.0, + "runState": 1, + "startTime": 1542088307280, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "TempletonControllerJob", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "finishTime": 0, + "historyFile": "", + "trackingUrl": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027", + "username": "yarn", + "state": "RUNNING", + "retired": false, + "jobComplete": false, + "uber": false + }, + "profile": { + "user": "yarn", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mapreducestaging/testuser11750/.staging/job_1542085634998_0027/job.xml", + "url": "http://hn0-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:8088/proxy/application_1542085634998_0027/", + "queueName": "default", + "jobName": "TempletonControllerJob", + "jobID": { + "id": 27, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0027" + }, + "id": "job_1542085634998_0027", + "parentId": null, + "percentComplete": null, + "exitValue": null, + "user": "yarn", + "callback": null, + "completed": null, + "userargs": { + "statusdir": null, + "file": null, + "define": [], + "enablelog": "false", + "files": null, + "callback": null, + "execute": "select querydwelltime+2 from hivesampletable where clientid = 8" + }, + "msg": null + } + }, + { + "id": "job_1542085634998_0025", + "detail": { + "status": { + "mapProgress": 1.0, + "reduceProgress": 1.0, + "cleanupProgress": 0.0, + "setupProgress": 0.0, + "runState": 2, + "startTime": 1542088225363, + "queue": "default", + "priority": "NORMAL", + "schedulingInfo": "NA", + "failureInfo": "NA", + "jobACLs": {}, + "jobName": "QuasiMonteCarlo", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", + "finishTime": 1542088250019, + "historyFile": "", + "trackingUrl": "hn1-testcl.422g4qa5a0lehgxxtnagxxuu2h.ex.internal.cloudapp.net:19888/jobhistory/job/job_1542085634998_0025", + "numUsedSlots": 0, + "numReservedSlots": 0, + "usedMem": 0, + "reservedMem": 0, + "neededMem": 0, + "jobPriority": "NORMAL", + "jobID": { + "id": 25, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0025", + "username": "testuser11750", + "state": "SUCCEEDED", + "retired": false, + "jobComplete": true, + "uber": false + }, + "profile": { + "user": "testuser11750", + "jobFile": "wasb://testcontainer11549@testazureblob1114.blob.core.windows.net/mr-history/done/2018/11/13/000000/job_1542085634998_0025_conf.xml", + "url": null, + "queueName": "default", + "jobName": "QuasiMonteCarlo", + "jobID": { + "id": 25, + "jtIdentifier": "1542085634998" + }, + "jobId": "job_1542085634998_0025" + }, + "id": "job_1542085634998_0025", + "parentId": "job_1542085634998_0023", + "percentComplete": null, + "exitValue": null, + "user": "testuser11750", + "callback": null, + "completed": null, + "userargs": {}, + "msg": null + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json new file mode 100644 index 000000000000..d0d4c46469b0 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "execute=select%20querydwelltime%2B2%20from%20hivesampletable%20where%20clientid%20%3D%208&statusdir=2018-10-30T10-13-36-30513317-c398-4da0-a98c-57db43750f3a" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json new file mode 100644 index 000000000000..7978851f76d8 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "jar=%2Fexample%2Fjars%2Fhadoop-mapreduce-examples.jar&class=pi&arg=10&arg=1000&define=mapreduce.map.maxattempts%3D10&define=mapreduce.reduce.maxattempts%3D10&define=mapreduce.task.timeout%3D60000&statusdir=2018-10-30T10-12-29-595ef52d-583c-4b17-987b-675e4f8eea8f" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json new file mode 100644 index 000000000000..76519fb78b0e --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "input=%2Fexample%2Fdata%2Fgutenberg%2Fdavinci.txt&output=%2Fexample%2Fdata%2Fgutenberg%2Fwcount%2F3745c39c-0115-4735-a9eb-c57de9a29dcd&mapper=cat&reducer=wc&statusdir=2018-10-30T11-40-44-eb9dc5c1-99dd-4282-9d4a-a77c8ffb6b35" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json new file mode 100644 index 000000000000..9437bf0b8047 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "execute=LOGS%20%3D%20LOAD%20%27wasb%3A%2F%2F%2Fexample%2Fdata%2Fsample.log%27%3BLEVELS%20%3D%20foreach%20LOGS%20generate%20REGEX_EXTRACT%28%240%2C%20%27%28TRACE%7CDEBUG%7CINFO%7CWARN%7CERROR%7CFATAL%29%27%2C%201%29%20%20as%20LOGLEVEL%3BFILTEREDLEVELS%20%3D%20FILTER%20LEVELS%20by%20LOGLEVEL%20is%20not%20null%3BGROUPEDLEVELS%20%3D%20GROUP%20FILTEREDLEVELS%20by%20LOGLEVEL%3BFREQUENCIES%20%3D%20foreach%20GROUPEDLEVELS%20generate%20group%20as%20LOGLEVEL%2C%20COUNT%28FILTEREDLEVELS.LOGLEVEL%29%20as%20COUNT%3BRESULT%20%3D%20order%20FREQUENCIES%20by%20COUNT%20desc%3BDUMP%20RESULT%3B&statusdir=2018-10-30T12-44-24-bd642975-9a89-4480-aea7-3ee1f34016ec" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json new file mode 100644 index 000000000000..abb6cb1fea23 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "user.name": "admin", + "clusterDnsName": "cluster.azurehdinsight.net", + "content": "command=import%20--connect%20jdbc%3Asqlserver%3A%2F%2Fdongwwahdi.database.windows.net%3A1433%3Bdatabase%3DHdInsightJobTest%3Buser%3Ddongwwaadmin%3Bpassword%3DHDInsight123%21%3B%20--table%20dept%20--warehouse-dir%20%2Fuser%2Fadmin%2Fsqoop%2F25c8b9f9-dbc1-4096-aa42-45f2868ab782%20--hive-import%20-m%201%20--hive-table%20deptd3175062928d4170831ac17d2eefdaeb&statusdir=SqoopStatus" + }, + "responses": { + "200": { + "body": { + "id": "job_1540456943299_0046" + } + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json new file mode 100644 index 000000000000..629dddce0765 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json @@ -0,0 +1,929 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightJobManagementClient", + "description": "The HDInsight Job Client.", + "version": "2018-11-01-preview", + "x-ms-code-generation-settings": { + "internalConstructors": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{clusterDnsName}", + "parameters": [ + { + "$ref": "#/parameters/clusterDnsNameParameter" + } + ] + }, + "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": { + "/templeton/v1/jobs/{jobId}": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_Get", + "description": "Gets job details from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets job details from the specified HDInsight cluster": { + "$ref": "./examples/HDI_Job_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the job." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobDetailRootJsonObject" + } + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "operationId": "Job_Kill", + "description": "Initiates cancel on given running job in the specified HDInsight.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Initiates cancel on given running job in the specified HDInsight.": { + "$ref": "./examples/HDI_Job_Kill.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The id of the job." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobDetailRootJsonObject" + } + } + } + } + }, + "/templeton/v1/jobs": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_List", + "description": "Gets the list of jobs from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets the list of jobs from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "showall", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobListJsonObject" + } + } + } + } + } + }, + "/templeton/v1/jobs?op=LISTAFTERID": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_ListAfterJobId", + "description": "Gets numrecords Of Jobs after jobid from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets numOfJobs after jobId from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_ListAfterJobId.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "jobid", + "in": "query", + "required": false, + "type": "string", + "description": "JobId from where to list jobs." + }, + { + "name": "numrecords", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Number of jobs to fetch." + }, + { + "name": "showall", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "true" + ], + "description": "If showall is set to 'true', the request will return all jobs the user has permission to view, not only the jobs belonging to the user." + }, + { + "name": "fields", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "*" + ], + "description": "If fields set to '*', the request will return full details of the job. Currently the value can only be '*'." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/JobListJsonObject" + } + } + } + } + } + }, + "/templeton/v1/hive": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitHiveJob", + "description": "Submits a Hive job to an HDInsight cluster.", + "consumes": [ + "application/text" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Hive job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitHiveJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the Hive job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/mapreduce/jar": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitMapReduceJob", + "description": "Submits a MapReduce job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a MapReduce job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitMapReduceJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the MapReduce job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/mapreduce/streaming": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitMapReduceStreamingJob", + "description": "Submits a MapReduce streaming job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a MapReduce streaming job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitMapReduceStreamingJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the MapReduce job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/pig": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitPigJob", + "description": "Submits a Pig job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Pig job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitPigJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema":{ + "type": "object", + "format": "file" + }, + "description": "The content of the Pig job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/templeton/v1/sqoop": { + "post": { + "tags": [ + "Job" + ], + "operationId": "Job_SubmitSqoopJob", + "description": "Submits a Sqoop job to an HDInsight cluster.", + "consumes": [ + "text/plain" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Submits a Sqoop job to an HDInsight cluster.": { + "$ref": "./examples/HDI_Job_SubmitSqoopJob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/UserNameParameter" + }, + { + "name": "content", + "in": "body", + "required": true, + "schema": { + "type": "object", + "format": "file" + }, + "description": "The content of the Sqoop job request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/JobSubmissionJsonResponse" + } + } + } + } + }, + "/ws/v1/cluster/apps/{appId}/state": { + "get": { + "tags": [ + "Job" + ], + "operationId": "Job_GetAppState", + "description": "Gets application state from the specified HDInsight cluster.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Gets application state from the specified HDInsight cluster.": { + "$ref": "./examples/HDI_Job_GetAppState.json" + } + }, + "parameters": [ + { + "name": "appId", + "in": "path", + "required": true, + "type": "string", + "description": "The id of the job." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/JobOperationsErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/AppState" + } + } + } + } + } + }, + "definitions": { + "AppState": { + "description": "The State of the application.", + "properties": { + "state": { + "type": "string", + "enum": [ + "NEW", + "NEW_SAVING", + "SUBMITTED", + "ACCEPTED", + "RUNNING", + "FINISHED", + "FAILED", + "KILLED" + ], + "x-ms-enum": { + "name": "ApplicationState", + "modelAsString": false + }, + "description": "The State of the application." + } + } + }, + "JobOperationsErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "error": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "JobACLs": { + "description": "The object containing the job ACLs." + }, + "JobDetailRootJsonObject": { + "description": "The object containing the job details.", + "properties": { + "callback": { + "type": "object", + "description": "The callback URL, if any." + }, + "completed": { + "type": "string", + "description": "The string representing completed status, for example 'done'." + }, + "exitValue": { + "type": "integer", + "format": "int32", + "description": "The job's exit value." + }, + "id": { + "type": "string", + "description": "The job ID." + }, + "msg": { + "type": "object", + "description": "The message returned." + }, + "parentId": { + "type": "string", + "description": "The parent job ID." + }, + "percentComplete": { + "type": "string", + "description": "The job completion percentage, for example '75% complete'." + }, + "profile": { + "$ref": "#/definitions/Profile", + "description": "The object containing the job profile information." + }, + "status": { + "$ref": "#/definitions/Status", + "description": "The object containing the job status information." + }, + "user": { + "type": "string", + "description": "The user name of the job creator." + }, + "userargs": { + "$ref": "#/definitions/Userargs", + "description": "The arguments passed in by the user." + } + } + }, + "JobID": { + "description": "The object with the Job ID.", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "description": "The job number." + }, + "jtIdentifier": { + "type": "string", + "description": "The jobTracker identifier." + } + } + }, + "JobListJsonObject": { + "description": "The List Job operation response.", + "properties": { + "detail": { + "$ref": "#/definitions/JobDetailRootJsonObject", + "description": "The detail of the job." + }, + "id": { + "type": "string", + "description": "The Id of the job." + } + } + }, + "JobSubmissionJsonResponse": { + "description": "The job submission json response.", + "properties": { + "id": { + "type": "string", + "description": "The Id of the created job." + } + } + }, + "Profile": { + "description": "The object containing the job profile information.", + "properties": { + "jobFile": { + "type": "string", + "description": "The job configuration file." + }, + "jobId": { + "type": "string", + "description": "The full ID of the job." + }, + "jobID": { + "$ref": "#/definitions/JobID", + "description": "The ID of the job." + }, + "jobName": { + "type": "string", + "description": "The user-specified job name." + }, + "queueName": { + "type": "string", + "description": "The name of the queue to which the job is submitted." + }, + "url": { + "type": "string", + "description": "The link to the web-ui for details of the job." + }, + "user": { + "type": "string", + "description": "The userid of the person who submitted the job." + } + } + }, + "Status": { + "description": "Gets or sets the object containing the job status information.", + "properties": { + "cleanupProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the cleanup." + }, + "failureInfo": { + "type": "string", + "description": "The information about any failures that have occurred." + }, + "finishTime": { + "type": "integer", + "format": "int64", + "description": "The time at which the job completed. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." + }, + "historyFile": { + "type": "string", + "description": "The history file of the job." + }, + "jobACLs": { + "$ref": "#/definitions/JobACLs", + "description": "The ACLs of the job." + }, + "jobComplete": { + "type": "boolean", + "description": "Whether or not the job has completed." + }, + "jobFile": { + "type": "string", + "description": "The job configuration file." + }, + "jobId": { + "type": "string", + "description": "The full ID of the job." + }, + "jobID": { + "$ref": "#/definitions/JobID", + "description": "The ID of the job." + }, + "jobName": { + "type": "string", + "description": "The user-specified job name." + }, + "jobPriority": { + "type": "string", + "description": "The priority of the job." + }, + "mapProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the maps." + }, + "neededMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory needed for the job." + }, + "numReservedSlots": { + "type": "integer", + "format": "int32", + "description": "The number of slots reserved." + }, + "numUsedSlots": { + "type": "integer", + "format": "int32", + "description": "The number of slots used for the job." + }, + "priority": { + "type": "string", + "description": "The priority of the job." + }, + "queue": { + "type": "string", + "description": "The job queue name." + }, + "reduceProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the reduces." + }, + "reservedMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory reserved for the job." + }, + "retired": { + "type": "boolean", + "description": "Whether or not the job has been retired. " + }, + "runState": { + "type": "integer", + "format": "int32", + "description": "The current state of the job." + }, + "schedulingInfo": { + "type": "string", + "description": "The information about the scheduling of the job." + }, + "setupProgress": { + "type": "number", + "format": "double", + "description": "The progress made on the setup." + }, + "startTime": { + "type": "integer", + "format": "int64", + "description": "The time at which the job started. It is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00." + }, + "state": { + "type": "string", + "description": "The state of the job." + }, + "trackingUrl": { + "type": "string", + "description": "The link to the web-ui for details of the job." + }, + "uber": { + "type": "boolean", + "description": "Whether job running in uber mode." + }, + "usedMem": { + "type": "integer", + "format": "int64", + "description": "The amount of memory used by the job." + }, + "username": { + "type": "string", + "description": "The userid of the person who submitted the job." + } + } + }, + "Userargs": { + "description": "Gets or sets the object containing the user arguments.", + "properties": { + "arg": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The list of args defined by the user." + }, + "callback": { + "type": "object", + "description": "The callback URL, if any." + }, + "define": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The define properties defined by the user." + }, + "enablelog": { + "type": "string", + "description": "Whether or not the user enabled logs." + }, + "execute": { + "type": "string", + "description": "The query defined by the user." + }, + "file": { + "type": "object", + "description": "The query file provided by the user." + }, + "files": { + "type": "object", + "description": "The files defined by the user." + }, + "jar": { + "type": "string", + "description": "The JAR file provided by the user." + }, + "statusdir": { + "type": "object", + "description": "The status directory defined by the user." + } + } + } + }, + "parameters": { + "clusterDnsNameParameter": { + "name": "clusterDnsName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The cluster dns name against which the job management is to be.", + "x-ms-parameter-location": "client" + }, + "UserNameParameter": { + "name": "user.name", + "in": "query", + "required": true, + "type": "string", + "description": "The user name used for running job.", + "x-ms-parameter-location": "client" + } + } +} \ No newline at end of file diff --git a/specification/hdinsight/data-plane/readme.go.md b/specification/hdinsight/data-plane/readme.go.md new file mode 100644 index 000000000000..9a1d821a78fa --- /dev/null +++ b/specification/hdinsight/data-plane/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: hdinsight + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-11-preview +``` + +### Tag: package-2018-11-preview and go + +These settings apply only when `--tag=package-2018-11-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/2018-11-01-preview/$(namespace) +``` diff --git a/specification/hdinsight/data-plane/readme.md b/specification/hdinsight/data-plane/readme.md new file mode 100644 index 000000000000..ef0ab6d3f261 --- /dev/null +++ b/specification/hdinsight/data-plane/readme.md @@ -0,0 +1,134 @@ +# HDInsight + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for HDInsight. + + + +--- +## Getting Started +To build the SDK for HDInsight, 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 HDInsight API. + +``` yaml +openapi-type: data-plane +tag: package-2018-11-preview +``` + +### Tag: package-2018-11-preview + +These settings apply only when `--tag=package-2018-11-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-preview' +input-file: +- Microsoft.HDInsight/preview/2018-11-01-preview/job.json +``` + + +--- +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-java + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-go +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.HDInsight + output-folder: $(csharp-sdks-folder)/HDInsight/DataPlane/Microsoft.Azure.Management.HDInsight.Job/Generated + clear-output-folder: true +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +These settings apply only when `--python` is specified on the command line. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + package-name: azure-mgmt-hdinsight-job + clear-output-folder: true + no-namespace-folders: true +``` + +### Tag: package-2018-11-preview and python + +These settings apply only when `--tag=package-2018-11-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(python) +python: + namespace: azure.mgmt.hdinsight.job + output-folder: $(python-sdks-folder)/azure-mgmt-hdinsight-job/azure/mgmt/hdinsight/job +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.hdinsight.job + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-hdinsight-job +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-11-preview +``` + +### Tag:package-2018-11-preview and java + +These settings apply only when `--tag=package-2018-11-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-11-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.hdinsight.job.v2018_11_01_preview + output-folder: $(azure-libraries-for-java-folder)/hdinsight/data-plane/v2018_11_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index 017b0d44bdde..c9c998d78bc9 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -117,7 +117,7 @@ Please also specify `--csharp-sdks-folder= Date: Mon, 3 Dec 2018 12:45:08 -0500 Subject: [PATCH 262/464] typo: powerbiembedded/resource-manager/Microsoft.PowerBI (#4729) - defintion -> definition --- .../stable/2016-01-29/powerbiembedded.json | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json b/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json index 11d5cdc70a2d..5142a9354f8c 100644 --- a/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json +++ b/specification/powerbiembedded/resource-manager/Microsoft.PowerBI/stable/2016-01-29/powerbiembedded.json @@ -59,7 +59,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -117,7 +117,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -175,7 +175,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -222,7 +222,7 @@ "description": "Workspace collection deleted successfully" }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -275,7 +275,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -322,7 +322,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -362,7 +362,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -413,7 +413,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -473,7 +473,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -507,7 +507,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -561,7 +561,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -611,7 +611,7 @@ "description": "Migration completed successfully" }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } From 2a06a0b7a3d726c1bd9f8b0d7ebd4d121574a2e4 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:45:40 -0500 Subject: [PATCH 263/464] typo: policyinsights/resource-manager/Microsoft.PolicyInsights (#4726) - paramters -> parameters - deplyoments -> deployments --- .../2018-07-01-preview/policyTrackedResources.json | 8 ++++---- .../preview/2018-07-01-preview/remediations.json | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json index 0ab81a3d5f8d..5d2fb40318e2 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/policyTrackedResources.json @@ -75,7 +75,7 @@ "Query at management group scope": { "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScope.json" }, - "Query at management group scope using query paramters": { + "Query at management group scope using query parameters": { "$ref": "./examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json" } } @@ -123,7 +123,7 @@ "Query at subscription scope": { "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScope.json" }, - "Query at subscription scope using query paramters": { + "Query at subscription scope using query parameters": { "$ref": "./examples/PolicyTrackedResources_QuerySubscriptionScopeWithFilterAndTop.json" } } @@ -174,7 +174,7 @@ "Query at resource group scope": { "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScope.json" }, - "Query at resource group scope using query paramters": { + "Query at resource group scope using query parameters": { "$ref": "./examples/PolicyTrackedResources_QueryResourceGroupScopeWithFilterAndTop.json" } } @@ -222,7 +222,7 @@ "Query at resource scope": { "$ref": "./examples/PolicyTrackedResources_QueryResourceScope.json" }, - "Query at resource scope using query paramters": { + "Query at resource scope using query parameters": { "$ref": "./examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json" } } diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json index 772ae47627d3..70442559e554 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/remediations.json @@ -1188,7 +1188,7 @@ }, "deploymentStatus": { "$ref": "#/definitions/RemediationDeploymentSummary", - "description": "The deployment status summary for all deplyoments created by the remediation." + "description": "The deployment status summary for all deployments created by the remediation." } }, "description": "The remediation properties." @@ -1220,7 +1220,7 @@ "description": "The number of deployments required by the remediation that have failed." } }, - "description": "The deployment status summary for all deplyoments created by the remediation." + "description": "The deployment status summary for all deployments created by the remediation." }, "ErrorResponse": { "description": "Error response.", From 0675058dbb877a3609376f4f37ca3f6fd4680d07 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:46:54 -0500 Subject: [PATCH 264/464] typo: logic/resource-manager/Microsoft.Logic (#4708) - conetnt -> content --- .../Microsoft.Logic/preview/2015-08-01-preview/logic.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json index 6caf979e6ae7..815f043f5b86 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json @@ -1424,7 +1424,7 @@ "properties": { "algorithm": { "type": "string", - "description": "The conetnt hash algorithm." + "description": "The content hash algorithm." }, "value": { "type": "string", From d8177adc0fe4bfda83379a0090b66461b129f5eb Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:47:36 -0500 Subject: [PATCH 265/464] typo: Microsoft.HardwareSecurityModules (#4696) - SubcriptionId -> SubscriptionId --- .../preview/2018-10-31-preview/dedicatedhsm.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json index e1ed9169c4e0..36c26a2c3cff 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/preview/2018-10-31-preview/dedicatedhsm.json @@ -370,7 +370,7 @@ "properties": { "id": { "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." } }, "description": "The API entity reference." @@ -380,7 +380,7 @@ "id": { "readOnly": true, "type": "string", - "description": "The ARM resource id in the form of /subscriptions/{SubcriptionId}/resourceGroups/{ResourceGroupName}/..." + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." }, "privateIpAddress": { "type": "string", From 3333a6c21bee27c28a3ff2d5b972b9481641e395 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:48:12 -0500 Subject: [PATCH 266/464] typo: Microsoft.DevTestLab (#4685) - Reponse -> Response - notificationchannels -> notification channels - GibiBytes -> Gibibytes --- .../preview/2015-05-21-preview/DTL.json | 2 +- .../stable/2016-05-15/DTL.json | 14 +++++++------- .../stable/2018-09-15/DTL.json | 16 ++++++++-------- .../examples/ProviderOperations_List.json | 12 ++++++------ 4 files changed, 22 insertions(+), 22 deletions(-) diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json index 9fb6f1e1d6c7..f1ff910b0a4f 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/preview/2015-05-21-preview/DTL.json @@ -3554,7 +3554,7 @@ } }, "GenerateUploadUriResponse": { - "description": "Reponse body for generating an upload URI.", + "description": "Response body for generating an upload URI.", "type": "object", "properties": { "uploadUri": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json index 8da36e97e6e9..6d6dde42210f 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2016-05-15/DTL.json @@ -1256,7 +1256,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels": { "get": { "tags": [ "NotificationChannels" ], - "description": "List notificationchannels in a given lab.", + "description": "List notification channels in a given lab.", "operationId": "NotificationChannels_List", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1317,7 +1317,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}": { "get": { "tags": [ "NotificationChannels" ], - "description": "Get notificationchannel.", + "description": "Get notification channels.", "operationId": "NotificationChannels_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1405,7 +1405,7 @@ }, "delete": { "tags": [ "NotificationChannels" ], - "description": "Delete notificationchannel.", + "description": "Delete notification channel.", "operationId": "NotificationChannels_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1438,7 +1438,7 @@ }, "patch": { "tags": [ "NotificationChannels" ], - "description": "Modify properties of notificationchannels.", + "description": "Modify properties of notification channels.", "operationId": "NotificationChannels_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -5361,7 +5361,7 @@ "properties": { "diskSizeGiB": { "format": "int32", - "description": "Size of the disk to be attached in GibiBytes.", + "description": "Size of the disk to be attached in Gibibytes.", "type": "integer" }, "diskName": { @@ -5789,7 +5789,7 @@ }, "diskSizeGiB": { "format": "int32", - "description": "The size of the disk in GibiBytes.", + "description": "The size of the disk in Gibibytes.", "type": "integer" }, "leasedByLabVmId": { @@ -6200,7 +6200,7 @@ } }, "GenerateUploadUriResponse": { - "description": "Reponse body for generating an upload URI.", + "description": "Response body for generating an upload URI.", "type": "object", "properties": { "uploadUri": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json index 29bef183f87f..8ad68102abd9 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/DTL.json @@ -1316,7 +1316,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels": { "get": { "tags": [ "NotificationChannels" ], - "description": "List notificationchannels in a given lab.", + "description": "List notification channels in a given lab.", "operationId": "NotificationChannels_List", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1376,7 +1376,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/notificationchannels/{name}": { "get": { "tags": [ "NotificationChannels" ], - "description": "Get notificationchannel.", + "description": "Get notification channel.", "operationId": "NotificationChannels_Get", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1462,7 +1462,7 @@ }, "delete": { "tags": [ "NotificationChannels" ], - "description": "Delete notificationchannel.", + "description": "Delete notification channel.", "operationId": "NotificationChannels_Delete", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -1494,7 +1494,7 @@ }, "patch": { "tags": [ "NotificationChannels" ], - "description": "Modify properties of notificationchannels.", + "description": "Modify properties of notification channels.", "operationId": "NotificationChannels_Update", "parameters": [ { "$ref": "#/parameters/subscriptionId" }, @@ -6562,7 +6562,7 @@ "properties": { "diskSizeGiB": { "format": "int32", - "description": "Size of the disk to be attached in GibiBytes.", + "description": "Size of the disk to be attached in Gibibytes.", "type": "integer" }, "diskName": { @@ -6586,7 +6586,7 @@ "properties": { "diskSizeGiB": { "format": "int32", - "description": "Size of the disk to be attached in GibiBytes.", + "description": "Size of the disk to be attached in Gibibytes.", "type": "integer" }, "diskName": { @@ -7293,7 +7293,7 @@ }, "diskSizeGiB": { "format": "int32", - "description": "The size of the disk in GibiBytes.", + "description": "The size of the disk in Gibibytes.", "type": "integer" }, "leasedByLabVmId": { @@ -7349,7 +7349,7 @@ }, "diskSizeGiB": { "format": "int32", - "description": "The size of the disk in GibiBytes.", + "description": "The size of the disk in Gibibytes.", "type": "integer" }, "leasedByLabVmId": { diff --git a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json index 6dd7298e67a5..762f1f69fc44 100644 --- a/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json +++ b/specification/devtestlabs/resource-manager/Microsoft.DevTestLab/stable/2018-09-15/examples/ProviderOperations_List.json @@ -668,8 +668,8 @@ "display": { "provider": "Microsoft DevTest Labs", "resource": "notificationChannels", - "operation": "Delete notificationchannels.", - "description": "Delete notificationchannels." + "operation": "Delete notification channels.", + "description": "Delete notification channels." } }, { @@ -677,8 +677,8 @@ "display": { "provider": "Microsoft DevTest Labs", "resource": "notificationChannels", - "operation": "Read notificationchannels.", - "description": "Read notificationchannels." + "operation": "Read notification channels.", + "description": "Read notification channels." } }, { @@ -686,8 +686,8 @@ "display": { "provider": "Microsoft DevTest Labs", "resource": "notificationChannels", - "operation": "Add or modify notificationchannels.", - "description": "Add or modify notificationchannels." + "operation": "Add or modify notification channels.", + "description": "Add or modify notification channels." } }, { From 52e489a401ff9b4f2b28c60900ff0c290fb9f616 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:48:39 -0500 Subject: [PATCH 267/464] typo: Microsoft.DataCatalog (#4674) - catlog -> catalog --- .../Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json b/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json index f863b8e21593..b0632da9379c 100644 --- a/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json +++ b/specification/datacatalog/resource-manager/Microsoft.DataCatalog/stable/2016-03-30/datacatalog.json @@ -428,7 +428,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the data catlog in the specified subscription and resource group.", + "description": "The name of the data catalog in the specified subscription and resource group.", "x-ms-parameter-location": "client" } } From ff7dda5da23a77e2bbabba8afdf98abd340a0cc2 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:49:41 -0500 Subject: [PATCH 268/464] typo: Microsoft.Consumption (#4660) - perdiod -> period - scenarion -> scenario - servicetype -> serviceType - additoinalinfo -> additional info - reservationid -> reservationId - subscripotionId -> subscriptionId - recomendations -> recommendations - assiciated -> associated - Recomended -> Recommended - Departmentt -> Department - Trim trailing whitespace --- .../2017-04-24-preview/consumption.json | 4 +- .../2017-12-30-preview/consumption.json | 8 ++-- .../stable/2017-11-30/consumption.json | 8 ++-- .../stable/2018-01-31/consumption.json | 12 +++--- .../stable/2018-03-31/consumption.json | 40 +++++++++---------- .../stable/2018-06-30/consumption.json | 24 +++++------ .../stable/2018-08-31/consumption.json | 18 ++++----- .../stable/2018-10-01/consumption.json | 18 ++++----- 8 files changed, 66 insertions(+), 66 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json index 8da9713f82a2..4b06ad37b3f2 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/consumption.json @@ -61,7 +61,7 @@ "parameters": [ { "name": "scope", - "description": "The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod.", + "description": "The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing period.", "in": "path", "required": true, "type": "string", @@ -441,4 +441,4 @@ "type": "string" } } -} +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json index 2b8c45cb593a..dd74831a2c42 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-12-30-preview/consumption.json @@ -317,7 +317,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "currentSpend": { @@ -424,7 +424,7 @@ "threshold", "contactEmails" ] - }, + }, "Operation": { "description": "A Consumption REST API operation.", "type": "object", @@ -455,7 +455,7 @@ } } } - }, + }, "OperationListResult": { "description": "Result of listing consumption operations. It contains a list of operations and a URL link to get the next set of results.", "properties": { @@ -519,7 +519,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/consumption.json index 477b89cc2788..fb9254f01c9b 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/consumption.json @@ -67,7 +67,7 @@ "parameters": [ { "name": "scope", - "description": "The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod.", + "description": "The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing period.", "in": "path", "required": true, "type": "string", @@ -545,7 +545,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -630,7 +630,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -658,7 +658,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json index 328db3b39182..0251a5418ee7 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-01-31/consumption.json @@ -257,7 +257,7 @@ ], "x-ms-odata": "#/definitions/Marketplace", "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1518,7 +1518,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -1608,7 +1608,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -1636,7 +1636,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true @@ -1711,7 +1711,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "filters": { @@ -1988,7 +1988,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json index eac7453f6c4f..0dec2d99c9d4 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-03-31/consumption.json @@ -94,7 +94,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -171,7 +171,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -271,7 +271,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -442,7 +442,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -513,7 +513,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -613,7 +613,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart)", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -684,7 +684,7 @@ "description": "OData apply expression to aggregate usageDetails by tags or (tags and properties/usageStart) for specified billing period", "in": "query", "required": false, - "type": "string", + "type": "string", "x-ms-parameter-location": "method", "x-ms-parameter-grouping": { "name": "QueryOptions" @@ -803,7 +803,7 @@ ], "x-ms-odata": "#/definitions/Marketplace", "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1571,7 +1571,7 @@ "ReservationRecommendations" ], "operationId": "ReservationRecommendations_List", - "description": "List of recomendations for purchasing reserved instances.", + "description": "List of recommendations for purchasing reserved instances.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1583,7 +1583,7 @@ "$ref": "./examples/ReservationRecommendationsFilterByScopeLookBackPeriod.json" } }, - "parameters": [ + "parameters": [ { "name": "$filter", "description": "May be used to filter reservationRecommendations by properties/scope and properties/lookBackPeriod.", @@ -2184,7 +2184,7 @@ "tags": [ "CostTags" ], - "description": "The operation to create or update cost tags assiciated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "description": "The operation to create or update cost tags associated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", "operationId": "CostTags_CreateOrUpdate", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" @@ -2835,7 +2835,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -2937,7 +2937,7 @@ "readOnly": true }, "recommendedQuantity": { - "description": "Recomended quality for reserved instances.", + "description": "Recommended quality for reserved instances.", "type": "number", "format": "decimal", "readOnly": true @@ -2953,13 +2953,13 @@ "type": "number", "format": "decimal", "readOnly": true - }, + }, "firstUsageDate": { "description": "The usage date for looking back.", "type": "string", "format": "date-time", "readOnly": true - }, + }, "scope": { "description": "Shared or single recommendation.", "type": "string", @@ -3018,7 +3018,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3046,7 +3046,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true @@ -3158,7 +3158,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "filters": { @@ -3237,7 +3237,7 @@ "minItems": 0, "maxItems": 10 }, - "tags": { + "tags": { "type": "object", "description": "The dictionary of filters on tags.", "additionalProperties": { @@ -3500,7 +3500,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json index c2ac12c035b5..eadc4736ebca 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-06-30/consumption.json @@ -803,7 +803,7 @@ ], "x-ms-odata": "#/definitions/Marketplace", "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1571,7 +1571,7 @@ "ReservationRecommendations" ], "operationId": "ReservationRecommendations_List", - "description": "List of recomendations for purchasing reserved instances.", + "description": "List of recommendations for purchasing reserved instances.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -2153,7 +2153,7 @@ "tags": [ "CostTags" ], - "description": "The operation to create or update cost tags assiciated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "description": "The operation to create or update cost tags associated with a billing account. Update operation requires latest eTag to be set in the request mandatorily. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", "operationId": "CostTags_CreateOrUpdate", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" @@ -2556,7 +2556,7 @@ "parameters": [ { "$ref": "#/parameters/managementGroupIdParameter" - }, + }, { "$ref": "#/parameters/billingPeriodNameParameter" }, @@ -3178,7 +3178,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3268,7 +3268,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3296,7 +3296,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true @@ -3366,7 +3366,7 @@ "readOnly": true }, "recommendedQuantity": { - "description": "Recomended quality for reserved instances.", + "description": "Recommended quality for reserved instances.", "type": "number", "format": "decimal", "readOnly": true @@ -3501,7 +3501,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "filters": { @@ -3784,14 +3784,14 @@ "description": "Currency Code", "type": "string", "readOnly": true - }, + }, "offerId": { "description": "Offer Id", "type": "string", "readOnly": true } } - }, + }, "Forecast": { "description": "A forecast resource.", "type": "object", @@ -4098,7 +4098,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json index 5568363bbfb4..4dd8aa0d5496 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-08-31/consumption.json @@ -803,7 +803,7 @@ ], "x-ms-odata": "#/definitions/Marketplace", "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1571,7 +1571,7 @@ "ReservationRecommendations" ], "operationId": "ReservationRecommendations_List", - "description": "List of recomendations for purchasing reserved instances.", + "description": "List of recommendations for purchasing reserved instances.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -2661,7 +2661,7 @@ "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { - "ChangesForBillingPeriodByDepartmentt": { + "ChangesForBillingPeriodByDepartment": { "$ref": "./examples/ChargesForBillingPeriodByDepartment.json" } }, @@ -3305,7 +3305,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3395,7 +3395,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3423,7 +3423,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true @@ -3493,7 +3493,7 @@ "readOnly": true }, "recommendedQuantity": { - "description": "Recomended quality for reserved instances.", + "description": "Recommended quality for reserved instances.", "type": "number", "format": "decimal", "readOnly": true @@ -3628,7 +3628,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "filters": { @@ -4273,7 +4273,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json index 42e436acd126..d28a411e6930 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2018-10-01/consumption.json @@ -803,7 +803,7 @@ ], "x-ms-odata": "#/definitions/Marketplace", "operationId": "Marketplaces_ListByBillingPeriod", - "description": "Lists the marketplaces for a scope by billing period and subscripotionId. Marketplaces are available via this API only for May 1, 2014 or later.", + "description": "Lists the marketplaces for a scope by billing period and subscriptionId. Marketplaces are available via this API only for May 1, 2014 or later.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -1571,7 +1571,7 @@ "ReservationRecommendations" ], "operationId": "ReservationRecommendations_List", - "description": "List of recomendations for purchasing reserved instances.", + "description": "List of recommendations for purchasing reserved instances.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, @@ -2661,7 +2661,7 @@ "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { - "ChangesForBillingPeriodByDepartmentt": { + "ChangesForBillingPeriodByDepartment": { "$ref": "./examples/ChargesForBillingPeriodByDepartment.json" } }, @@ -3440,7 +3440,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3530,7 +3530,7 @@ "readOnly": true }, "skuName": { - "description": "This is the ARM Sku name. It can be used to join with the servicetype field in additoinalinfo in usage records.", + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", "type": "string", "readOnly": true }, @@ -3558,7 +3558,7 @@ "readOnly": true }, "totalReservedQuantity": { - "description": "This is the total count of instances that are reserved for the reservationid.", + "description": "This is the total count of instances that are reserved for the reservationId.", "type": "number", "format": "decimal", "readOnly": true @@ -3628,7 +3628,7 @@ "readOnly": true }, "recommendedQuantity": { - "description": "Recomended quality for reserved instances.", + "description": "Recommended quality for reserved instances.", "type": "number", "format": "decimal", "readOnly": true @@ -3763,7 +3763,7 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain preiod. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, "filters": { @@ -4422,7 +4422,7 @@ }, "eTag": { "type": "string", - "description": "eTag of the resource. To handle concurrent update scenarion, this field will be used to determine whether the user is updating the latest version or not." + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." } }, "x-ms-azure-resource": true From 7bb5751308ae9a168201fd3c10c3bb8489569654 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:50:07 -0500 Subject: [PATCH 269/464] typo: cognitiveservices/data-plane/EntitySearch (#4651) - countr -> country --- .../data-plane/EntitySearch/stable/v1.0/EntitySearch.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json index 4aed0801caa5..7579f9c1508e 100644 --- a/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json +++ b/specification/cognitiveservices/data-plane/EntitySearch/stable/v1.0/EntitySearch.json @@ -891,7 +891,7 @@ "type": "string" }, "countryIso": { - "description": "The two letter ISO code of this countr. For example, US.", + "description": "The two letter ISO code of this country. For example, US.", "readOnly": true, "type": "string" }, From f2014e9941a24627acf78b364681cd776bf8b2c8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:50:47 -0500 Subject: [PATCH 270/464] chore: Format BlobServicesGet.json (#4641) - Remove trailing comma that failed the JSON.parse in semantic validation - Tabs -> spaces --- .../2018-07-01/examples/BlobServicesGet.json | 73 +++++++++---------- 1 file changed, 36 insertions(+), 37 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json index 8036d7db9720..9a6e3acd683e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesGet.json @@ -15,63 +15,62 @@ "type": "Microsoft.Storage/storageAccounts/blobServices", "properties": { "cors": { - "corsRules": [ - { + "corsRules": [{ "allowedOrigins": [ - "http://www.contoso.com", - "http://www.fabrikam.com" - ], + "http://www.contoso.com", + "http://www.fabrikam.com" + ], "allowedMethods": [ - "GET", - "HEAD", - "POST", - "OPTIONS", - "MERGE", - "PUT" - ], + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], "maxAgeInSeconds": 100, "exposedHeaders": [ - "x-ms-meta-*" - ], + "x-ms-meta-*" + ], "allowedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x-ms-meta-target*" - ], + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] }, { "allowedOrigins": [ - "*" - ], + "*" + ], "allowedMethods": [ - "GET" + "GET" ], "maxAgeInSeconds": 2, "exposedHeaders": [ - "*" - ], + "*" + ], "allowedHeaders": [ - "*" - ], + "*" + ] }, { "allowedOrigins": [ - "http://www.abc23.com", - "https://www.fabrikam.com/*" - ], + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], "allowedMethods": [ - "GET", - "PUT" + "GET", + "PUT" ], "maxAgeInSeconds": 2000, "exposedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x -ms-meta-target*" - ], + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], "allowedHeaders": [ - "x-ms-meta-12345675754564*" - ], + "x-ms-meta-12345675754564*" + ] } ] }, @@ -84,4 +83,4 @@ } } } -} \ No newline at end of file +} From c648f68736311f004867298cb6d9e78ae9866469 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:51:15 -0500 Subject: [PATCH 271/464] typo: Microsoft.Billing (#4632) - perdiod -> period - prouct -> product - setion -> section --- .../preview/2017-04-24-preview/billing.json | 4 ++-- .../preview/2018-03-01-preview/billing.json | 2 +- .../preview/2018-08-01-preview/billing.json | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json index 47726b6c1721..1c492d43ed9a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/billing.json @@ -486,7 +486,7 @@ "readOnly": true }, "billingPeriodIds": { - "description": "Array of billing perdiod ids that the invoice is attributed to.", + "description": "Array of billing period ids that the invoice is attributed to.", "type": "array", "readOnly": true, "items": { @@ -582,4 +582,4 @@ "type": "string" } } -} +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billing.json index c64db9ceb132..74de6d615fa9 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billing.json @@ -590,7 +590,7 @@ "readOnly": true }, "billingPeriodIds": { - "description": "Array of billing perdiod ids that the invoice is attributed to.", + "description": "Array of billing period ids that the invoice is attributed to.", "type": "array", "readOnly": true, "items": { diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json index 069933f95a46..494e02ab35e3 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json @@ -877,7 +877,7 @@ "readOnly": true }, "billingPeriodIds": { - "description": "Array of billing perdiod ids that the invoice is attributed to.", + "description": "Array of billing period ids that the invoice is attributed to.", "type": "array", "readOnly": true, "items": { @@ -1010,7 +1010,7 @@ "description": "Details of the product to be transferred.", "properties": { "productType": { - "description": "Type of the prouct to be transferred.", + "description": "Type of the product to be transferred.", "$ref": "#/definitions/ProductType" }, "productId": { @@ -1126,7 +1126,7 @@ }, "invoiceSectionId": { "type": "string", - "description": "Target invoice setion Id.", + "description": "Target invoice section Id.", "readOnly": true }, "billingAccountId": { From 36c01bccf46cb13da48f46a5d6ac050965e576c5 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 12:53:15 -0500 Subject: [PATCH 272/464] typo: Microsoft.AzureStack (#4611) - concurency -> concurrency - subcription -> subscription - inclided -> included - regstration -> registration --- .../Microsoft.AzureStack/stable/2017-06-01/AzureStack.json | 4 ++-- .../stable/2017-06-01/CustomerSubscription.json | 2 +- .../Microsoft.AzureStack/stable/2017-06-01/Product.json | 2 +- .../Microsoft.AzureStack/stable/2017-06-01/Registration.json | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json index 12a00336249a..83cbb972f1cd 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/AzureStack.json @@ -67,7 +67,7 @@ "type": "string" }, "etag": { - "description": "The entity tag used for optimistic concurency when modifying the resource.", + "description": "The entity tag used for optimistic concurrency when modifying the resource.", "type": "string" } }, @@ -115,7 +115,7 @@ } }, "etag": { - "description": "The entity tag used for optimistic concurency when modifying the resource.", + "description": "The entity tag used for optimistic concurrency when modifying the resource.", "type": "string" } }, diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json index 9eaec2ad6160..8cf39d4fe8d2 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/CustomerSubscription.json @@ -185,7 +185,7 @@ }, "definitions": { "CustomerSubscription": { - "description": "Customer subcription.", + "description": "Customer subscription.", "type": "object", "properties": { "properties": { diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json index 6903ff22bf8a..68db9546699f 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Product.json @@ -223,7 +223,7 @@ "type": "object", "properties": { "computeRole": { - "description": "Specifies kind of compute role inclided in the package.", + "description": "Specifies kind of compute role included in the package.", "$ref": "#/definitions/ComputeRole", "readOnly": true }, diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json index e690100f4ac8..9bc002b73f30 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json @@ -352,7 +352,7 @@ } }, "RegistrationParameterProperties": { - "description": "Properties of the Azure Stack regstration resource", + "description": "Properties of the Azure Stack registration resource", "type": "object", "properties": { "registrationToken": { From 1cc12ad539f322ea1e80c7870adcaf498f084c0e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:09:10 -0500 Subject: [PATCH 273/464] chore: Add vscode-docs-authoring suggestion (#4568) --- .vscode/extensions.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 000000000000..7aeb084ce335 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,5 @@ +{ + "recommendations": [ + "vscode-docs-authoring" + ] +} From cbce29d0933f235c5d81fa8f444ee605811f4839 Mon Sep 17 00:00:00 2001 From: Junhua Gu <36521476+junhuagu@users.noreply.github.com> Date: Mon, 3 Dec 2018 11:18:47 -0800 Subject: [PATCH 274/464] Support DataLakeStorage 11-09-18 Version. (#4639) * Copy DataLakeStorage 06-17-18 Version * Support DataLakeStorage 11-09-18 Version * Fix missing input section and add resolve comments * Fix folder structure * Changes to move from preview to stable and remove duplicate tag * Further fixes * Fix the tag name for go * Fix the tag name for python * Fix the tag name for python --- .../stable/2018-11-09/DataLakeStorage.json | 1863 +++++++++++++++++ .../readme.go.md | 12 +- .../{Microsoft.StorageDataLake => }/readme.md | 23 +- .../readme.nodejs.md | 0 .../readme.typescript.md | 0 5 files changed, 1895 insertions(+), 3 deletions(-) create mode 100644 specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json rename specification/storage/data-plane/{Microsoft.StorageDataLake => }/readme.go.md (55%) rename specification/storage/data-plane/{Microsoft.StorageDataLake => }/readme.md (79%) rename specification/storage/data-plane/{Microsoft.StorageDataLake => }/readme.nodejs.md (100%) rename specification/storage/data-plane/{Microsoft.StorageDataLake => }/readme.typescript.md (100%) diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json new file mode 100644 index 000000000000..83ae7b96eabd --- /dev/null +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json @@ -0,0 +1,1863 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Data Lake Storage provides storage for Hadoop and other big data workloads.", + "title": "Azure Data Lake Storage REST API", + "version": "2018-11-09", + "x-ms-code-generation-settings": { + "internalConstructors": true, + "name": "DataLakeStorageClient" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{accountName}.{dnsSuffix}", + "parameters": [ + { + "$ref": "#/parameters/accountName" + }, + { + "$ref": "#/parameters/dnsSuffix" + } + ] + }, + "schemes": [ + "http", + "https" + ], + "produces": [ + "application/json" + ], + "tags": [ + { + "name": "Account Operations" + }, + { + "name": "Filesystem Operations" + }, + { + "name": "File and Directory Operations" + } + ], + "parameters": { + "Version": { + "description": "Specifies the version of the REST protocol used for processing the request. This is required when using shared key authorization.", + "in": "header", + "name": "x-ms-version", + "required": false, + "type": "string", + "x-ms-parameter-location": "client" + }, + "accountName": { + "description": "The Azure Storage account name.", + "in": "path", + "name": "accountName", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "dnsSuffix": { + "default": "dfs.core.windows.net", + "description": "The DNS suffix for the Azure Data Lake Storage endpoint.", + "in": "path", + "name": "dnsSuffix", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + } + }, + "definitions": { + "DataLakeStorageError": { + "properties": { + "error": { + "description": "The service error response object.", + "properties": { + "code": { + "description": "The service error code.", + "type": "string" + }, + "message": { + "description": "The service error message.", + "type": "string" + } + } + } + } + }, + "Path": { + "properties": { + "name": { + "type": "string" + }, + "isDirectory": { + "default": false, + "type": "boolean" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + }, + "contentLength": { + "type": "integer", + "format": "int64" + }, + "owner": { + "type": "string" + }, + "group": { + "type": "string" + }, + "permissions": { + "type": "string" + } + } + }, + "PathList": { + "properties": { + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "Filesystem": { + "properties": { + "name": { + "type": "string" + }, + "lastModified": { + "type": "string" + }, + "eTag": { + "type": "string" + } + } + }, + "FilesystemList": { + "properties": { + "filesystems": { + "type": "array", + "items": { + "$ref": "#/definitions/Filesystem" + } + } + } + } + }, + "responses": { + "ErrorResponse": { + "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specifed resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", + "headers": { + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/DataLakeStorageError" + } + } + }, + "paths": { + "/": { + "get": { + "operationId": "Filesystem_List", + "summary": "List Filesystems", + "description": "List filesystems and their properties in given account.", + "x-ms-pageable": { + "itemName": "filesystems", + "nextLinkName": null + }, + "tags": [ + "Account Operations" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "If the number of filesystems to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of list filesystem response. The default content type is application/json.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/FilesystemList" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "The value must be \"account\" for all account operations.", + "required": true, + "type": "string", + "enum": [ + "account" + ], + "x-ms-enum": { + "name": "AccountResourceType", + "modelAsString": false + } + }, + { + "name": "prefix", + "in": "query", + "description": "Filters results to filesystems within the specified prefix.", + "required": false, + "type": "string" + }, + { + "name": "continuation", + "in": "query", + "description": "The number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems.", + "required": false, + "type": "string" + }, + { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + } + }, + "/{filesystem}": { + "put": { + "operationId": "Filesystem_Create", + "summary": "Create Filesystem", + "description": "Create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests.", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Operations on files and directories do not affect the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-properties", + "description": "User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "patch": { + "operationId": "Filesystem_SetProperties", + "summary": "Set Filesystem Properties", + "description": "Set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "get": { + "operationId": "Path_List", + "summary": "List Paths", + "description": "List filesystem paths and their properties.", + "x-ms-pageable": { + "itemName": "paths", + "nextLinkName": null + }, + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "If the number of paths to be listed exceeds the maxResults limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/PathList" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "directory", + "in": "query", + "description": "Filters results to paths within the specified directory. An error occurs if the directory does not exist.", + "required": false, + "type": "string" + }, + { + "name": "recursive", + "in": "query", + "description": "If \"true\", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If \"directory\" is specified, the list will only include paths that share the same root.", + "required": true, + "type": "boolean" + }, + { + "name": "continuation", + "in": "query", + "description": "The number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths.", + "required": false, + "type": "string" + }, + { + "name": "maxResults", + "in": "query", + "description": "An optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false.", + "required": false, + "type": "boolean" + } + ] + }, + "head": { + "operationId": "Filesystem_GetProperties", + "summary": "Get Filesystem Properties.", + "description": "All system and user-defined filesystem properties are specified in the response headers.", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the filesystem. Changes to filesystem properties affect the entity tag, but operations on files and directories do not.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the filesystem was last modified. Changes to filesystem properties update the last modified time, but operations on files and directories do not.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the filesystem. A comma-separated list of name and value pairs in the format \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-namespace-enabled": { + "description": "A bool string indicates whether the namespace feature is enabled. If \"true\", the namespace is enabled for the filesystem. ", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + } + }, + "delete": { + "operationId": "Filesystem_Delete", + "summary": "Delete Filesystem", + "description": "Marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "Filesystem Operations" + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "parameters": [ + { + "name": "filesystem", + "in": "path", + "description": "The filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters.", + "pattern": "^[a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "minLength": 3, + "maxLength": 63, + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "query", + "description": "The value must be \"filesystem\" for all filesystem operations.", + "required": true, + "type": "string", + "enum": [ + "filesystem" + ], + "x-ms-enum": { + "name": "FilesystemResourceType", + "modelAsString": false + } + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + }, + "/{filesystem}/{path}": { + "put": { + "operationId": "Path_Create", + "summary": "Create File | Create Directory | Rename File | Rename Directory", + "description": "Create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: \"*\".", + "consumes": [ + "application/octet-stream" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "201": { + "description": "The file or directory was created.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "resource", + "in": "query", + "description": "Required only for Create File and Create Directory. The value must be \"file\" or \"directory\".", + "required": false, + "type": "string", + "enum": [ + "directory", + "file" + ], + "x-ms-enum": { + "name": "PathResourceType", + "modelAsString": false + } + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory.", + "required": false, + "type": "string" + }, + { + "name": "mode", + "in": "query", + "description": "Optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be \"legacy\" or \"posix\", and the default value will be \"posix\". ", + "required": false, + "type": "string", + "enum": [ + "legacy", + "posix" + ], + "x-ms-enum": { + "name": "PathRenameMode", + "modelAsString": false + } + }, + { + "name": "Cache-Control", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "Content-Encoding", + "in": "header", + "description": "Optional. Specifies which content encodings have been applied to the file. This value is returned to the client when the \"Read File\" operation is performed.", + "required": false, + "type": "string" + }, + { + "name": "Content-Language", + "in": "header", + "description": "Optional. Specifies the natural language used by the intended audience for the file.", + "required": false, + "type": "string" + }, + { + "name": "Content-Disposition", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-rename-source", + "in": "header", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Optional. A lease ID for the path specified in the URI. The path to be overwritten must have an active lease and the lease ID must match.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-lease-id", + "in": "header", + "description": "Optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-umask", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-match", + "description": "Optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-none-match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-modified-since", + "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-source-if-unmodified-since", + "description": "Optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "patch": { + "operationId": "Path_Update", + "summary": "Append Data | Flush Data | Set Properties | Set Access Control", + "description": "Uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "consumes": [ + "application/octet-stream", + "text/plain" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The data was flushed (written) to the file or the properties were set successfully.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "x-ms-properties": { + "description": "User-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "202": { + "description": "The uploaded data was accepted.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "action", + "in": "query", + "description": "The action must be \"append\" to upload data to be appended to a file, \"flush\" to flush previously uploaded data to a file, \"setProperties\" to set the properties of a file or directory, or \"setAccessControl\" to set the owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive.", + "required": true, + "type": "string", + "enum": [ + "append", + "flush", + "setProperties", + "setAccessControl" + ], + "x-ms-enum": { + "name": "PathUpdateAction", + "modelAsString": false + } + }, + { + "name": "position", + "in": "query", + "description": "This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.", + "format": "int64", + "required": false, + "type": "integer" + }, + { + "name": "retainUncommittedData", + "in": "query", + "description": "Valid only for flush operations. If \"true\", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.", + "required": false, + "type": "boolean" + }, + { + "name": "Content-Length", + "in": "header", + "description": "Required for \"Append Data\" and \"Flush Data\". Must be 0 for \"Flush Data\". Must be the length of the request content in bytes for \"Append Data\".", + "minimum": 0, + "required": false, + "type": "integer", + "format": "int64" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "The lease ID must be specified if there is an active lease.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-cache-control", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Cache-Control\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-type", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Type\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-disposition", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Disposition\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-encoding", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Encoding\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-content-language", + "in": "header", + "description": "Optional and only valid for flush and set properties operations. The service stores this value and includes it in the \"Content-Language\" response header for \"Read File\" operations.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-properties", + "description": "Optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-owner", + "description": "Optional and valid only for the setAccessControl operation. Sets the owner of the file or directory.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-group", + "description": "Optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-permissions", + "description": "Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "x-ms-acl", + "description": "Optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format \"[scope:][type]:[id]:[permissions]\". The scope must be \"default\" to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: \"user\" grants rights to the owner or a named user, \"group\" grants rights to the owning group or a named group, \"mask\" restricts rights granted to named users and the members of groups, and \"other\" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type \"mask\" and \"other\". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: \"user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx\". Invalid in conjunction with x-ms-permissions.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "requestBody", + "description": "Valid only for append operations. The data to be uploaded and appended to the file.", + "in": "body", + "required": false, + "schema": { + "type": "object", + "format": "file" + } + } + ] + }, + "post": { + "operationId": "Path_Lease", + "summary": "Lease Path", + "description": "Create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The \"renew\", \"change\" or \"release\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file was last modified. Write operations on the file update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "description": "A successful \"renew\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "201": { + "description": "A new lease has been created. The \"acquire\" action was successful.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-id": { + "description": "A successful \"acquire\" action returns the lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + } + } + }, + "202": { + "description": "The \"break\" lease action was successful.", + "headers": { + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-lease-time": { + "description": "The time remaining in the lease period in seconds.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "x-ms-lease-action", + "in": "header", + "description": "There are five lease actions: \"acquire\", \"break\", \"change\", \"renew\", and \"release\". Use \"acquire\" and specify the \"x-ms-proposed-lease-id\" and \"x-ms-lease-duration\" to acquire a new lease. Use \"break\" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use \"change\" and specify the current lease ID in \"x-ms-lease-id\" and the new lease ID in \"x-ms-proposed-lease-id\" to change the lease ID of an active lease. Use \"renew\" and specify the \"x-ms-lease-id\" to renew an existing lease. Use \"release\" and specify the \"x-ms-lease-id\" to release a lease.", + "required": true, + "type": "string", + "enum": [ + "acquire", + "break", + "change", + "renew", + "release" + ], + "x-ms-enum": { + "name": "PathLeaseAction", + "modelAsString": false + } + }, + { + "name": "x-ms-lease-duration", + "in": "header", + "description": "The lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease.", + "format": "int32", + "required": false, + "type": "integer" + }, + { + "name": "x-ms-lease-break-period", + "in": "header", + "description": "The lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds.", + "format": "int32", + "required": false, + "type": "integer" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Required when \"x-ms-lease-action\" is \"renew\", \"change\" or \"release\". For the renew and release actions, this must match the current lease ID.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "x-ms-proposed-lease-id", + "in": "header", + "description": "Required when \"x-ms-lease-action\" is \"acquire\" or \"change\". A lease will be acquired with this lease ID if the operation is successful.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "get": { + "operationId": "Path_Read", + "summary": "Read File", + "description": "Read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "produces": [ + "application/json", + "application/octet-stream", + "text/plain" + ], + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "Ok", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + }, + "schema": { + "type": "file" + } + }, + "206": { + "description": "Partial content", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + }, + "schema": { + "type": "file" + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "in": "header", + "description": "The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.", + "required": false, + "type": "string", + "name": "Range" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "head": { + "operationId": "Path_GetProperties", + "summary": "Get Properties | Get Status | Get Access Control List", + "description": "Get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "Returns all properties for the file or directory.", + "headers": { + "Accept-Ranges": { + "description": "Indicates that the service supports requests for partial file content.", + "type": "string" + }, + "Cache-Control": { + "description": "If the Cache-Control request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Disposition": { + "description": "If the Content-Disposition request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Encoding": { + "description": "If the Content-Encoding request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Language": { + "description": "If the Content-Language request header has previously been set for the resource, that value is returned in this header.", + "type": "string" + }, + "Content-Length": { + "description": "The size of the resource in bytes.", + "type": "integer", + "format": "int64" + }, + "Content-Range": { + "description": "Indicates the range of bytes returned in the event that the client requested a subset of the file by setting the Range request header.", + "type": "string" + }, + "Content-Type": { + "description": "The content type specified for the resource. If no content type was specified, the default content type is application/octet-stream.", + "type": "string" + }, + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "ETag": { + "description": "An HTTP entity tag associated with the file or directory.", + "type": "string" + }, + "Last-Modified": { + "description": "The data and time the file or directory was last modified. Write operations on the file or directory update the last modified time.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-resource-type": { + "description": "The type of the resource. The value may be \"file\" or \"directory\". If not set, the value is \"file\".", + "type": "string" + }, + "x-ms-properties": { + "description": "The user-defined properties associated with the file or directory, in the format of a comma-separated list of name and value pairs \"n1=v1, n2=v2, ...\", where each value is base64 encoded.", + "type": "string" + }, + "x-ms-owner": { + "description": "The owner of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-group": { + "description": "The owning group of the file or directory. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-permissions": { + "description": "The POSIX access permissions for the file owner, the file owning group, and others. Included in the response if Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-acl": { + "description": "The POSIX access control list for the file or directory. Included in the response only if the action is \"getAccessControl\" and Hierarchical Namespace is enabled for the account.", + "type": "string" + }, + "x-ms-lease-duration": { + "description": "When a resource is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string" + }, + "x-ms-lease-state": { + "description": "Lease state of the resource. ", + "type": "string" + }, + "x-ms-lease-status": { + "description": "The lease status of the resource.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "action", + "in": "query", + "description": "Optional. If the value is \"getStatus\" only the system defined properties for the path are returned. If the value is \"getAccessControl\" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned.", + "required": false, + "type": "string", + "enum": [ + "getAccessControl", + "getStatus" + ], + "x-ms-enum": { + "name": "PathGetPropertiesAction", + "modelAsString": false + } + }, + { + "name": "upn", + "in": "query", + "description": "Optional. Valid only when Hierarchical Namespace is enabled for the account. If \"true\", the identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If \"false\", the values will be returned as Azure Active Directory Object IDs. The default value is false.", + "required": false, + "type": "boolean" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "Optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "delete": { + "operationId": "Path_Delete", + "summary": "Delete File | Delete Directory", + "description": "Delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations).", + "tags": [ + "File and Directory Operations" + ], + "responses": { + "200": { + "description": "The file was deleted.", + "headers": { + "Date": { + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated.", + "type": "string" + }, + "x-ms-request-id": { + "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "type": "string" + }, + "x-ms-version": { + "description": "The version of the REST protocol used to process the request.", + "type": "string" + }, + "x-ms-continuation": { + "description": "When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "type": "string" + } + } + }, + "default": { + "$ref": "#/responses/ErrorResponse" + } + }, + "parameters": [ + { + "name": "recursive", + "in": "query", + "description": "Required and valid only when the resource is a directory. If \"true\", all paths beneath the directory will be deleted. If \"false\" and the directory is non-empty, an error occurs.", + "required": false, + "type": "boolean" + }, + { + "name": "continuation", + "in": "query", + "description": "Optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory.", + "required": false, + "type": "string" + }, + { + "name": "x-ms-lease-id", + "in": "header", + "description": "The lease ID must be specified if there is an active lease.", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string" + }, + { + "name": "If-Match", + "description": "Optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-None-Match", + "description": "Optional. An ETag value or the special wildcard (\"*\") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Modified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + }, + { + "name": "If-Unmodified-Since", + "description": "Optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time.", + "in": "header", + "required": false, + "type": "string" + } + ] + }, + "parameters": [ + { + "name": "filesystem", + "in": "path", + "description": "The filesystem identifier.", + "pattern": "^[a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$", + "minLength": 3, + "maxLength": 63, + "required": true, + "type": "string" + }, + { + "name": "path", + "in": "path", + "description": "The file or directory path.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-client-request-id", + "description": "A UUID recorded in the analytics logs for troubleshooting and correlation.", + "in": "header", + "pattern": "^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$", + "required": false, + "type": "string", + "x-ms-client-request-id": true + }, + { + "name": "timeout", + "in": "query", + "description": "An optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails.", + "format": "int32", + "minimum": 1, + "required": false, + "type": "integer" + }, + { + "name": "x-ms-date", + "in": "header", + "description": "Specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/Version" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.go.md b/specification/storage/data-plane/readme.go.md similarity index 55% rename from specification/storage/data-plane/Microsoft.StorageDataLake/readme.go.md rename to specification/storage/data-plane/readme.go.md index f8e96c264598..48e8e66aede0 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.go.md +++ b/specification/storage/data-plane/readme.go.md @@ -13,14 +13,24 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-11 - tag: package-2018-06-preview ``` +### Tag: package-2018-11 and go + +These settings apply only when `--tag=package-2018-11 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-11' && $(go) +output-folder: $(go-sdk-folder)/services/stable/storage/datalake/2018-11-09/$(namespace) +``` + ### Tag: package-2018-06-preview and go These settings apply only when `--tag=package-2018-06-preview --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-06-preview' && $(go) -output-folder: $(go-sdk-folder)/services/storage/datalake/2018-06-17/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/storage/datalake/2018-06-17/$(namespace) ``` \ No newline at end of file diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md b/specification/storage/data-plane/readme.md similarity index 79% rename from specification/storage/data-plane/Microsoft.StorageDataLake/readme.md rename to specification/storage/data-plane/readme.md index b149e3ccbb03..941e2d0bfd54 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.md +++ b/specification/storage/data-plane/readme.md @@ -26,11 +26,19 @@ These are the global settings for the DataLakeStorage API. ``` yaml openapi-type: data-plane -tag: package-2018-06-preview +tag: package-2018-11 use-internal-constructors: true add-credentials: true ``` +### Tag: package-2018-11 + +These settings apply only when `--tag=package-2018-11` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11' +input-file: +- Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json +``` ### Tag: package-2018-06-preview @@ -38,7 +46,7 @@ These settings apply only when `--tag=package-2018-06-preview` is specified on t ``` yaml $(tag) == 'package-2018-06-preview' input-file: -- preview/2018-06-17/DataLakeStorage.json +- Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json ``` --- @@ -87,9 +95,20 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2018-11 - tag: package-2018-06-preview ``` +### Tag: package-2018-11 and python + +These settings apply only when `--tag=package-2018-11 --python` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11' && $(python) +python: + namespace: azure.datalake.storage.v2018_11_09 + output-folder: $(python-sdks-folder)/azure-datalake-storage/azure/datalake/storage/v2018_11_09 +``` + ### Tag: package-2018-06-preview and python These settings apply only when `--tag=package-2018-06-preview --python` is specified on the command line. diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.nodejs.md b/specification/storage/data-plane/readme.nodejs.md similarity index 100% rename from specification/storage/data-plane/Microsoft.StorageDataLake/readme.nodejs.md rename to specification/storage/data-plane/readme.nodejs.md diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md b/specification/storage/data-plane/readme.typescript.md similarity index 100% rename from specification/storage/data-plane/Microsoft.StorageDataLake/readme.typescript.md rename to specification/storage/data-plane/readme.typescript.md From a6c90a8e101bc22b61a88a653f5e19e34e96fbca Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:31:18 -0500 Subject: [PATCH 275/464] fix: NetworkWatcherConnectivityCheck examples (#4645) - Remove trailing comma - VirtualNetwor -> VirtualNetwork --- .../2017-06-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2017-08-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2017-09-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2017-10-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2017-11-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-01-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-02-01/examples/NetworkWatcherConnectivityCheck.json | 4 ++-- .../2018-04-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-06-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-07-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-08-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- .../2018-10-01/examples/NetworkWatcherConnectivityCheck.json | 2 +- 12 files changed, 13 insertions(+), 13 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherConnectivityCheck.json index 4bc11bc672e3..374eb8ddcb07 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherConnectivityCheck.json @@ -61,7 +61,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherConnectivityCheck.json index ec837c0c9c91..a93bd5860542 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherConnectivityCheck.json @@ -61,7 +61,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherConnectivityCheck.json index bc34f7e48e7e..84dec5f0fa08 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherConnectivityCheck.json @@ -61,7 +61,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherConnectivityCheck.json index 56a6052af7c6..4e1ddbef8f6a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherConnectivityCheck.json @@ -61,7 +61,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/examples/NetworkWatcherConnectivityCheck.json index 050e1504ec8f..e7c1552e2639 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-11-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/examples/NetworkWatcherConnectivityCheck.json index 837565dd4fb3..867729a34daf 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-01-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherConnectivityCheck.json index 15a3606d50f8..8a90c2b20c4f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherConnectivityCheck.json @@ -7,7 +7,7 @@ "parameters" : { "properties" : { "source" : { - "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "resourceId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" }, "destination" : { "address" : "192.168.100.4", @@ -61,7 +61,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json index e494fa8653f2..f90e548287ae 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-04-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/examples/NetworkWatcherConnectivityCheck.json index 7b588f6431a1..4769814bcef1 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-06-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherConnectivityCheck.json index 8de3015114ac..54f190987b0d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-07-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherConnectivityCheck.json index 65a7e01f181f..da4e1fcaaa85 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-08-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json index e98fb4c19f8c..babda8d83f7e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-10-01/examples/NetworkWatcherConnectivityCheck.json @@ -59,7 +59,7 @@ "issues" : [] }, { - "type" : "VirtualNetwor", + "type" : "VirtualNetwork", "id" : "75c8d819-b208-4584-a311-1aa45ce753f9", "address" : "192.168.100.4", "resourceId" : "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", From 0857731ba14fcab36ae7162d671ba2efbebf42bf Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:32:03 -0500 Subject: [PATCH 276/464] typo: cognitiveservices/data-plane/ImageSearch (#4652) - Inisghts -> Insights --- .../data-plane/ImageSearch/stable/v1.0/ImageSearch.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json index 274f0940dc51..c318f782e172 100644 --- a/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json +++ b/specification/cognitiveservices/data-plane/ImageSearch/stable/v1.0/ImageSearch.json @@ -871,7 +871,7 @@ "type": "string" }, "insightsMetadata": { - "description": "A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInisghtsToken to get the list of websites.", + "description": "A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInsightsToken to get the list of websites.", "$ref": "#/definitions/ImagesImageMetadata", "readOnly": true }, From 40ab53799c7f576455ad8d842202914ccf21352d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:33:09 -0500 Subject: [PATCH 277/464] typo: Microsoft.ContainerRegistry (#4662) - manfests -> manifests - Everyting -> Everything - respositories -> repositories - previou -> previous - repoisotry -> repository - apline -> alpine - repoistory -> repository --- .../preview/2018-08-10/containerregistry.json | 26 +++++++++---------- .../2018-08-10/examples/GetRepositories.json | 2 +- .../containerregistry_build.json | 4 +-- .../2018-09-01/containerregistry_build.json | 10 +++---- 4 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json b/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json index 219039288eb5..406569ca5d12 100644 --- a/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json +++ b/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json @@ -11,7 +11,7 @@ "description": "Root API" }, { "name": "Manifest", - "description": "Everything about manfests" + "description": "Everything about manifests" }, { "name": "Tag", "description": "Everything about tags" @@ -20,7 +20,7 @@ "description": "Everything about layers" }, { "name": "Repository", - "description": "Everyting about repository" + "description": "Everything about repository" }, { "name": "AcrRepository", "description": "ACR APIs related to repositories" @@ -137,7 +137,7 @@ "/v2/_catalog": { "get": { "tags": ["Repository"], - "description": "List respositories", + "description": "List repositories", "operationId": "GetRepositories", "x-ms-examples": { "Get repositories in a registry": { "$ref": "./examples/GetRepositories.json" } @@ -145,7 +145,7 @@ "parameters": [{ "name": "last", "in": "query", - "description": "query parameter for the last item in previou query", + "description": "query parameter for the last item in previous query", "required": false, "type": "string" }, { @@ -174,7 +174,7 @@ "/acr/v1/_catalog": { "get": { "tags": ["AcrRepository"], - "description": "List respositories", + "description": "List repositories", "operationId": "GetAcrRepositories", "x-ms-examples": { "Get repositories in a registry": { "$ref": "./examples/GetRepositories.json" } @@ -182,7 +182,7 @@ "parameters": [{ "name": "last", "in": "query", - "description": "query parameter for the last item in previou query", + "description": "query parameter for the last item in previous query", "required": false, "type": "string" }, { @@ -211,7 +211,7 @@ "/acr/v1/{name}": { "get": { "tags": ["AcrRepository", "AcrMetadata"], - "description": "Get respository attributes", + "description": "Get repository attributes", "operationId": "GetAcrRepositoryAttributes", "x-ms-examples": { "Get details of repository": { "$ref": "./examples/GetAcrRepositoryAttributes.json" } @@ -243,7 +243,7 @@ }, "delete": { "tags": ["AcrRepository"], - "description": "Delete a respository", + "description": "Delete a repository", "operationId": "DeleteAcrRepository", "x-ms-examples": { "Delete a repository": { "$ref": "./examples/DeleteAcrRepository.json" } @@ -257,7 +257,7 @@ }], "responses": { "202": { - "description": "The repoisotry is deleted", + "description": "The repository is deleted", "schema": { "$ref": "#/definitions/DeletedRepository" } @@ -329,7 +329,7 @@ }, { "name": "last", "in": "query", - "description": "query parameter for the last item in previou query", + "description": "query parameter for the last item in previous query", "required": false, "type": "string" }, { @@ -507,7 +507,7 @@ }, { "name": "last", "in": "query", - "description": "query parameter for the last item in previou query", + "description": "query parameter for the last item in previous query", "required": false, "type": "string" }, { @@ -1180,7 +1180,7 @@ } }, "example": { - "repositories": ["production/apline", "testing/apline"] + "repositories": ["production/alpine", "testing/alpine"] } }, "DeletedRepository": { @@ -1418,7 +1418,7 @@ "queryLast": { "name": "last", "in": "query", - "description": "query parameter for the last item in previou query", + "description": "query parameter for the last item in previous query", "required": false, "type": "string", "x-ms-parameter-location": "method" diff --git a/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/examples/GetRepositories.json b/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/examples/GetRepositories.json index 97d76d07301e..86ef31bfe3c6 100644 --- a/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/examples/GetRepositories.json +++ b/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/examples/GetRepositories.json @@ -3,7 +3,7 @@ "responses": { "200": { "body": { - "repositories": ["production/apline", "testing/apline"] + "repositories": ["production/alpine", "testing/alpine"] } } } diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json index 929fd5b1270c..1cec694ac859 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2018-02-01-preview/containerregistry_build.json @@ -1561,7 +1561,7 @@ } }, "repositoryUrl": { - "description": "The full URL to the source code respository", + "description": "The full URL to the source code repository", "type": "string" }, "isCommitTriggerEnabled": { @@ -1991,7 +1991,7 @@ } }, "sourceLocation": { - "description": "The URL(absolute or relative) of the source that needs to be built. For Docker build, it can be an URL to a tar or github repoistory as supported by Docker.\r\nIf it is relative URL, the relative path should be obtained from calling getSourceUploadUrl API.", + "description": "The URL(absolute or relative) of the source that needs to be built. For Docker build, it can be an URL to a tar or github repository as supported by Docker.\r\nIf it is relative URL, the relative path should be obtained from calling getSourceUploadUrl API.", "type": "string" }, "buildArguments": { diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json index cdd6a36968d5..6ea6800444d3 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2018-09-01/containerregistry_build.json @@ -1337,7 +1337,7 @@ } }, "repositoryUrl": { - "description": "The full URL to the source code respository", + "description": "The full URL to the source code repository", "type": "string" }, "branch": { @@ -1634,7 +1634,7 @@ } }, "repositoryUrl": { - "description": "The full URL to the source code respository", + "description": "The full URL to the source code repository", "type": "string" }, "branch": { @@ -1801,7 +1801,7 @@ "description": "The machine configuration of the run agent." }, "sourceLocation": { - "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" } }, @@ -1876,7 +1876,7 @@ "description": "The machine configuration of the run agent." }, "sourceLocation": { - "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" } }, @@ -1978,7 +1978,7 @@ "description": "The machine configuration of the run agent." }, "sourceLocation": { - "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repoistory.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", + "description": "The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository.\r\nIf it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API.", "type": "string" } }, From 129d712131beef11c2c184b64de0edf1f9c62c17 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:36:06 -0500 Subject: [PATCH 278/464] typo: iothub/Microsoft.Devices (#4698) - Double word "the" - avrodeflate -> avroDeflate - Thehub -> The hub - Double word "state" - Trim trailing whitespace --- .../stable/2017-07-01/iothub.json | 46 ++++++++-------- .../stable/2018-01-22/iothub.json | 52 +++++++++---------- .../stable/2018-04-01/iothub.json | 8 +-- 3 files changed, 53 insertions(+), 53 deletions(-) diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json index c55fb844eef0..3477aa1b1c9c 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2017-07-01/iothub.json @@ -6,7 +6,7 @@ "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" ], @@ -385,7 +385,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1057,7 +1057,7 @@ "responses": { "200": { "description": "Certificate has been deleted." - }, + }, "204": { "description": "Certificate does not exist." }, @@ -1551,7 +1551,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, @@ -1703,32 +1703,32 @@ } }, "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.", + "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.", + "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.", + "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.", + "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.", + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", "type": "array", "items": { "$ref": "#/definitions/RoutingStorageContainerProperties" @@ -1761,7 +1761,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingServiceBusTopicEndpointProperties": { "description": "The properties related to service bus topic endpoint types.", @@ -1788,7 +1788,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingEventHubProperties": { "description": "The properties related to an event hub endpoint.", @@ -1815,7 +1815,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingStorageContainerProperties": { "description": "The properties related to a storage container endpoint.", @@ -1861,7 +1861,7 @@ "minimum": 10485760 }, "encoding": { - "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avrodeflate'. Default value is 'avro'.", + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.", "type": "string" } }, @@ -1869,14 +1869,14 @@ "name", "connectionString", "containerName" - ] + ] }, "RouteProperties": { - "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "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.", + "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}$" }, @@ -1890,12 +1890,12 @@ } }, "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", + "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, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -1915,11 +1915,11 @@ ] }, "FallbackRouteProperties": { - "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", "type": "object", "properties": { "source": { - "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", "enum": ["DeviceMessages"], "type": "string", "x-ms-enum": { @@ -1928,12 +1928,12 @@ } }, "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", + "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, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -1950,7 +1950,7 @@ "source", "isEnabled" ] - }, + }, "IotHubDescription": { "description": "The description of the IoT hub.", "type": "object", diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json index a2a2999804f5..701838cc7194 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-01-22/iothub.json @@ -6,7 +6,7 @@ "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" ], @@ -469,7 +469,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1186,7 +1186,7 @@ "responses": { "200": { "description": "Certificate has been deleted." - }, + }, "204": { "description": "Certificate does not exist." }, @@ -1560,7 +1560,7 @@ "readOnly": true }, "state": { - "description": "Thehub state state.", + "description": "The hub state.", "type": "string", "readOnly": true }, @@ -1690,7 +1690,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, @@ -1842,32 +1842,32 @@ } }, "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.", + "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.", + "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.", + "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.", + "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.", + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", "type": "array", "items": { "$ref": "#/definitions/RoutingStorageContainerProperties" @@ -1900,7 +1900,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingServiceBusTopicEndpointProperties": { "description": "The properties related to service bus topic endpoint types.", @@ -1927,7 +1927,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingEventHubProperties": { "description": "The properties related to an event hub endpoint.", @@ -1954,7 +1954,7 @@ "required": [ "name", "connectionString" - ] + ] }, "RoutingStorageContainerProperties": { "description": "The properties related to a storage container endpoint.", @@ -2000,7 +2000,7 @@ "minimum": 10485760 }, "encoding": { - "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avrodeflate'. Default value is 'avro'.", + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.", "type": "string" } }, @@ -2008,14 +2008,14 @@ "name", "connectionString", "containerName" - ] + ] }, "RouteProperties": { - "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "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.", + "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}$" }, @@ -2029,12 +2029,12 @@ } }, "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", + "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, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -2054,15 +2054,15 @@ ] }, "FallbackRouteProperties": { - "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "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.", + "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", + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", "enum": ["DeviceMessages"], "type": "string", "x-ms-enum": { @@ -2071,12 +2071,12 @@ } }, "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", + "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, + "minItems": 1, "maxItems": 1, "type": "array", "items": { @@ -2093,7 +2093,7 @@ "source", "isEnabled" ] - }, + }, "IotHubDescription": { "description": "The description of the IoT hub.", "type": "object", @@ -2325,7 +2325,7 @@ } }, "required": [ - "sku", + "sku", "capacity" ] }, diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json index c2014b52240c..ed9e7bc1b5d5 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2018-04-01/iothub.json @@ -511,7 +511,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1910,7 +1910,7 @@ "readOnly": true }, "state": { - "description": "Thehub state state.", + "description": "The hub state.", "type": "string", "readOnly": true }, @@ -2055,7 +2055,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, @@ -2373,7 +2373,7 @@ "minimum": 10485760 }, "encoding": { - "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avrodeflate'. Default value is 'avro'.", + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro' and 'avroDeflate'. Default value is 'avro'.", "type": "string" } }, From 038c5a31a5e3a8cf55b791be13ee557c6251c787 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:38:18 -0500 Subject: [PATCH 279/464] typo: migrate/resource-manager/Microsoft.Migrate (#4716) - Wheter -> Whether - assesment -> assessment - identiefier -> identifier - estimnate -> estimate --- .../preview/2017-11-11-preview/migrate.json | 8 ++++---- .../Microsoft.Migrate/stable/2018-02-02/migrate.json | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json index 4ea93f87f2b4..25ac2f0ad82e 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/preview/2017-11-11-preview/migrate.json @@ -591,7 +591,7 @@ "Completed", "Invalid" ], - "description": "Wheter the assessment has been created and is valid.", + "description": "Whether the assessment has been created and is valid.", "readOnly": true, "x-ms-enum": { "name": "AssessmentStatus", @@ -2375,7 +2375,7 @@ "description": "Not authorized (No access to subscription, resource group, or project)." }, "404": { - "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or assesmentName)." + "description": "Not found (Invalid subscriptionId, resourceGroupName, projectName, or assessmentName)." }, "500": { "description": "Internal Server Error." @@ -2392,7 +2392,7 @@ }, "put": { "summary": "Create or Update assessment.", - "description": "Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identiefier, if an assessment with the name provided already exists, then the existing assessment is updated.\n\nAny PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a \"InProgress\" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.\n\nWhen assessment is under computation, any PUT will lead to a 400 - Bad Request error.\n", + "description": "Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identifier, if an assessment with the name provided already exists, then the existing assessment is updated.\n\nAny PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a \"InProgress\" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.\n\nWhen assessment is under computation, any PUT will lead to a 400 - Bad Request error.\n", "operationId": "Assessments_Create", "parameters": [ { @@ -2657,7 +2657,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { "get": { "summary": "Get an assessed machine.", - "description": "Get an assessed machine with its size & cost estimnate that was evaluated in the specified assessment.", + "description": "Get an assessed machine with its size & cost estimate that was evaluated in the specified assessment.", "operationId": "AssessedMachines_Get", "parameters": [ { diff --git a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json index 0f01c742a3e7..909a08fd878a 100644 --- a/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json +++ b/specification/migrate/resource-manager/Microsoft.Migrate/stable/2018-02-02/migrate.json @@ -657,7 +657,7 @@ "Completed", "Invalid" ], - "description": "Wheter the assessment has been created and is valid.", + "description": "Whether the assessment has been created and is valid.", "readOnly": true, "x-ms-enum": { "name": "AssessmentStatus", @@ -2756,7 +2756,7 @@ }, "put": { "summary": "Create or Update assessment.", - "description": "Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identiefier, if an assessment with the name provided already exists, then the existing assessment is updated.\n\nAny PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a \"InProgress\" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.\n\nWhen assessment is under computation, any PUT will lead to a 400 - Bad Request error.\n", + "description": "Create a new assessment with the given name and the specified settings. Since name of an assessment in a project is a unique identifier, if an assessment with the name provided already exists, then the existing assessment is updated.\n\nAny PUT operation, resulting in either create or update on an assessment, will cause the assessment to go in a \"InProgress\" state. This will be indicated by the field 'computationState' on the Assessment object. During this time no other PUT operation will be allowed on that assessment object, nor will a Delete operation. Once the computation for the assessment is complete, the field 'computationState' will be updated to 'Ready', and then other PUT or DELETE operations can happen on the assessment.\n\nWhen assessment is under computation, any PUT will lead to a 400 - Bad Request error.\n", "operationId": "Assessments_Create", "parameters": [ { @@ -2994,7 +2994,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/projects/{projectName}/groups/{groupName}/assessments/{assessmentName}/assessedMachines/{assessedMachineName}": { "get": { "summary": "Get an assessed machine.", - "description": "Get an assessed machine with its size & cost estimnate that was evaluated in the specified assessment.", + "description": "Get an assessed machine with its size & cost estimate that was evaluated in the specified assessment.", "operationId": "AssessedMachines_Get", "parameters": [ { From 02b05d1035fef7691492af93295fc3d96871f876 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:39:26 -0500 Subject: [PATCH 280/464] typo: recoveryservices/resource-manager/Microsoft.RecoveryServices (#4730) - polymorhpic -> polymorphic - friendlyname -> friendly name - operationss -> operations - upgradation -> upgrade --- .../stable/2016-06-01/registeredidentities.json | 4 ++-- .../Microsoft.RecoveryServices/stable/2016-06-01/vaults.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json index c255a2f2f8ac..92bd2a0d4e4f 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/registeredidentities.json @@ -247,7 +247,7 @@ "type": "object", "properties": { "authType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" }, "certificate": { @@ -256,7 +256,7 @@ "type": "string" }, "friendlyName": { - "description": "Certificate friendlyname.", + "description": "Certificate friendly name.", "type": "string" }, "issuer": { diff --git a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json index 6d377229587f..bd034da9be0d 100644 --- a/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json +++ b/specification/recoveryservices/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/vaults.json @@ -529,7 +529,7 @@ "type": "object", "properties": { "value": { - "description": "List of available operationss.", + "description": "List of available operations.", "type": "array", "items": { "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" @@ -705,7 +705,7 @@ "readOnly": true }, "triggerType": { - "description": "The way the vault upgradation was triggered.", + "description": "The way the vault upgrade was triggered.", "enum": [ "UserTriggered", "ForcedUpgrade" From 1c2a296a4dbf400ecf93e0c79d81d87304c485a4 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:40:14 -0500 Subject: [PATCH 281/464] typo: dns/Microsoft.Network (#4686) - Double word "this" - temrinating -> terminating - overwritting -> overwriting - Trim trailing whitespace --- .../preview/2015-05-04-preview/dns.json | 4 ++-- .../preview/2018-03-01-preview/dns.json | 8 ++++---- .../Microsoft.Network/stable/2016-04-01/dns.json | 6 +++--- .../Microsoft.Network/stable/2017-09-01/dns.json | 6 +++--- .../Microsoft.Network/stable/2017-10-01/dns.json | 8 ++++---- .../Microsoft.Network/stable/2018-05-01/dns.json | 14 +++++++------- 6 files changed, 23 insertions(+), 23 deletions(-) diff --git a/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json b/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json index e431b78d245d..86e9060eed14 100644 --- a/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/preview/2015-05-04-preview/dns.json @@ -657,7 +657,7 @@ "weight": { "type": "integer", "format": "int32", - "description": "Gets or sets the weight metric for this this record." + "description": "Gets or sets the weight metric for this record." }, "port": { "type": "integer", @@ -696,7 +696,7 @@ "properties": { "host": { "type": "string", - "description": "Gets or sets the domain name of the authoritative name server, without a temrinating dot." + "description": "Gets or sets the domain name of the authoritative name server, without a terminating dot." }, "email": { "type": "string", diff --git a/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json b/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json index d8b18c6139c3..ba55ab76f884 100644 --- a/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/preview/2018-03-01-preview/dns.json @@ -91,7 +91,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -210,7 +210,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -766,7 +766,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -944,7 +944,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json index 1efa3c8b8b6f..6f8516d4686e 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2016-04-01/dns.json @@ -79,7 +79,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -165,7 +165,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -523,7 +523,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json index c0fb6e878f02..26fa53a2b325 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2017-09-01/dns.json @@ -91,7 +91,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -183,7 +183,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -569,7 +569,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json index 8d9f64ca0c0c..48975103e059 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2017-10-01/dns.json @@ -91,7 +91,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" @@ -210,7 +210,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -766,7 +766,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -941,7 +941,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" diff --git a/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json b/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json index a282014e3f82..45936e311943 100644 --- a/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json +++ b/specification/dns/resource-manager/Microsoft.Network/stable/2018-05-01/dns.json @@ -95,7 +95,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -218,7 +218,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -261,7 +261,7 @@ }, "Create A recordset with alias target resource": { "$ref": "./examples/CreateOrUpdateARecordsetAlias.json" - }, + }, "Create AAAA recordset": { "$ref": "./examples/CreateOrUpdateAAAARecordset.json" }, @@ -801,7 +801,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "name": "If-None-Match", @@ -988,7 +988,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes." + "description": "The etag of the DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen etag value to prevent accidentally overwriting any concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1091,7 +1091,7 @@ "$ref": "#/definitions/DnsResourceReferenceRequest" }, "description": "Properties for dns resource reference request." - } + } ], "responses": { "200": { @@ -1105,7 +1105,7 @@ "schema": { "$ref": "#/definitions/CloudError" } - } + } }, "x-ms-examples": { "List zones by resource group": { From c1528831163ba7bd7085737c90cd3b21916fe2ee Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:52:02 -0500 Subject: [PATCH 282/464] typo: recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices (#4731) - polymorhpic -> polymorphic - managmement -> management - managemenent -> management - propertes -> properties - Encrpytion -> Encryption - specifc -> specific - operationss -> operations - DB's -> DBs - recoverypoint -> recovery point - specifcally -> specifically - encaspulates -> encapsulates - alongwith -> along with - backupengine -> backup engine - Diskspace -> Disk space - follwing -> following - potentiallty -> potentially - exteded -> extended - Exoprt -> Export - transfered -> transferred --- .../2016-06-01/recoveryservicesbackup.json | 42 +++++++------- .../stable/2016-08-10/operations.json | 2 +- .../stable/2016-12-01/bms.json | 58 +++++++++---------- .../stable/2017-07-01/bms.json | 32 +++++----- ...ExoprtJobs.json => TriggerExportJobs.json} | 0 5 files changed, 67 insertions(+), 67 deletions(-) rename specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/Common/{TriggerExoprtJobs.json => TriggerExportJobs.json} (100%) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json index 3d5a0fd0b8c1..27d809edb5a5 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-06-01/recoveryservicesbackup.json @@ -1089,7 +1089,7 @@ { "name": "$filter", "in": "query", - "description": " itemType eq { VM , FileFolder , AzureSqlDb , SQLDB , Exchange , Sharepoint , DPMUnknown } and providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and policyName eq {policyname} and containerName eq {containername} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }.", + "description": " itemType eq { VM , FileFolder , AzureSqlDb , SQLDB , Exchange , Sharepoint , DPMUnknown } and providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and policyName eq {policyName} and containerName eq {containername} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }.", "required": false, "type": "string" }, @@ -1163,7 +1163,7 @@ { "name": "$filter", "in": "query", - "description": "expand eq {extendedinfo}. This filter enables you to choose (or filter) specific items in the list of backup items.", + "description": "expand eq {extendedInfo}. This filter enables you to choose (or filter) specific items in the list of backup items.", "required": false, "type": "string" } @@ -1951,7 +1951,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is used as the discriminator for deciding between types, in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding between types, in the polymorphic chain of types.", "type": "string" } }, @@ -2090,7 +2090,7 @@ "type": "string" }, "jobType": { - "description": "This property is the discriminator for deciding between the specific types in the polymorhpic chain of types.", + "description": "This property is the discriminator for deciding between the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2118,7 +2118,7 @@ } }, "backupManagementType": { - "description": "Type of backup managmenent for the job.", + "description": "Type of backup management for the job.", "enum": [ "Invalid", "AzureIaasVM", @@ -2188,7 +2188,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is the discriminator for deciding between the specific types in the polymorhpic chain of types.", + "description": "This property is the discriminator for deciding between the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2225,7 +2225,7 @@ "type": "object", "properties": { "backupManagementType": { - "description": "The backup managemenent type.", + "description": "The backup management type.", "type": "string" }, "protectableItemType": { @@ -2310,7 +2310,7 @@ "type": "string" }, "backupManagementType": { - "description": "The backup managemenent type associated with the backup item.", + "description": "The backup management type associated with the backup item.", "enum": [ "Invalid", "AzureIaasVM", @@ -2453,7 +2453,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2495,7 +2495,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2557,7 +2557,7 @@ "type": "string" }, "backupManagementType": { - "description": "The backup managemenent type for the container.", + "description": "The backup management type for the container.", "enum": [ "Invalid", "AzureIaasVM", @@ -2581,7 +2581,7 @@ "type": "string" }, "containerType": { - "description": "The type assigned to the container. The values to use for each of these propertes are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer.", + "description": "The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer.", "type": "string", "readOnly": true }, @@ -2658,7 +2658,7 @@ "type": "integer" }, "backupManagementType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2704,7 +2704,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2715,7 +2715,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -3095,7 +3095,7 @@ "type": "object", "properties": { "schedulePolicyType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -3106,7 +3106,7 @@ "type": "object", "properties": { "retentionPolicyType": { - "description": "This property is used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property is used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -3199,7 +3199,7 @@ }, "bekDetails": { "$ref": "#/definitions/BEKDetails", - "description": "BEK is Bitlocker Encrpytion Key." + "description": "BEK is Bitlocker Encryption Key." } } }, @@ -3222,7 +3222,7 @@ } }, "BEKDetails": { - "description": "BEK is Bitlocker Encrpytion Key.", + "description": "BEK is Bitlocker Encryption Key.", "type": "object", "properties": { "secretUrl": { @@ -3397,7 +3397,7 @@ "x-ms-discriminator-value": "IaasVMILRRegistrationRequest" }, "AzureIaaSVMJob": { - "description": "The Azure IaaS VM workload-specifc job object.", + "description": "The Azure IaaS VM workload-specific job object.", "type": "object", "allOf": [ { @@ -3538,7 +3538,7 @@ } }, "DpmJob": { - "description": "The DPM workload-specifc job object.", + "description": "The DPM workload-specific job object.", "type": "object", "allOf": [ { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json index c5a189dc033a..458e5bb952b9 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/operations.json @@ -120,7 +120,7 @@ "type": "object", "properties": { "value": { - "description": "List of available operationss.", + "description": "List of available operations.", "type": "array", "items": { "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json index 65184fd3d4b2..77db7348d5d7 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/bms.json @@ -2940,12 +2940,12 @@ }, "subinquireditemcount": { "format": "int32", - "description": "For instance or AG, indicates number of DB's present", + "description": "For instance or AG, indicates number of DBs present", "type": "integer" }, "subWorkloadItemCount": { "format": "int32", - "description": "For instance or AG, indicates number of DB's to be protected", + "description": "For instance or AG, indicates number of DBs to be protected", "type": "integer" } } @@ -2981,12 +2981,12 @@ }, "subinquireditemcount": { "format": "int32", - "description": "For instance or AG, indicates number of DB's present", + "description": "For instance or AG, indicates number of DBs present", "type": "integer" }, "subprotectableitemcount": { "format": "int32", - "description": "For instance or AG, indicates number of DB's to be protected", + "description": "For instance or AG, indicates number of DBs to be protected", "type": "integer" }, "prebackupvalidation": { @@ -3465,7 +3465,7 @@ } }, "AzureWorkloadRecoveryPoint": { - "description": "Workload specific recoverypoint, specifcally encaspulates full/diff recoverypoint", + "description": "Workload specific recovery point, specifically encapsulates full/diff recovery point", "type": "object", "allOf": [ { @@ -3475,7 +3475,7 @@ "properties": { "recoveryPointTimeInUTC": { "format": "date-time", - "description": "UTC time at which recoverypoint was created", + "description": "UTC time at which recovery point was created", "type": "string" }, "type": { @@ -3569,7 +3569,7 @@ "x-ms-discriminator-value": "AzureWorkloadSAPHanaPointInTimeRestoreRequest" }, "AzureWorkloadSAPHanaRecoveryPoint": { - "description": "SAPHana specific recoverypoint, specifcally encaspulates full/diff recoverypoints", + "description": "SAPHana specific recovery point, specifically encapsulates full/diff recovery points", "type": "object", "allOf": [ { @@ -3579,7 +3579,7 @@ "properties": { "recoveryPointTimeInUTC": { "format": "date-time", - "description": "UTC time at which recoverypoint was created", + "description": "UTC time at which recovery point was created", "type": "string" }, "type": { @@ -3677,7 +3677,7 @@ "x-ms-discriminator-value": "AzureWorkloadSQLPointInTimeRestoreRequest" }, "AzureWorkloadSQLRecoveryPoint": { - "description": "SQL specific recoverypoint, specifcally encaspulates full/diff recoverypoint alongwith extended info", + "description": "SQL specific recovery point, specifically encapsulates full/diff recovery point along with extended info", "type": "object", "allOf": [ { @@ -3819,7 +3819,7 @@ }, "extendedInfo": { "$ref": "#/definitions/BackupEngineExtendedInfo", - "description": "Extended info of the backupengine" + "description": "Extended info of the backup engine" } }, "discriminator": "backupEngineType" @@ -3881,12 +3881,12 @@ }, "usedDiskSpace": { "format": "double", - "description": "Diskspace used in the backup engine.", + "description": "Disk space used in the backup engine.", "type": "number" }, "availableDiskSpace": { "format": "double", - "description": "Diskspace currently available in the backup engine.", + "description": "Disk space currently available in the backup engine.", "type": "number" }, "refreshedAt": { @@ -3909,7 +3909,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -4061,7 +4061,7 @@ } }, "BEKDetails": { - "description": "BEK is bitlocker encrpytion key.", + "description": "BEK is bitlocker encryption key.", "type": "object", "properties": { "secretUrl": { @@ -4639,7 +4639,7 @@ "type": "string" }, "protectionState": { - "description": "Protection state of the backupengine", + "description": "Protection state of the backup engine", "enum": [ "Invalid", "IRPending", @@ -5176,7 +5176,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -5263,7 +5263,7 @@ } }, "KeyAndSecretDetails": { - "description": "BEK is bitlocker key.\r\n KEK is encryption key for BEK\r\n If the VM was encrypted then we will store follwing details :\r\n 1. Secret(BEK) - Url + Backup Data + vaultId.\r\n 2. Key(KEK) - Url + Backup Data + vaultId.\r\n 3. EncryptionMechanism\r\n BEK and KEK can potentiallty have different vault ids.", + "description": "BEK is bitlocker key.\r\n KEK is encryption key for BEK\r\n If the VM was encrypted then we will store following details :\r\n 1. Secret(BEK) - Url + Backup Data + vaultId.\r\n 2. Key(KEK) - Url + Backup Data + vaultId.\r\n 3. EncryptionMechanism\r\n BEK and KEK can potentially have different vault ids.", "type": "object", "properties": { "kekDetails": { @@ -5272,7 +5272,7 @@ }, "bekDetails": { "$ref": "#/definitions/BEKDetails", - "description": "BEK is bitlocker encrpytion key." + "description": "BEK is bitlocker encryption key." }, "encryptionMechanism": { "description": "Encryption mechanism: None/ SinglePass/ DoublePass", @@ -5649,7 +5649,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -5765,7 +5765,7 @@ "type": "string" }, "backupManagementType": { - "description": "Type of backup managemenent for the container.", + "description": "Type of backup management for the container.", "enum": [ "Invalid", "AzureIaasVM", @@ -5861,7 +5861,7 @@ "type": "string" }, "backupManagementType": { - "description": "Type of backup managemenent for the backed up item.", + "description": "Type of backup management for the backed up item.", "enum": [ "Invalid", "AzureIaasVM", @@ -5963,7 +5963,7 @@ "type": "string" }, "backupManagementType": { - "description": "Type of backup managemenent for the container.", + "description": "Type of backup management for the container.", "enum": [ "Invalid", "AzureIaasVM", @@ -6062,7 +6062,7 @@ "type": "integer" }, "backupManagementType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -6090,7 +6090,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -6234,7 +6234,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -6288,7 +6288,7 @@ "type": "object", "properties": { "retentionPolicyType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -6302,7 +6302,7 @@ "type": "object", "properties": { "schedulePolicyType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -6654,7 +6654,7 @@ "type": "object", "properties": { "backupManagementType": { - "description": "Type of backup managemenent to backup an item.", + "description": "Type of backup management to backup an item.", "type": "string" }, "workloadType": { @@ -6724,7 +6724,7 @@ "type": "object", "properties": { "backupManagementType": { - "description": "Type of backup managemenent to backup an item.", + "description": "Type of backup management to backup an item.", "type": "string" }, "workloadType": { diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json index 4891adfd4d0d..05b64e835732 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/bms.json @@ -389,7 +389,7 @@ "tags": [ "JobDetails" ], - "description": "Gets exteded information associated with the job.", + "description": "Gets extended information associated with the job.", "operationId": "JobDetails_Get", "produces": [ "application/json" @@ -524,7 +524,7 @@ "x-ms-odata": "#/definitions/JobQueryObject", "x-ms-examples": { "Export Jobs": { - "$ref": "./examples/Common/TriggerExoprtJobs.json" + "$ref": "./examples/Common/TriggerExportJobs.json" } } } @@ -1094,7 +1094,7 @@ } }, "AzureIaaSVMJob": { - "description": "Azure IaaS VM workload-specifc job object.", + "description": "Azure IaaS VM workload-specific job object.", "type": "object", "allOf": [ { @@ -1218,7 +1218,7 @@ "type": "number" }, "taskExecutionDetails": { - "description": "Details about execution of the task.\r\n eg: number of bytes transfered etc", + "description": "Details about execution of the task.\r\n eg: number of bytes transferred etc", "type": "string" } } @@ -2395,7 +2395,7 @@ } }, "DpmJob": { - "description": "DPM workload-specifc job object.", + "description": "DPM workload-specific job object.", "type": "object", "allOf": [ { @@ -2525,7 +2525,7 @@ "type": "string" }, "protectionState": { - "description": "Protection state of the backupengine", + "description": "Protection state of the backup engine", "enum": [ "Invalid", "IRPending", @@ -2910,7 +2910,7 @@ "type": "string" }, "jobType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -2938,7 +2938,7 @@ } }, "backupManagementType": { - "description": "Type of backup managmenent for the job.", + "description": "Type of backup management for the job.", "enum": [ "Invalid", "AzureIaasVM", @@ -3409,7 +3409,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -3588,7 +3588,7 @@ "type": "string" }, "backupManagementType": { - "description": "Type of backup managemenent for the backed up item.", + "description": "Type of backup management for the backed up item.", "enum": [ "Invalid", "AzureIaasVM", @@ -3795,7 +3795,7 @@ "type": "string" }, "backupManagementType": { - "description": "Type of backup managemenent for the backed up item.", + "description": "Type of backup management for the backed up item.", "enum": [ "Invalid", "AzureIaasVM", @@ -3934,7 +3934,7 @@ "type": "integer" }, "backupManagementType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -4098,7 +4098,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -4138,7 +4138,7 @@ "type": "object", "properties": { "retentionPolicyType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -4152,7 +4152,7 @@ "type": "object", "properties": { "schedulePolicyType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, @@ -4369,7 +4369,7 @@ "type": "object", "properties": { "objectType": { - "description": "This property will be used as the discriminator for deciding the specific types in the polymorhpic chain of types.", + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", "type": "string" } }, diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/Common/TriggerExoprtJobs.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/Common/TriggerExportJobs.json similarity index 100% rename from specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/Common/TriggerExoprtJobs.json rename to specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2017-07-01/examples/Common/TriggerExportJobs.json From 1a66a41ea1bde833fa94bb38bb8c87a7c1ce2142 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 14:52:38 -0500 Subject: [PATCH 283/464] typo: operationsmanagement/resource-manager/Microsoft.OperationsManagement (#4725) - properites -> properties - Associatons -> Associations --- .../OperationsManagement.json | 94 +++++++++---------- 1 file changed, 47 insertions(+), 47 deletions(-) diff --git a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json index 940280561306..df75c121d42c 100644 --- a/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json +++ b/specification/operationsmanagement/resource-manager/Microsoft.OperationsManagement/preview/2015-11-01-preview/OperationsManagement.json @@ -33,7 +33,7 @@ } } }, - "paths": { + "paths": { "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.OperationsManagement/solutions/{solutionName}": { "put": { "tags": [ @@ -52,7 +52,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -101,7 +101,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/SolutionNameParameter" }, @@ -124,7 +124,7 @@ "get": { "tags": [ "Solution" - ], + ], "operationId": "Solutions_Get", "x-ms-examples": { "SolutionGet": { "$ref": "./examples/SolutionGet.json" } @@ -137,7 +137,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/SolutionNameParameter" }, @@ -165,7 +165,7 @@ "get": { "tags": [ "Solution" - ], + ], "operationId": "Solutions_ListByResourceGroup", "x-ms-examples": { "SolutionList": { "$ref": "./examples/SolutionList.json" } @@ -203,7 +203,7 @@ "get": { "tags": [ "Solution" - ], + ], "operationId": "Solutions_ListBySubscription", "x-ms-examples": { "SolutionList": { "$ref": "./examples/SolutionListForSubscription.json" } @@ -213,7 +213,7 @@ "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -238,17 +238,17 @@ "get": { "tags": [ "ManagementAssociation" - ], + ], "operationId": "ManagementAssociations_ListBySubscription", "x-ms-examples": { "SolutionList": { "$ref": "./examples/ManagementAssociationListForSubscription.json" } }, - "summary": "Retrieves the ManagementAssociatons list for the subscription", - "description": "Retrieves the ManagementAssociatons list.", + "summary": "Retrieves the ManagementAssociations list for the subscription", + "description": "Retrieves the ManagementAssociations list.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -286,7 +286,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -352,7 +352,7 @@ }, { "$ref": "#/parameters/ResourceNameParameter" - }, + }, { "$ref": "#/parameters/ManagementAssociationNameParameter" }, @@ -375,7 +375,7 @@ "get": { "tags": [ "ManagementAssociation" - ], + ], "operationId": "ManagementAssociations_Get", "x-ms-examples": { "SolutionGet": { "$ref": "./examples/ManagementAssociationGet.json" } @@ -397,7 +397,7 @@ }, { "$ref": "#/parameters/ResourceNameParameter" - }, + }, { "$ref": "#/parameters/ManagementAssociationNameParameter" }, @@ -425,7 +425,7 @@ "get": { "tags": [ "ManagementConfiguration" - ], + ], "operationId": "ManagementConfigurations_ListBySubscription", "x-ms-examples": { "SolutionList": { "$ref": "./examples/ManagementConfigurationListForSubscription.json" } @@ -435,7 +435,7 @@ "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" } @@ -473,7 +473,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/ApiVersionParameter" }, @@ -521,7 +521,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/ManagementConfigurationNameParameter" }, @@ -544,7 +544,7 @@ "get": { "tags": [ "ManagementConfiguration" - ], + ], "operationId": "ManagementConfigurations_Get", "x-ms-examples": { "SolutionGet": { "$ref": "./examples/ManagementConfigurationGet.json" } @@ -557,7 +557,7 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" - }, + }, { "$ref": "#/parameters/ManagementConfigurationNameParameter" }, @@ -607,7 +607,7 @@ "x-ms-pageable": { "nextLinkName": null } - } + } } }, "definitions": { @@ -624,7 +624,7 @@ } }, "Operation": { - "description": "Supported operation of OperationsManagement resource provider.", + "description": "Supported operation of OperationsManagement resource provider.", "properties": { "name": { "description": "Operation name: {provider}/{resource}/{operation}", @@ -667,7 +667,7 @@ "type":"string", "description":"the azure resourceId of the resource." }, - "description": "The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted." + "description": "The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted." }, "referencedResources": { "type": "array", @@ -675,7 +675,7 @@ "type":"string", "description":"the azure resourceId of the resource." }, - "description": "The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution." + "description": "The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution." } }, "required": [ @@ -689,7 +689,7 @@ "applicationId": { "type": "string", "description": "The applicationId of the appliance for this association." - } + } }, "required": [ "applicationId" @@ -738,7 +738,7 @@ "items":{ "$ref":"#/definitions/Solution" }, - "description":"List of solution properites within the subscription." + "description":"List of solution properties within the subscription." } }, "description":"the list of solution response" @@ -750,7 +750,7 @@ "items":{ "$ref":"#/definitions/ManagementAssociation" }, - "description":"List of Management Association properites within the subscription." + "description":"List of Management Association properties within the subscription." } }, "description":"the list of ManagementAssociation response" @@ -762,7 +762,7 @@ "items":{ "$ref":"#/definitions/ManagementConfiguration" }, - "description":"List of Management Configuration properites within the subscription." + "description":"List of Management Configuration properties within the subscription." } }, "description":"the list of ManagementConfiguration response" @@ -810,14 +810,14 @@ "description": "Resource location" }, "plan":{ - "description": "Plan for solution object supported by the OperationsManagement resource provider.", + "description": "Plan for solution object supported by the OperationsManagement resource provider.", "$ref":"#/definitions/SolutionPlan" }, "properties": { - "description": "Properties for solution object supported by the OperationsManagement resource provider.", - "$ref": "#/definitions/SolutionProperties" - } - }, + "description": "Properties for solution object supported by the OperationsManagement resource provider.", + "$ref": "#/definitions/SolutionProperties" + } + }, "description": "The container for solution.", "x-ms-azure-resource": true }, @@ -841,12 +841,12 @@ "location": { "type": "string", "description": "Resource location" - }, + }, "properties": { - "description": "Properties for ManagementAssociation object supported by the OperationsManagement resource provider.", - "$ref": "#/definitions/ManagementAssociationProperties" - } - }, + "description": "Properties for ManagementAssociation object supported by the OperationsManagement resource provider.", + "$ref": "#/definitions/ManagementAssociationProperties" + } + }, "description": "The container for solution.", "x-ms-azure-resource": true }, @@ -870,12 +870,12 @@ "location": { "type": "string", "description": "Resource location" - }, + }, "properties": { - "description": "Properties for ManagementConfiguration object supported by the OperationsManagement resource provider.", - "$ref": "#/definitions/ManagementConfigurationProperties" - } - }, + "description": "Properties for ManagementConfiguration object supported by the OperationsManagement resource provider.", + "$ref": "#/definitions/ManagementConfigurationProperties" + } + }, "description": "The container for solution.", "x-ms-azure-resource": true }, @@ -910,7 +910,7 @@ } }, "description": "The error body contract." - } + } }, "parameters": { "SubscriptionIdParameter": { @@ -985,6 +985,6 @@ "type": "string", "description": "Parent resource name.", "x-ms-parameter-location": "client" - } + } } } \ No newline at end of file From 8d501e68d59e12fb735a0dbff68abec3fa3e65ee Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 16:12:30 -0500 Subject: [PATCH 284/464] fix: Rename applicationinsights/data-plane/Microsoft.Insights (#4736) * fix: Rename applicationinsights/data-plane/Microsoft.Insights Folders in the repo use uppercase for the namespace * fix: Casing on applicationinsights/data-plane/Microsoft.Insights YAML --- .../preview/2018-04-20/examples/events-get-by-id.json | 0 .../preview/2018-04-20/examples/events-get-by-type.json | 0 .../preview/2018-04-20/examples/events-get-metadata.json | 0 .../preview/2018-04-20/examples/metric-get-full.json | 0 .../preview/2018-04-20/examples/metric-get-segmented.json | 0 .../preview/2018-04-20/examples/metric-get.json | 0 .../preview/2018-04-20/examples/metric-post.json | 0 .../preview/2018-04-20/examples/metrics-get-metadata.json | 0 .../preview/2018-04-20/examples/query-get.json | 0 .../preview/2018-04-20/examples/query-post.json | 0 .../preview/2018-04-20/swagger.json | 0 .../preview/v1/AppInsights.json | 0 .../preview/v1/examples/events-get-by-id.json | 0 .../preview/v1/examples/events-get-by-type.json | 0 .../preview/v1/examples/events-get-metadata.json | 0 .../preview/v1/examples/metric-get-custom.json | 0 .../preview/v1/examples/metric-get-full.json | 0 .../preview/v1/examples/metric-get-segmented.json | 0 .../preview/v1/examples/metric-get.json | 0 .../preview/v1/examples/metric-post.json | 0 .../preview/v1/examples/metrics-get-metadata.json | 0 .../preview/v1/examples/query-get.json | 0 .../preview/v1/examples/query-post.json | 0 .../preview/v1/examples/query-schema.json | 0 specification/applicationinsights/data-plane/readme.md | 4 ++-- 25 files changed, 2 insertions(+), 2 deletions(-) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/events-get-by-id.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/events-get-by-type.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/events-get-metadata.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/metric-get-full.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/metric-get-segmented.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/metric-get.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/metric-post.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/metrics-get-metadata.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/query-get.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/examples/query-post.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/2018-04-20/swagger.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/AppInsights.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/events-get-by-id.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/events-get-by-type.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/events-get-metadata.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metric-get-custom.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metric-get-full.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metric-get-segmented.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metric-get.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metric-post.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/metrics-get-metadata.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/query-get.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/query-post.json (100%) rename specification/applicationinsights/data-plane/{microsoft.insights => Microsoft.Insights}/preview/v1/examples/query-schema.json (100%) diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-by-id.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-id.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-by-id.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-by-type.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-by-type.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-by-type.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/events-get-metadata.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/events-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-full.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get-full.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-full.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get-full.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get-segmented.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get-segmented.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get-segmented.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-get.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-post.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metric-post.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metric-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metrics-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/metrics-get-metadata.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/metrics-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-get.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/query-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-get.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/query-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-post.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/query-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/examples/query-post.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/examples/query-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/2018-04-20/swagger.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/2018-04-20/swagger.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/AppInsights.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/AppInsights.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-by-id.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-id.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-by-id.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-by-type.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-by-type.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-by-type.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/events-get-metadata.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/events-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-custom.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-custom.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-custom.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-custom.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-full.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-full.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-full.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-full.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-segmented.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get-segmented.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get-segmented.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-get.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-post.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metric-post.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metric-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metrics-get-metadata.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/metrics-get-metadata.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/metrics-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-get.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-get.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-get.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-get.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-post.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-post.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-post.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-post.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json b/specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-schema.json similarity index 100% rename from specification/applicationinsights/data-plane/microsoft.insights/preview/v1/examples/query-schema.json rename to specification/applicationinsights/data-plane/Microsoft.Insights/preview/v1/examples/query-schema.json diff --git a/specification/applicationinsights/data-plane/readme.md b/specification/applicationinsights/data-plane/readme.md index 93ef606c3be4..b17075b1923f 100644 --- a/specification/applicationinsights/data-plane/readme.md +++ b/specification/applicationinsights/data-plane/readme.md @@ -37,7 +37,7 @@ These settings apply only when `--tag=v1` is specified on the command line. ``` yaml $(tag) == 'v1' input-file: -- microsoft.insights/preview/v1/AppInsights.json +- Microsoft.Insights/preview/v1/AppInsights.json directive: - reason: Don't expose the GET endpoint since it's behavior is more limited than POST remove-operation: Query_Get @@ -48,7 +48,7 @@ directive: ``` yaml $(tag) == '20180420' input-file: -- microsoft.insights/preview/2018-04-20/swagger.json +- Microsoft.Insights/preview/2018-04-20/swagger.json directive: - reason: Don't expose the GET endpoint since it's behavior is more limited than POST remove-operation: Query_Get From 999c9d3811d8a24e734d18bf98108178a184f0a2 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:22:10 -0500 Subject: [PATCH 285/464] fix: Microsoft.Relay\stable\2017-04-01\examples (#4646) - "rights" is supposed to be an array - right -> rights - "path" was null in the previous version and a ":," isn't valid json --- .../RelayHybridConnectionAuthorizationRuleUpdate.json | 8 +++----- .../NameSpaces/RelayNameSpaceAuthorizationRuleUpdate.json | 8 +++----- .../examples/Relay/RelayAuthorizationRuleUpdate.json | 8 +++----- .../stable/2017-04-01/examples/Relay/RelayUpdate.json | 2 +- 4 files changed, 10 insertions(+), 16 deletions(-) diff --git a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/HybridConnection/RelayHybridConnectionAuthorizationRuleUpdate.json b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/HybridConnection/RelayHybridConnectionAuthorizationRuleUpdate.json index b1f23d0dc867..c120d2b46e45 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/HybridConnection/RelayHybridConnectionAuthorizationRuleUpdate.json +++ b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/HybridConnection/RelayHybridConnectionAuthorizationRuleUpdate.json @@ -9,11 +9,9 @@ "parameters": { "location": "West US", "properties": { - "right": { - [ - "Listen" - ] - } + "rights": [ + "Listen" + ] } } }, diff --git a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceAuthorizationRuleUpdate.json b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceAuthorizationRuleUpdate.json index 174701e217ae..29781a0a975b 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceAuthorizationRuleUpdate.json +++ b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/NameSpaces/RelayNameSpaceAuthorizationRuleUpdate.json @@ -7,11 +7,9 @@ "subscriptionId": "8c246e6a-cbc6-4a87-aff1-d6a886f376ef", "parameters": { "properties": { - "rights": { - [ - "Listen" - ] - } + "rights": [ + "Listen" + ] } } }, diff --git a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayAuthorizationRuleUpdate.json b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayAuthorizationRuleUpdate.json index 1e01ecef237d..879f38238918 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayAuthorizationRuleUpdate.json +++ b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayAuthorizationRuleUpdate.json @@ -8,11 +8,9 @@ "subscriptionId": "8c246e6a-cbc6-4a87-aff1-d6a886f376ef", "parameters": { "properties": { - "right": { - [ - "Listen" - ] - } + "rights": [ + "Listen" + ] } } }, diff --git a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayUpdate.json b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayUpdate.json index 7c80a46e34c1..5e6299c10058 100644 --- a/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayUpdate.json +++ b/specification/relay/resource-manager/Microsoft.Relay/stable/2017-04-01/examples/Relay/RelayUpdate.json @@ -22,7 +22,7 @@ "name": "sdk-Relay-Wcf-01", "type": "Microsoft.Relay/Namespaces/WcfRelays", "properties": { - "path":, + "path": null, "createdAt": "2017-01-24T00:46:27.0049983Z", "updatedAt": "2017-01-24T00:46:27.0049983Z", "relayType": "NetTcp", From ab8272eba6a82529997abba58f375695d3b26581 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:22:56 -0500 Subject: [PATCH 286/464] typo: cognitiveservices/data-plane/QnAMaker (#4653) - knowlegebases -> knowledgebases --- .../data-plane/QnAMaker/stable/v4.0/QnAMaker.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json index a2e196d6f592..90cc08585a4d 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/QnAMaker.json @@ -186,7 +186,7 @@ ], "responses": { "200": { - "description": "Collection of knowlegebases.", + "description": "Collection of knowledgebases.", "schema": { "$ref": "#/definitions/KnowledgebasesDTO" }, @@ -663,7 +663,7 @@ }, "add": { "type": "array", - "description": "List of Metadat associated with answer to be added", + "description": "List of metadata associated with answer to be added", "maxLength": 100, "items": { "$ref": "#/definitions/MetadataDTO" From 86a89cd48ae84895a71619bf1fa8fc7d400f91cc Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:23:22 -0500 Subject: [PATCH 287/464] typo: Microsoft.ConainterInstance (#4661) - contaienr -> container --- .../stable/2018-06-01/containerInstance.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json index e51d70f2cee9..7c31befc1ae5 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-06-01/containerInstance.json @@ -268,7 +268,7 @@ } }, "summary": "Restarts all containers in a container group.", - "description": "Restarts all containers in a contaienr group in place. If container image has updates, new image will be downloaded.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" @@ -300,7 +300,7 @@ } }, "summary": "Stops all containers in a container group.", - "description": "Stops all containers in a contaienr group. Compute resources will be deallocated and billing will stop.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", "parameters": [ { "$ref": "#/parameters/SubscriptionIdParameter" From 0c886c7cfb314ba0dc9cf3404b9812ff4a848490 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:23:52 -0500 Subject: [PATCH 288/464] typo: Microsoft.Media (#4687) - Double word "event" --- .../Microsoft.Media/stable/2018-01-01/MediaServices.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json index 41e7886333ec..a54eea59dffe 100644 --- a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json @@ -830,7 +830,7 @@ } }, "type": "object", - "description": "Ingest fragment dropped event event data." + "description": "Ingest fragment dropped event data." }, "MediaLiveEventIngestHeartbeatEventData": { "properties": { @@ -901,7 +901,7 @@ } }, "type": "object", - "description": "Ingest fragment dropped event event data." + "description": "Ingest fragment dropped event data." }, "MediaLiveEventTrackDiscontinuityDetectedEventData": { "properties": { From 8f89f68b2fa5fa484507e27c81b6964919b52d8f Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:25:26 -0500 Subject: [PATCH 289/464] typo: data-plane/Microsoft.KeyVault (#4700) - workign -> working - renawal -> renewal - encypt -> encrypt - Setsecret -> SetSecret - ceritifcate -> certificate - addresss -> address - defintions -> definitions - priveleged -> privileged --- .../Microsoft.KeyVault/preview/7.0/index.md | 4 ++-- .../Microsoft.KeyVault/preview/7.0/keyvault.json | 12 ++++++------ .../stable/2015-06-01/keyvault.json | 6 +++--- .../stable/2016-10-01/index.md | 4 ++-- .../stable/2016-10-01/keyvault.json | 16 ++++++++-------- .../Microsoft.KeyVault/stable/7.0/index.md | 4 ++-- .../Microsoft.KeyVault/stable/7.0/keyvault.json | 12 ++++++------ 7 files changed, 29 insertions(+), 29 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/index.md index d65bfa10917e..ec4122cc584f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/index.md +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/index.md @@ -11,7 +11,7 @@ ms.manager: mbaldwin # Azure Key Vault -Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and workign with a range of certificate authorities. +Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and working with a range of certificate authorities. ## REST Operation Groups @@ -20,7 +20,7 @@ Azure Key Vault enables users to store and use cryptographic keys within the Mic |-----------------|-------------| |Keys | Operations for interacting with keys including create, import, update, and delete.| |Secrets | Operations for interacting with secrets including create, update, and delete.| -|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renawal management tasks.| +|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renewal management tasks.| |Storage | Operations for interacting with storage accounts including create, read, update, delete, list, regeneratekey and a set of sas definition related tasks.| ## See Also diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json index f50706a58982..4ec608b0acf6 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json @@ -467,7 +467,7 @@ ], "operationId": "encrypt", "summary": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.", - "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encypt permission.", + "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.", "parameters": [ { "name": "key-name", @@ -1019,7 +1019,7 @@ } }, "x-ms-examples": { - "Setsecret": { + "SetSecret": { "$ref": "./examples//SetSecret-example.json" } } @@ -4472,7 +4472,7 @@ "type": "integer", "format": "int32", "minimum": 0, - "description": "The duration that the ceritifcate is valid in months." + "description": "The duration that the certificate is valid in months." } }, "description": "Properties of the X509 component of a certificate." @@ -4657,7 +4657,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "phone": { "type": "string", @@ -4689,7 +4689,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "name": { "type": "string", @@ -5778,7 +5778,7 @@ "nextLink": { "type": "string", "readOnly": true, - "description": "The URL to get the next set of SAS defintions." + "description": "The URL to get the next set of SAS definitions." } }, "description": "The storage account SAS definition list result." diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json index 46802fea6fdd..82f07dc5824c 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2015-06-01/keyvault.json @@ -2299,7 +2299,7 @@ "type": "integer", "format": "int32", "minimum": 0, - "description": "The duration that the ceritifcate is valid in months." + "description": "The duration that the certificate is valid in months." } }, "description": "Properties of the X509 component of a certificate." @@ -2479,7 +2479,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "phone": { "type": "string", @@ -2511,7 +2511,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "name": { "type": "string", diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/index.md index d65bfa10917e..ec4122cc584f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/index.md +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/index.md @@ -11,7 +11,7 @@ ms.manager: mbaldwin # Azure Key Vault -Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and workign with a range of certificate authorities. +Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and working with a range of certificate authorities. ## REST Operation Groups @@ -20,7 +20,7 @@ Azure Key Vault enables users to store and use cryptographic keys within the Mic |-----------------|-------------| |Keys | Operations for interacting with keys including create, import, update, and delete.| |Secrets | Operations for interacting with secrets including create, update, and delete.| -|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renawal management tasks.| +|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renewal management tasks.| |Storage | Operations for interacting with storage accounts including create, read, update, delete, list, regeneratekey and a set of sas definition related tasks.| ## See Also diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json index c966bc6e254e..3a6f634db080 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/2016-10-01/keyvault.json @@ -422,7 +422,7 @@ ], "operationId": "encrypt", "summary": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.", - "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encypt permission.", + "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.", "parameters": [ { "name": "key-name", @@ -1363,7 +1363,7 @@ } } } - }, + }, "/certificates": { "get": { "tags": [ @@ -3066,7 +3066,7 @@ }, { "value": "Recoverable+Purgeable", - "description": "Soft-delete is enabled for this vault; A priveleged user may trigger an immediate, irreversible deletion(purge) of a deleted entity." + "description": "Soft-delete is enabled for this vault; A privileged user may trigger an immediate, irreversible deletion(purge) of a deleted entity." }, { "value": "Recoverable", @@ -3654,7 +3654,7 @@ "type": "integer", "format": "int32", "minimum": 0, - "description": "The duration that the ceritifcate is valid in months." + "description": "The duration that the certificate is valid in months." } }, "description": "Properties of the X509 component of a certificate." @@ -3834,7 +3834,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "phone": { "type": "string", @@ -3866,7 +3866,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "name": { "type": "string", @@ -4448,7 +4448,7 @@ } }, "description": "The backup secret result, containing the backup blob." - }, + }, "PendingCertificateSigningRequestResult": { "properties": { "value": { @@ -4742,7 +4742,7 @@ "nextLink": { "type": "string", "readOnly": true, - "description": "The URL to get the next set of SAS defintions." + "description": "The URL to get the next set of SAS definitions." } }, "description": "The storage account SAS definition list result." diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md index d65bfa10917e..ec4122cc584f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/index.md @@ -11,7 +11,7 @@ ms.manager: mbaldwin # Azure Key Vault -Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and workign with a range of certificate authorities. +Azure Key Vault enables users to store and use cryptographic keys within the Microsoft Azure environment. Azure Key Vault supports multiple key types and algorithms, and enables the use of Hardware Security Modules (HSM) for high value customer keys. Key Vault also supports storage of secrets, limited size octet objects. Certificate management is also available through Key Vault including support for renewal processing and working with a range of certificate authorities. ## REST Operation Groups @@ -20,7 +20,7 @@ Azure Key Vault enables users to store and use cryptographic keys within the Mic |-----------------|-------------| |Keys | Operations for interacting with keys including create, import, update, and delete.| |Secrets | Operations for interacting with secrets including create, update, and delete.| -|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renawal management tasks.| +|Certificates | Operations for interacting with certificates including create, import, update, delete and a set of contact and renewal management tasks.| |Storage | Operations for interacting with storage accounts including create, read, update, delete, list, regeneratekey and a set of sas definition related tasks.| ## See Also diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json index 1ce1520f2a45..133f7657c859 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json @@ -467,7 +467,7 @@ ], "operationId": "encrypt", "summary": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.", - "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encypt permission.", + "description": "The ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only supports a single block of data, the size of which is dependent on the target key and the encryption algorithm to be used. The ENCRYPT operation is only strictly necessary for symmetric keys stored in Azure Key Vault since protection with an asymmetric key can be performed using public portion of the key. This operation is supported for asymmetric keys as a convenience for callers that have a key-reference but do not have access to the public key material. This operation requires the keys/encrypt permission.", "parameters": [ { "name": "key-name", @@ -1019,7 +1019,7 @@ } }, "x-ms-examples": { - "Setsecret": { + "SetSecret": { "$ref": "./examples//SetSecret-example.json" } } @@ -4472,7 +4472,7 @@ "type": "integer", "format": "int32", "minimum": 0, - "description": "The duration that the ceritifcate is valid in months." + "description": "The duration that the certificate is valid in months." } }, "description": "Properties of the X509 component of a certificate." @@ -4657,7 +4657,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "phone": { "type": "string", @@ -4689,7 +4689,7 @@ "email": { "x-ms-client-name": "EmailAddress", "type": "string", - "description": "Email addresss." + "description": "Email address." }, "name": { "type": "string", @@ -5778,7 +5778,7 @@ "nextLink": { "type": "string", "readOnly": true, - "description": "The URL to get the next set of SAS defintions." + "description": "The URL to get the next set of SAS definitions." } }, "description": "The storage account SAS definition list result." From 69e6bf088e5c4091a08c4f8fa6e186e230ad2622 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:25:54 -0500 Subject: [PATCH 290/464] typo: mariadb/resource-manager/Microsoft.DBforMariaDB (#4710) - allowd -> allowed - Trim trailing spaces --- .../preview/2018-06-01-preview/mariadb.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json index 8997bd3b1c8c..546d4a7d2886 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json @@ -47,8 +47,8 @@ "Create a database as a point in time restore":{ "$ref":"./examples/ServerCreatePointInTimeRestore.json" }, - "Create a server as a geo restore ": { - "$ref": "./examples/ServerCreateGeoRestoreMode.json" + "Create a server as a geo restore ": { + "$ref": "./examples/ServerCreateGeoRestoreMode.json" } }, "description": "Creates a new server or updates an existing server. The update action will overwrite the existing server.", @@ -1452,7 +1452,7 @@ "sourceServerId" ], "description": "The properties used to create a new server by restoring to a different region from a geo replicated backup." - }, + }, "Sku": { "properties": { "name": { @@ -1574,7 +1574,7 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Parameters allowd to update for a server." + "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { From d07f776d61fb7c93ce05214b44a2543a7b6a1fc3 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 17:27:29 -0500 Subject: [PATCH 291/464] typo: netapp/resource-manager/Microsoft.NetApp (#4719) - possiblly -> possibly - targets's -> target's --- .../Microsoft.NetApp/preview/2017-08-15/netapp.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json index e7392ca8f979..ce4eac947bfd 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json @@ -1004,7 +1004,7 @@ } }, "Dimension": { - "description": "Dimension of blobs, possiblly be blob type or access tier.", + "description": "Dimension of blobs, possibly be blob type or access tier.", "properties": { "name": { "type": "string", @@ -1546,7 +1546,7 @@ }, "ipAddress": { "title": "ipAddress", - "description": "The mount targets's IPv4 address", + "description": "The mount target's IPv4 address", "type": "string", "readOnly": true, "example": "1.2.3.4" From 02af72649b779a5ff87b6e258e393b16b5417c35 Mon Sep 17 00:00:00 2001 From: Ian Hays Date: Mon, 3 Dec 2018 14:42:17 -0800 Subject: [PATCH 292/464] Add first GA LabServices API (#4621) * Add first GA LabServices API * Add Example for Labs_List * Update specification/labservices/resource-manager/readme.nodejs.md Co-Authored-By: ianhays * Update specification/labservices/resource-manager/readme.typescript.md Co-Authored-By: ianhays * Update specification/labservices/resource-manager/readme.typescript.md Co-Authored-By: ianhays --- .../stable/2018-10-15/ML.json | 4360 +++++++++++++++++ .../stable/2018-10-15/examples/Labs_List.json | 60 + .../labservices/resource-manager/readme.go.md | 27 + .../labservices/resource-manager/readme.md | 144 + .../resource-manager/readme.nodejs.md | 14 + .../resource-manager/readme.ruby.md | 26 + .../resource-manager/readme.typescript.md | 12 + 7 files changed, 4643 insertions(+) create mode 100644 specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json create mode 100644 specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/examples/Labs_List.json create mode 100644 specification/labservices/resource-manager/readme.go.md create mode 100644 specification/labservices/resource-manager/readme.md create mode 100644 specification/labservices/resource-manager/readme.nodejs.md create mode 100644 specification/labservices/resource-manager/readme.ruby.md create mode 100644 specification/labservices/resource-manager/readme.typescript.md diff --git a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json new file mode 100644 index 000000000000..22df8e02e8c8 --- /dev/null +++ b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json @@ -0,0 +1,4360 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-10-15", + "title": "ManagedLabsClient", + "description": "The Managed Labs Client." + }, + "host": "management.azure.com", + "schemes": [ "https" ], + "consumes": [ "application/json" ], + "produces": [ "application/json" ], + "paths": { + "/providers/Microsoft.LabServices/operations": { + "get": { + "tags": [ "ProviderOperations" ], + "description": "Result of the request to list REST API operations", + "operationId": "ProviderOperations_List", + "parameters": [ { "$ref": "#/parameters/api-version" } ], + "responses": { + "200": { + "description": "Success", + "schema": { "$ref": "#/definitions/ProviderOperationResult" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" } + } + }, + "/providers/Microsoft.LabServices/users/{userName}/getEnvironment": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Gets the virtual machine details", + "operationId": "GlobalUsers_GetEnvironment", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "environmentOperationsPayload", + "in": "body", + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentOperationsPayload" } + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=environment)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GetEnvironmentResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/getOperationBatchStatus": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Get batch operation status", + "operationId": "GlobalUsers_GetOperationBatchStatus", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "operationBatchStatusPayload", + "in": "body", + "description": "Payload to get the status of an operation", + "required": true, + "schema": { "$ref": "#/definitions/OperationBatchStatusPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationBatchStatusResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/getOperationStatus": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Gets the status of long running operation", + "operationId": "GlobalUsers_GetOperationStatus", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "operationStatusPayload", + "in": "body", + "description": "Payload to get the status of an operation", + "required": true, + "schema": { "$ref": "#/definitions/OperationStatusPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationStatusResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/getPersonalPreferences": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Get personal preferences for a user", + "operationId": "GlobalUsers_GetPersonalPreferences", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "personalPerferencesOperationsPayload", + "in": "body", + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "required": true, + "schema": { "$ref": "#/definitions/PersonalPerferencesOperationsPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GetPersonalPreferencesResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/listEnvironments": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "List Environments for the user", + "operationId": "GlobalUsers_ListEnvironments", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "listEnvironmentsPayload", + "in": "body", + "description": "Represents the payload to list environments owned by a user", + "required": true, + "schema": { "$ref": "#/definitions/ListEnvironmentsPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ListEnvironmentsResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/listLabs": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "List labs for the user.", + "operationId": "GlobalUsers_ListLabs", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ListLabsResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/register": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Register a user to a managed lab", + "operationId": "GlobalUsers_Register", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "registerPayload", + "in": "body", + "description": "Represents payload for Register action.", + "required": true, + "schema": { "$ref": "#/definitions/RegisterPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/providers/Microsoft.LabServices/users/{userName}/resetPassword": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Resets the user password on an environment This operation can take a while to complete", + "operationId": "GlobalUsers_ResetPassword", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "resetPasswordPayload", + "in": "body", + "description": "Represents the payload for resetting passwords.", + "required": true, + "schema": { "$ref": "#/definitions/ResetPasswordPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.LabServices/users/{userName}/startEnvironment": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Starts an environment by starting all resources inside the environment. This operation can take a while to complete", + "operationId": "GlobalUsers_StartEnvironment", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "environmentOperationsPayload", + "in": "body", + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentOperationsPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.LabServices/users/{userName}/stopEnvironment": { + "post": { + "tags": [ "GlobalUsers" ], + "description": "Stops an environment by stopping all resources inside the environment This operation can take a while to complete", + "operationId": "GlobalUsers_StopEnvironment", + "parameters": [ + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "environmentOperationsPayload", + "in": "body", + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentOperationsPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LabServices/labaccounts": { + "get": { + "tags": [ "LabAccounts" ], + "description": "List lab accounts in a subscription.", + "operationId": "LabAccounts_ListBySubscription", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=sizeConfiguration)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabAccount]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/LabAccount" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.LabServices/locations/{locationName}/operations/{operationName}": { + "get": { + "tags": [ "Operations" ], + "description": "Get operation", + "operationId": "Operations_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/locationName" }, + { + "name": "operationName", + "in": "path", + "description": "The name of the operation.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/OperationResult" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts": { + "get": { + "tags": [ "LabAccounts" ], + "description": "List lab accounts in a resource group.", + "operationId": "LabAccounts_ListByResourceGroup", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=sizeConfiguration)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[LabAccount]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/LabAccount" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}": { + "get": { + "tags": [ "LabAccounts" ], + "description": "Get lab account", + "operationId": "LabAccounts_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=sizeConfiguration)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabAccount" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "LabAccounts" ], + "description": "Create or replace an existing Lab Account.", + "operationId": "LabAccounts_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labAccount", + "in": "body", + "description": "Represents a lab account.", + "required": true, + "schema": { "$ref": "#/definitions/LabAccount" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabAccount" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/LabAccount" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "LabAccounts" ], + "description": "Delete lab account. This operation can take a while to complete", + "operationId": "LabAccounts_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "LabAccounts" ], + "description": "Modify properties of lab accounts.", + "operationId": "LabAccounts_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labAccount", + "in": "body", + "description": "Represents a lab account.", + "required": true, + "schema": { "$ref": "#/definitions/LabAccountFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/LabAccount" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/createLab": { + "post": { + "tags": [ "LabAccounts" ], + "description": "Create a lab in a lab account.", + "operationId": "LabAccounts_CreateLab", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "createLabProperties", + "in": "body", + "description": "Properties for creating a managed lab and a default environment setting", + "required": true, + "schema": { "$ref": "#/definitions/CreateLabProperties" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages": { + "get": { + "tags": [ "GalleryImages" ], + "description": "List gallery images in a given lab account.", + "operationId": "GalleryImages_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=author)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[GalleryImage]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/GalleryImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/galleryimages/{galleryImageName}": { + "get": { + "tags": [ "GalleryImages" ], + "description": "Get gallery image", + "operationId": "GalleryImages_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "The name of the gallery Image.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=author)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GalleryImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "GalleryImages" ], + "description": "Create or replace an existing Gallery Image.", + "operationId": "GalleryImages_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "The name of the gallery Image.", + "required": true, + "type": "string" + }, + { + "name": "galleryImage", + "in": "body", + "description": "Represents an image from the Azure Marketplace", + "required": true, + "schema": { "$ref": "#/definitions/GalleryImage" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GalleryImage" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/GalleryImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "GalleryImages" ], + "description": "Delete gallery image.", + "operationId": "GalleryImages_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "The name of the gallery Image.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "patch": { + "tags": [ "GalleryImages" ], + "description": "Modify properties of gallery images.", + "operationId": "GalleryImages_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "galleryImageName", + "in": "path", + "description": "The name of the gallery Image.", + "required": true, + "type": "string" + }, + { + "name": "galleryImage", + "in": "body", + "description": "Represents an image from the Azure Marketplace", + "required": true, + "schema": { "$ref": "#/definitions/GalleryImageFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GalleryImage" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/getRegionalAvailability": { + "post": { + "tags": [ "LabAccounts" ], + "description": "Get regional availability information for each size category configured under a lab account", + "operationId": "LabAccounts_GetRegionalAvailability", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/GetRegionalAvailabilityResponse" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs": { + "get": { + "tags": [ "Labs" ], + "description": "List labs in a given lab account.", + "operationId": "Labs_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=maxUsersInLab)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Lab]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Lab", + "x-ms-examples": { "Labs_List": { "$ref": "./examples/Labs_List.json" } } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}": { + "get": { + "tags": [ "Labs" ], + "description": "Get lab", + "operationId": "Labs_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=maxUsersInLab)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Labs" ], + "description": "Create or replace an existing Lab.", + "operationId": "Labs_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "Represents a lab.", + "required": true, + "schema": { "$ref": "#/definitions/Lab" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Labs" ], + "description": "Delete lab. This operation can take a while to complete", + "operationId": "Labs_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Labs" ], + "description": "Modify properties of labs.", + "operationId": "Labs_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "lab", + "in": "body", + "description": "Represents a lab.", + "required": true, + "schema": { "$ref": "#/definitions/LabFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Lab" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/addUsers": { + "post": { + "tags": [ "Labs" ], + "description": "Add users to a lab", + "operationId": "Labs_AddUsers", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "addUsersPayload", + "in": "body", + "description": "Payload for Add Users operation on a Lab.", + "required": true, + "schema": { "$ref": "#/definitions/AddUsersPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings": { + "get": { + "tags": [ "EnvironmentSettings" ], + "description": "List environment setting in a given lab.", + "operationId": "EnvironmentSettings_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=publishingState)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[EnvironmentSetting]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/EnvironmentSetting" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}": { + "get": { + "tags": [ "EnvironmentSettings" ], + "description": "Get environment setting", + "operationId": "EnvironmentSettings_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=publishingState)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/EnvironmentSetting" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "EnvironmentSettings" ], + "description": "Create or replace an existing Environment Setting. This operation can take a while to complete", + "operationId": "EnvironmentSettings_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentSetting", + "in": "body", + "description": "Represents settings of an environment, from which environment instances would be created", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentSetting" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/EnvironmentSetting" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/EnvironmentSetting" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ "EnvironmentSettings" ], + "description": "Delete environment setting. This operation can take a while to complete", + "operationId": "EnvironmentSettings_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "EnvironmentSettings" ], + "description": "Modify properties of environment setting.", + "operationId": "EnvironmentSettings_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentSetting", + "in": "body", + "description": "Represents settings of an environment, from which environment instances would be created", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentSettingFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/EnvironmentSetting" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/claimAny": { + "post": { + "tags": [ "EnvironmentSettings" ], + "description": "Claims a random environment for a user in an environment settings", + "operationId": "EnvironmentSettings_ClaimAny", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments": { + "get": { + "tags": [ "Environments" ], + "description": "List environments in a given environment setting.", + "operationId": "Environments_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=networkInterface)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[Environment]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/Environment" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}": { + "get": { + "tags": [ "Environments" ], + "description": "Get environment", + "operationId": "Environments_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($expand=networkInterface)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Environment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Environments" ], + "description": "Create or replace an existing Environment.", + "operationId": "Environments_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "environment", + "in": "body", + "description": "Represents an environment instance", + "required": true, + "schema": { "$ref": "#/definitions/Environment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Environment" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/Environment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Environments" ], + "description": "Delete environment. This operation can take a while to complete", + "operationId": "Environments_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Environments" ], + "description": "Modify properties of environments.", + "operationId": "Environments_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "environment", + "in": "body", + "description": "Represents an environment instance", + "required": true, + "schema": { "$ref": "#/definitions/EnvironmentFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/Environment" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/claim": { + "post": { + "tags": [ "Environments" ], + "description": "Claims the environment and assigns it to the user", + "operationId": "Environments_Claim", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/resetPassword": { + "post": { + "tags": [ "Environments" ], + "description": "Resets the user password on an environment This operation can take a while to complete", + "operationId": "Environments_ResetPassword", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { + "name": "resetPasswordPayload", + "in": "body", + "description": "Represents the payload for resetting passwords.", + "required": true, + "schema": { "$ref": "#/definitions/ResetPasswordPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/start": { + "post": { + "tags": [ "Environments" ], + "description": "Starts an environment by starting all resources inside the environment. This operation can take a while to complete", + "operationId": "Environments_Start", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/environments/{environmentName}/stop": { + "post": { + "tags": [ "Environments" ], + "description": "Stops an environment by stopping all resources inside the environment This operation can take a while to complete", + "operationId": "Environments_Stop", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "environmentName", + "in": "path", + "description": "The name of the environment.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/publish": { + "post": { + "tags": [ "EnvironmentSettings" ], + "description": "Provisions/deprovisions required resources for an environment setting based on current state of the lab/environment setting.", + "operationId": "EnvironmentSettings_Publish", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { + "name": "publishPayload", + "in": "body", + "description": "Payload for Publish operation on EnvironmentSetting.", + "required": true, + "schema": { "$ref": "#/definitions/PublishPayload" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/start": { + "post": { + "tags": [ "EnvironmentSettings" ], + "description": "Starts a template by starting all resources inside the template. This operation can take a while to complete", + "operationId": "EnvironmentSettings_Start", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/environmentsettings/{environmentSettingName}/stop": { + "post": { + "tags": [ "EnvironmentSettings" ], + "description": "Starts a template by starting all resources inside the template. This operation can take a while to complete", + "operationId": "EnvironmentSettings_Stop", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "environmentSettingName", + "in": "path", + "description": "The name of the environment Setting.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "202": { "description": "Accepted" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/register": { + "post": { + "tags": [ "Labs" ], + "description": "Register to managed lab.", + "operationId": "Labs_Register", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { "description": "OK" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users": { + "get": { + "tags": [ "Users" ], + "description": "List users in a given lab.", + "operationId": "Users_List", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=email)'", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation.", + "required": false, + "type": "string" + }, + { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "description": "The ordering expression for the results, using OData notation.", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/ResponseWithContinuation[User]" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-pageable": { "nextLinkName": "nextLink" }, + "x-ms-odata": "#/definitions/User" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labaccounts/{labAccountName}/labs/{labName}/users/{userName}": { + "get": { + "tags": [ "Users" ], + "description": "Get user", + "operationId": "Users_Get", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify the $expand query. Example: 'properties($select=email)'", + "required": false, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "put": { + "tags": [ "Users" ], + "description": "Create or replace an existing User.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The User registered to a lab", + "required": true, + "schema": { "$ref": "#/definitions/User" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "201": { + "description": "Created", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + }, + "delete": { + "tags": [ "Users" ], + "description": "Delete user. This operation can take a while to complete", + "operationId": "Users_Delete", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "202": { "description": "Accepted" }, + "204": { "description": "No Content" }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ], + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ "Users" ], + "description": "Modify properties of users.", + "operationId": "Users_Update", + "parameters": [ + { "$ref": "#/parameters/subscriptionId" }, + { "$ref": "#/parameters/resourceGroupName" }, + { + "name": "labAccountName", + "in": "path", + "description": "The name of the lab Account.", + "required": true, + "type": "string" + }, + { + "name": "labName", + "in": "path", + "description": "The name of the lab.", + "required": true, + "type": "string" + }, + { + "name": "userName", + "in": "path", + "description": "The name of the user.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The User registered to a lab", + "required": true, + "schema": { "$ref": "#/definitions/UserFragment" } + }, + { "$ref": "#/parameters/api-version" } + ], + "responses": { + "200": { + "description": "OK", + "schema": { "$ref": "#/definitions/User" } + }, + "default": { + "description": "BadRequest", + "schema": { "$ref": "#/definitions/CloudError" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] + } + } + }, + "definitions": { + "AddUsersPayload": { + "description": "Payload for Add Users operation on a Lab.", + "required": [ "emailAddresses" ], + "type": "object", + "properties": { + "emailAddresses": { + "description": "List of user emails addresses to add to the lab.", + "type": "array", + "items": { "type": "string" } + } + } + }, + "CloudError": { + "description": "Error from a REST request.", + "type": "object", + "properties": { "error": { "$ref": "#/definitions/CloudErrorBody" } }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "Body of an error from a REST request.", + "type": "object", + "properties": { + "code": { "type": "string" }, + "message": { "type": "string" }, + "target": { "type": "string" }, + "details": { + "description": "Inner errors.", + "type": "array", + "items": { "$ref": "#/definitions/CloudErrorBody" } + } + }, + "x-ms-external": true + }, + "CreateLabProperties": { + "description": "Properties for creating a managed lab and a default environment setting", + "required": [ "labCreationParameters", "name" ], + "type": "object", + "properties": { + "environmentSettingCreationParameters": { + "$ref": "#/definitions/EnvironmentSettingCreationParameters", + "description": "Settings related to creating an environment setting" + }, + "labCreationParameters": { + "$ref": "#/definitions/LabCreationParameters", + "description": "Settings related to creating a lab" + }, + "name": { + "description": "The name of the resource", + "type": "string" + }, + "location": { + "description": "The location of the resource", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + } + }, + "Environment": { + "description": "Represents an environment instance", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentProperties", + "description": "The properties of the Environment resource", + "x-ms-client-flatten": true + } + } + }, + "EnvironmentDetails": { + "description": "This represents the details about a User's environment and its state.", + "type": "object", + "properties": { + "name": { + "description": "Name of the Environment", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Description of the Environment", + "type": "string", + "readOnly": true + }, + "id": { + "description": "Resource Id of the environment", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the environment. This also includes LabIsFull and NotYetProvisioned status.", + "type": "string", + "readOnly": true + }, + "virtualMachineDetails": { + "$ref": "#/definitions/VirtualMachineDetails", + "description": "Details of backing DTL virtual machine with compute and network details.", + "readOnly": true + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + }, + "environmentState": { + "description": "Publishing state of the environment setting Possible values are Creating, Created, Failed", + "type": "string", + "readOnly": true + }, + "totalUsage": { + "format": "duration", + "description": "How long the environment has been used by a lab user", + "type": "string", + "readOnly": true + }, + "passwordLastReset": { + "format": "date-time", + "description": "When the password was last reset on the environment.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentFragment": { + "description": "Represents an environment instance", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentPropertiesFragment", + "description": "The properties of the Environment resource", + "x-ms-client-flatten": true + } + } + }, + "EnvironmentOperationsPayload": { + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "required": [ "environmentId" ], + "type": "object", + "properties": { + "environmentId": { + "description": "The resourceId of the environment", + "type": "string" + } + } + }, + "EnvironmentProperties": { + "description": "Properties of an environment", + "type": "object", + "properties": { + "resourceSets": { + "$ref": "#/definitions/ResourceSet", + "description": "The set of a VM and the setting id it was created for" + }, + "claimedByUserObjectId": { + "description": "The AAD object Id of the user who has claimed the environment", + "type": "string", + "readOnly": true + }, + "claimedByUserPrincipalId": { + "description": "The user principal Id of the user who has claimed the environment", + "type": "string", + "readOnly": true + }, + "claimedByUserName": { + "description": "The name or email address of the user who has claimed the environment", + "type": "string", + "readOnly": true + }, + "isClaimed": { + "description": "Is the environment claimed or not", + "type": "boolean", + "readOnly": true + }, + "lastKnownPowerState": { + "description": "Last known power state of the environment", + "type": "string", + "readOnly": true + }, + "networkInterface": { + "$ref": "#/definitions/NetworkInterface", + "description": "Network details of the environment", + "readOnly": true + }, + "totalUsage": { + "format": "duration", + "description": "How long the environment has been used by a lab user", + "type": "string", + "readOnly": true + }, + "passwordLastReset": { + "format": "date-time", + "description": "When the password was last reset on the environment.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "EnvironmentPropertiesFragment": { + "description": "Properties of an environment", + "type": "object", + "properties": { + "resourceSets": { + "$ref": "#/definitions/ResourceSetFragment", + "description": "The set of a VM and the setting id it was created for" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "EnvironmentSetting": { + "description": "Represents settings of an environment, from which environment instances would be created", + "required": [ "properties" ], + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentSettingProperties", + "description": "The properties of the Environment Setting resource", + "x-ms-client-flatten": true + } + } + }, + "EnvironmentSettingCreationParameters": { + "description": "Settings related to creating an environment setting", + "required": [ "resourceSettingCreationParameters" ], + "type": "object", + "properties": { + "resourceSettingCreationParameters": { + "$ref": "#/definitions/ResourceSettingCreationParameters", + "description": "The resource specific settings" + } + } + }, + "EnvironmentSettingFragment": { + "description": "Represents settings of an environment, from which environment instances would be created", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/EnvironmentSettingPropertiesFragment", + "description": "The properties of the Environment Setting resource", + "x-ms-client-flatten": true + } + } + }, + "EnvironmentSettingProperties": { + "description": "Properties of an environment setting", + "required": [ "resourceSettings" ], + "type": "object", + "properties": { + "publishingState": { + "description": "Describes the readiness of this environment setting", + "enum": [ "Draft", "Publishing", "Published", "PublishFailed", "Scaling" ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "PublishingState", + "modelAsString": true, + "values": [ + { + "value": "Draft", + "description": "Initial state of an environment setting." + }, + { + "value": "Publishing", + "description": "Currently provisioning resources." + }, + { + "value": "Published", + "description": "All resources are currently provisioned." + }, + { + "value": "PublishFailed", + "description": "Failed to provision all the necessary resources." + }, + { + "value": "Scaling", + "description": "Currently provisioning resources without recreating VM image." + } + ] + } + }, + "configurationState": { + "description": "Describes the user's progress in configuring their environment setting", + "enum": [ "NotApplicable", "Completed" ], + "type": "string", + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true, + "values": [ + { + "value": "NotApplicable", + "description": "User either hasn't started configuring their template\r\nor they haven't started the configuration process." + }, + { + "value": "Completed", + "description": "User is finished modifying the template." + } + ] + } + }, + "description": { + "description": "Describes the environment and its resource settings", + "type": "string" + }, + "title": { + "description": "Brief title describing the environment and its resource settings", + "type": "string" + }, + "resourceSettings": { + "$ref": "#/definitions/ResourceSettings", + "description": "The resource specific settings" + }, + "lastChanged": { + "format": "date-time", + "description": "Time when the template VM was last changed.", + "type": "string", + "readOnly": true + }, + "lastPublished": { + "format": "date-time", + "description": "Time when the template VM was last sent for publishing.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "EnvironmentSettingPropertiesFragment": { + "description": "Properties of an environment setting", + "type": "object", + "properties": { + "configurationState": { + "description": "Describes the user's progress in configuring their environment setting", + "enum": [ "NotApplicable", "Completed" ], + "type": "string", + "x-ms-enum": { + "name": "ConfigurationState", + "modelAsString": true, + "values": [ + { + "value": "NotApplicable", + "description": "User either hasn't started configuring their template\r\nor they haven't started the configuration process." + }, + { + "value": "Completed", + "description": "User is finished modifying the template." + } + ] + } + }, + "description": { + "description": "Describes the environment and its resource settings", + "type": "string" + }, + "title": { + "description": "Brief title describing the environment and its resource settings", + "type": "string" + }, + "resourceSettings": { + "$ref": "#/definitions/ResourceSettingsFragment", + "description": "The resource specific settings" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "EnvironmentSize": { + "description": "Represents a size category supported by this Lab Account (small, medium or large)", + "type": "object", + "properties": { + "name": { + "description": "The size category", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "vmSizes": { + "description": "Represents a set of compute sizes that can serve this given size type", + "type": "array", + "items": { "$ref": "#/definitions/SizeInfo" } + }, + "maxPrice": { + "format": "decimal", + "description": "The pay-as-you-go dollar price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost. This is the maximum price of all prices within this tier.", + "type": "number", + "readOnly": true + }, + "minNumberOfCores": { + "format": "int32", + "description": "The number of cores a VM of this size has. This is the minimum number of cores within this tier.", + "type": "integer", + "readOnly": true + }, + "minMemory": { + "format": "double", + "description": "The amount of memory available (in GB). This is the minimum amount of memory within this tier.", + "type": "number", + "readOnly": true + } + } + }, + "EnvironmentSizeFragment": { + "description": "Represents a size category supported by this Lab Account (small, medium or large)", + "type": "object", + "properties": { + "name": { + "description": "The size category", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "vmSizes": { + "description": "Represents a set of compute sizes that can serve this given size type", + "type": "array", + "items": { "$ref": "#/definitions/SizeInfoFragment" } + } + } + }, + "GalleryImage": { + "description": "Represents an image from the Azure Marketplace", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImageProperties", + "description": "The gallery image properties", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageFragment": { + "description": "Represents an image from the Azure Marketplace", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/GalleryImagePropertiesFragment", + "description": "The gallery image properties", + "x-ms-client-flatten": true + } + } + }, + "GalleryImageProperties": { + "description": "The gallery image properties", + "type": "object", + "properties": { + "author": { + "description": "The author of the gallery image.", + "type": "string", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "The creation date of the gallery image.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the gallery image.", + "type": "string", + "readOnly": true + }, + "imageReference": { + "$ref": "#/definitions/GalleryImageReference", + "description": "The image reference of the gallery image.", + "readOnly": true + }, + "icon": { + "description": "The icon of the gallery image.", + "type": "string", + "readOnly": true + }, + "isEnabled": { + "description": "Indicates whether this gallery image is enabled.", + "type": "boolean" + }, + "isOverride": { + "description": "Indicates whether this gallery has been overridden for this lab account", + "type": "boolean" + }, + "planId": { + "description": "The third party plan that applies to this image", + "type": "string", + "readOnly": true + }, + "isPlanAuthorized": { + "description": "Indicates if the plan has been authorized for programmatic deployment.", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "GalleryImagePropertiesFragment": { + "description": "The gallery image properties", + "type": "object", + "properties": { + "isEnabled": { + "description": "Indicates whether this gallery image is enabled.", + "type": "boolean" + }, + "isOverride": { + "description": "Indicates whether this gallery has been overridden for this lab account", + "type": "boolean" + }, + "isPlanAuthorized": { + "description": "Indicates if the plan has been authorized for programmatic deployment.", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "GalleryImageReference": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GalleryImageReferenceFragment": { + "description": "The reference information for an Azure Marketplace image.", + "type": "object", + "properties": { + "offer": { + "description": "The offer of the gallery image.", + "type": "string" + }, + "publisher": { + "description": "The publisher of the gallery image.", + "type": "string" + }, + "sku": { + "description": "The SKU of the gallery image.", + "type": "string" + }, + "osType": { + "description": "The OS type of the gallery image.", + "type": "string" + }, + "version": { + "description": "The version of the gallery image.", + "type": "string" + } + } + }, + "GetEnvironmentResponse": { + "description": "Represents the environments details", + "type": "object", + "properties": { + "environment": { + "$ref": "#/definitions/EnvironmentDetails", + "description": "Details of the environment", + "readOnly": true + } + } + }, + "GetPersonalPreferencesResponse": { + "description": "Represents the PersonalPreferences for the user", + "type": "object", + "properties": { + "id": { + "description": "Id to be used by the cache orchestrator", + "type": "string" + }, + "favoriteLabResourceIds": { + "description": "Array of favorite lab resource ids", + "type": "array", + "items": { "type": "string" } + } + } + }, + "GetRegionalAvailabilityResponse": { + "description": "The response model from the GetRegionalAvailability action", + "type": "object", + "properties": { + "regionalAvailability": { + "description": "Availability information for different size categories per region", + "type": "array", + "items": { "$ref": "#/definitions/RegionalAvailability" } + } + } + }, + "Lab": { + "description": "Represents a lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabAccount": { + "description": "Represents a lab account.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabAccountProperties", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabAccountFragment": { + "description": "Represents a lab account.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabAccountPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabAccountProperties": { + "description": "Properties of a Lab Account.", + "type": "object", + "properties": { + "sizeConfiguration": { + "$ref": "#/definitions/SizeConfigurationProperties", + "description": "Represents the size configuration under the lab account", + "readOnly": true + }, + "enabledRegionSelection": { + "description": "Represents if region selection is enabled", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "LabAccountPropertiesFragment": { + "description": "Properties of a Lab Account.", + "type": "object", + "properties": { + "enabledRegionSelection": { + "description": "Represents if region selection is enabled", + "type": "boolean" + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LabCreationParameters": { + "description": "Settings related to creating a lab", + "type": "object", + "properties": { + "maxUsersInLab": { + "format": "int32", + "description": "Maximum number of users allowed in the lab.", + "type": "integer" + } + } + }, + "LabDetails": { + "description": "This represents the details about a lab that the User is in, and its state.", + "type": "object", + "properties": { + "name": { + "description": "Name of the lab", + "type": "string" + }, + "provisioningState": { + "description": "The provisioning state of the lab.", + "type": "string" + }, + "id": { + "description": "The Id of the lab.", + "type": "string" + }, + "usageQuota": { + "format": "duration", + "description": "The maximum duration a user can use a VM in this lab.", + "type": "string", + "readOnly": true + } + } + }, + "LabFragment": { + "description": "Represents a lab.", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/LabPropertiesFragment", + "description": "The properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "LabProperties": { + "description": "Properties of a Lab.", + "type": "object", + "properties": { + "maxUsersInLab": { + "format": "int32", + "description": "Maximum number of users allowed in the lab.", + "type": "integer" + }, + "userQuota": { + "format": "int32", + "description": "Maximum value MaxUsersInLab can be set to, as specified by the service", + "type": "integer", + "readOnly": true + }, + "invitationCode": { + "description": "Invitation code that users can use to join a lab.", + "type": "string", + "readOnly": true + }, + "createdByObjectId": { + "description": "Object id of the user that created the lab.", + "type": "string", + "readOnly": true + }, + "usageQuota": { + "format": "duration", + "description": "Maximum duration a user can use an environment for in the lab.", + "type": "string" + }, + "userAccessMode": { + "description": "Lab user access mode (open to all vs. restricted to those listed on the lab).", + "enum": [ "Restricted", "Open" ], + "type": "string", + "x-ms-enum": { + "name": "LabUserAccessMode", + "modelAsString": true, + "values": [ + { + "value": "Restricted", + "description": "Only users registered with the lab can access VMs." + }, + { + "value": "Open", + "description": "Any user can register with the lab and access its VMs." + } + ] + } + }, + "createdByUserPrincipalName": { + "description": "Lab creator name", + "type": "string", + "readOnly": true + }, + "createdDate": { + "format": "date-time", + "description": "Creation date for the lab", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "LabPropertiesFragment": { + "description": "Properties of a Lab.", + "type": "object", + "properties": { + "maxUsersInLab": { + "format": "int32", + "description": "Maximum number of users allowed in the lab.", + "type": "integer" + }, + "usageQuota": { + "format": "duration", + "description": "Maximum duration a user can use an environment for in the lab.", + "type": "string" + }, + "userAccessMode": { + "description": "Lab user access mode (open to all vs. restricted to those listed on the lab).", + "enum": [ "Restricted", "Open" ], + "type": "string", + "x-ms-enum": { + "name": "LabUserAccessMode", + "modelAsString": true, + "values": [ + { + "value": "Restricted", + "description": "Only users registered with the lab can access VMs." + }, + { + "value": "Open", + "description": "Any user can register with the lab and access its VMs." + } + ] + } + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "LatestOperationResult": { + "description": "Details of the status of an operation.", + "type": "object", + "properties": { + "status": { + "description": "The current status of the operation.", + "type": "string", + "readOnly": true + }, + "errorCode": { + "description": "Error code on failure.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "requestUri": { + "description": "Request URI of the operation.", + "type": "string", + "readOnly": true + }, + "httpMethod": { + "description": "The HttpMethod - PUT/POST/DELETE for the operation.", + "type": "string", + "readOnly": true + }, + "operationUrl": { + "description": "The URL to use to check long-running operation status", + "type": "string", + "readOnly": true + } + } + }, + "LatestOperationResultFragment": { + "description": "Details of the status of an operation.", + "type": "object", + "properties": {} + }, + "ListEnvironmentsPayload": { + "description": "Represents the payload to list environments owned by a user", + "type": "object", + "properties": { + "labId": { + "description": "The resource Id of the lab", + "type": "string" + } + } + }, + "ListEnvironmentsResponse": { + "description": "Represents the list of environments owned by a user", + "type": "object", + "properties": { + "environments": { + "description": "List of all the evironments", + "type": "array", + "items": { "$ref": "#/definitions/EnvironmentDetails" } + } + } + }, + "ListLabsResponse": { + "description": "Lists the labs owned by a user", + "type": "object", + "properties": { + "labs": { + "description": "List of all the labs", + "type": "array", + "items": { "$ref": "#/definitions/LabDetails" } + } + } + }, + "NetworkInterface": { + "description": "Network details of the environment", + "type": "object", + "properties": { + "privateIpAddress": { + "description": "PrivateIp address of the Compute VM", + "type": "string", + "readOnly": true + }, + "sshAuthority": { + "description": "Connection information for Linux", + "type": "string", + "readOnly": true + }, + "rdpAuthority": { + "description": "Connection information for Windows", + "type": "string", + "readOnly": true + }, + "username": { + "description": "Username of the VM", + "type": "string", + "readOnly": true + } + } + }, + "NetworkInterfaceFragment": { + "description": "Network details of the environment", + "type": "object", + "properties": {} + }, + "OperationBatchStatusPayload": { + "description": "Payload to get the status of an operation", + "required": [ "urls" ], + "type": "object", + "properties": { + "urls": { + "description": "The operation url of long running operation", + "type": "array", + "items": { "type": "string" } + } + } + }, + "OperationBatchStatusResponse": { + "description": "Status Details of the long running operation for an environment", + "type": "object", + "properties": { + "items": { + "description": "Gets a collection of items that contain the operation url and status.", + "type": "array", + "items": { "$ref": "#/definitions/OperationBatchStatusResponseItem" }, + "readOnly": true + } + } + }, + "OperationBatchStatusResponseItem": { + "description": "Represents the status of an operation that used the batch API.", + "type": "object", + "properties": { + "operationUrl": { + "description": "status of the long running operation for an environment", + "type": "string", + "readOnly": true + }, + "status": { + "description": "status of the long running operation for an environment", + "type": "string", + "readOnly": true + } + } + }, + "OperationError": { + "description": "Error details for the operation in case of a failure.", + "type": "object", + "properties": { + "code": { + "description": "The error code of the operation error.", + "type": "string" + }, + "message": { + "description": "The error message of the operation error.", + "type": "string" + } + } + }, + "OperationMetadata": { + "description": "The REST API operation supported by ManagedLab ResourceProvider.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationMetadataDisplay", + "description": "The object that describes the operations" + } + } + }, + "OperationMetadataDisplay": { + "description": "The object that describes the operations", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + }, + "OperationResult": { + "description": "An Operation Result", + "type": "object", + "properties": { + "status": { + "description": "The operation status.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/OperationError", + "description": "Error details for the operation in case of a failure." + } + } + }, + "OperationStatusPayload": { + "description": "Payload to get the status of an operation", + "required": [ "operationUrl" ], + "type": "object", + "properties": { + "operationUrl": { + "description": "The operation url of long running operation", + "type": "string" + } + } + }, + "OperationStatusResponse": { + "description": "Status Details of the long running operation for an environment", + "type": "object", + "properties": { + "status": { + "description": "status of the long running operation for an environment", + "type": "string", + "readOnly": true + } + } + }, + "PersonalPerferencesOperationsPayload": { + "description": "Represents payload for any Environment operations like get, start, stop, connect", + "type": "object", + "properties": { + "labAccountResourceId": { + "description": "Resource Id of the lab account", + "type": "string" + }, + "addRemove": { + "description": "Enum indicating if user is adding or removing a favorite lab", + "enum": [ "Add", "Remove" ], + "type": "string", + "x-ms-enum": { + "name": "AddRemove", + "modelAsString": true, + "values": [ + { + "value": "Add", + "description": "Indicates that a user is adding a favorite lab" + }, + { + "value": "Remove", + "description": "Indicates that a user is removing a favorite lab" + } + ] + } + }, + "labResourceId": { + "description": "Resource Id of the lab to add/remove from the favorites list", + "type": "string" + } + } + }, + "ProviderOperationResult": { + "description": "Result of the request to list REST API operations", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { "$ref": "#/definitions/OperationMetadata" } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PublishPayload": { + "description": "Payload for Publish operation on EnvironmentSetting.", + "type": "object", + "properties": { + "useExistingImage": { + "description": "Whether to use existing VM custom image when publishing.", + "type": "boolean" + } + } + }, + "ReferenceVm": { + "description": "Details of a Reference Vm", + "required": [ "userName" ], + "type": "object", + "properties": { + "userName": { + "description": "The username of the virtual machine", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine. This will be set to null in GET resource API", + "type": "string" + }, + "vmStateDetails": { + "$ref": "#/definitions/VmStateDetails", + "description": "The state details for the reference virtual machine.", + "readOnly": true + }, + "vmResourceId": { + "description": "VM resource Id for the environment", + "type": "string", + "readOnly": true + } + } + }, + "ReferenceVmCreationParameters": { + "description": "Creation parameters for Reference Vm", + "required": [ "userName", "password" ], + "type": "object", + "properties": { + "userName": { + "description": "The username of the virtual machine", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine.", + "type": "string" + } + } + }, + "ReferenceVmFragment": { + "description": "Details of a Reference Vm", + "type": "object", + "properties": { + "userName": { + "description": "The username of the virtual machine", + "type": "string" + }, + "password": { + "description": "The password of the virtual machine. This will be set to null in GET resource API", + "type": "string" + } + } + }, + "RegionalAvailability": { + "description": "The availability information of sizes across regions", + "type": "object", + "properties": { + "region": { + "description": "Corresponding region", + "type": "string" + }, + "sizeAvailabilities": { + "description": "List of all the size information for the region", + "type": "array", + "items": { "$ref": "#/definitions/SizeAvailability" } + } + } + }, + "RegisterPayload": { + "description": "Represents payload for Register action.", + "type": "object", + "properties": { + "registrationCode": { + "description": "The registration code of the lab.", + "type": "string" + } + } + }, + "ResetPasswordPayload": { + "description": "Represents the payload for resetting passwords.", + "required": [ "environmentId" ], + "type": "object", + "properties": { + "environmentId": { + "description": "The resourceId of the environment", + "type": "string" + }, + "username": { + "description": "The username for which the password will be reset.", + "type": "string" + }, + "password": { + "description": "The password to assign to the user specified in", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "type": "object", + "properties": { + "id": { + "description": "The identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { "type": "string" } + } + }, + "x-ms-azure-resource": true + }, + "ResourceSet": { + "description": "Represents a VM and the setting Id it was created for.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "VM resource Id for the environment", + "type": "string" + }, + "resourceSettingId": { + "description": "resourceSettingId for the environment", + "type": "string" + } + } + }, + "ResourceSetFragment": { + "description": "Represents a VM and the setting Id it was created for.", + "type": "object", + "properties": { + "vmResourceId": { + "description": "VM resource Id for the environment", + "type": "string" + }, + "resourceSettingId": { + "description": "resourceSettingId for the environment", + "type": "string" + } + } + }, + "ResourceSettingCreationParameters": { + "description": "Represents resource specific settings", + "required": [ "galleryImageResourceId", "referenceVmCreationParameters" ], + "type": "object", + "properties": { + "location": { + "description": "The location where the virtual machine will live", + "type": "string" + }, + "name": { + "description": "The name of the resource setting", + "type": "string" + }, + "galleryImageResourceId": { + "description": "The resource id of the gallery image used for creating the virtual machine", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "referenceVmCreationParameters": { + "$ref": "#/definitions/ReferenceVmCreationParameters", + "description": "Creation parameters for Reference Vm" + } + } + }, + "ResourceSettings": { + "description": "Represents resource specific settings", + "required": [ "referenceVm" ], + "type": "object", + "properties": { + "id": { + "description": "The unique id of the resource setting", + "type": "string", + "readOnly": true + }, + "galleryImageResourceId": { + "description": "The resource id of the gallery image used for creating the virtual machine", + "type": "string" + }, + "imageName": { + "description": "The name of the image used to created the environment setting", + "type": "string", + "readOnly": true + }, + "size": { + "description": "The size of the virtual machine", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "cores": { + "format": "int32", + "description": "The translated compute cores of the virtual machine", + "type": "integer", + "readOnly": true + }, + "referenceVm": { + "$ref": "#/definitions/ReferenceVm", + "description": "Details specific to Reference Vm" + } + } + }, + "ResourceSettingsFragment": { + "description": "Represents resource specific settings", + "type": "object", + "properties": { + "galleryImageResourceId": { + "description": "The resource id of the gallery image used for creating the virtual machine", + "type": "string" + }, + "size": { + "description": "The size of the virtual machine", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "referenceVm": { + "$ref": "#/definitions/ReferenceVmFragment", + "description": "Details specific to Reference Vm" + } + } + }, + "ResponseWithContinuation[Environment]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Environment" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[EnvironmentSetting]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/EnvironmentSetting" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[GalleryImage]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/GalleryImage" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[Lab]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/Lab" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[LabAccount]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/LabAccount" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "ResponseWithContinuation[User]": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Results of the list operation.", + "type": "array", + "items": { "$ref": "#/definitions/User" } + }, + "nextLink": { + "description": "Link for next set of results.", + "type": "string" + } + } + }, + "SizeAvailability": { + "description": "Represents the size information", + "type": "object", + "properties": { + "sizeCategory": { + "description": "The category of the size (Basic, Standard, Performance).", + "enum": [ "Basic", "Standard", "Performance" ], + "type": "string", + "x-ms-enum": { + "name": "ManagedLabVmSize", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "The base VM size" + }, + { + "value": "Standard", + "description": "The standard or default VM size" + }, + { + "value": "Performance", + "description": "The most performant VM size" + } + ] + } + }, + "isAvailable": { + "description": "Whether or not this size category is available", + "type": "boolean" + } + } + }, + "SizeConfigurationProperties": { + "description": "Represents the size configuration under the lab account", + "type": "object", + "properties": { + "environmentSizes": { + "description": "Represents a list of size categories supported by this Lab Account (Small, Medium, Large)", + "type": "array", + "items": { "$ref": "#/definitions/EnvironmentSize" } + } + } + }, + "SizeConfigurationPropertiesFragment": { + "description": "Represents the size configuration under the lab account", + "type": "object", + "properties": { + "environmentSizes": { + "description": "Represents a list of size categories supported by this Lab Account (Small, Medium, Large)", + "type": "array", + "items": { "$ref": "#/definitions/EnvironmentSizeFragment" } + } + } + }, + "SizeInfo": { + "description": "Contains detailed information about a size", + "type": "object", + "properties": { + "computeSize": { + "description": "Represents the actual compute size, e.g. Standard_A2_v2.", + "type": "string" + }, + "price": { + "format": "decimal", + "description": "The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost.", + "type": "number" + }, + "numberOfCores": { + "format": "int32", + "description": "The number of cores a VM of this size has.", + "type": "integer" + }, + "memory": { + "format": "double", + "description": "The amount of memory available (in GB).", + "type": "number" + } + } + }, + "SizeInfoFragment": { + "description": "Contains detailed information about a size", + "type": "object", + "properties": { + "computeSize": { + "description": "Represents the actual compute size, e.g. Standard_A2_v2.", + "type": "string" + }, + "price": { + "format": "decimal", + "description": "The pay-as-you-go price per hour this size will cost. It does not include discounts and may not reflect the actual price the size will cost.", + "type": "number" + }, + "numberOfCores": { + "format": "int32", + "description": "The number of cores a VM of this size has.", + "type": "integer" + }, + "memory": { + "format": "double", + "description": "The amount of memory available (in GB).", + "type": "number" + } + } + }, + "User": { + "description": "The User registered to a lab", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "These are the properties for the user registered under a lab.", + "x-ms-client-flatten": true + } + } + }, + "UserFragment": { + "description": "The User registered to a lab", + "type": "object", + "allOf": [ { "$ref": "#/definitions/Resource" } ], + "properties": { + "properties": { + "$ref": "#/definitions/UserPropertiesFragment", + "description": "These are the properties for the user registered under a lab.", + "x-ms-client-flatten": true + } + } + }, + "UserProperties": { + "description": "Lab User properties", + "type": "object", + "properties": { + "email": { + "description": "The user email address, as it was specified during registration.", + "type": "string", + "readOnly": true + }, + "familyName": { + "description": "The user family name, as it was specified during registration.", + "type": "string", + "readOnly": true + }, + "givenName": { + "description": "The user given name, as it was specified during registration.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The user tenant ID, as it was specified during registration.", + "type": "string", + "readOnly": true + }, + "totalUsage": { + "format": "duration", + "description": "How long the user has used his VMs in this lab", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + }, + "latestOperationResult": { + "$ref": "#/definitions/LatestOperationResult", + "description": "The details of the latest operation. ex: status, error", + "readOnly": true + } + } + }, + "UserPropertiesFragment": { + "description": "Lab User properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning status of the resource.", + "type": "string" + }, + "uniqueIdentifier": { + "description": "The unique immutable identifier of a resource (Guid).", + "type": "string" + } + } + }, + "VirtualMachineDetails": { + "description": "Details of the backing virtual machine.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the Dtl VM", + "type": "string", + "readOnly": true + }, + "rdpAuthority": { + "description": "Connection information for Windows", + "type": "string", + "readOnly": true + }, + "sshAuthority": { + "description": "Connection information for Linux", + "type": "string", + "readOnly": true + }, + "privateIpAddress": { + "description": "PrivateIp address of the compute VM", + "type": "string", + "readOnly": true + }, + "userName": { + "description": "Compute VM login user name", + "type": "string", + "readOnly": true + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string", + "readOnly": true + } + } + }, + "VmStateDetails": { + "description": "Details about the state of the reference virtual machine.", + "type": "object", + "properties": { + "rdpAuthority": { + "description": "The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).", + "type": "string", + "readOnly": true + }, + "sshAuthority": { + "description": "The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.", + "type": "string", + "readOnly": true + }, + "powerState": { + "description": "The power state of the reference virtual machine.", + "type": "string", + "readOnly": true + }, + "lastKnownPowerState": { + "description": "Last known compute power state captured in DTL", + "type": "string", + "readOnly": true + } + } + }, + "VmStateDetailsFragment": { + "description": "Details about the state of the reference virtual machine.", + "type": "object", + "properties": {} + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "Client API version.", + "required": true, + "type": "string", + "default": "2018-10-15" + }, + "locationName": { + "name": "locationName", + "in": "path", + "description": "The name of the location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "OAuth2 Implicit Grant", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { "user_impersonation": "Access Microsoft Azure" } + } + }, + "security": [ { "azure_auth": [ "user_impersonation" ] } ] +} \ No newline at end of file diff --git a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/examples/Labs_List.json b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/examples/Labs_List.json new file mode 100644 index 000000000000..2d857eb5db18 --- /dev/null +++ b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/examples/Labs_List.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "labAccountName": "{devtestlab-name}", + "api-version": "2018-10-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "maxUsersInLab": 1, + "userQuota": 100, + "invitationCode": "{invitationCode}", + "createdByObjectId": "11111111-1111-1111-1111-111111111111", + "userAccessMode": "Restricted", + "createdByUserPrincipalName": "YourNameHere@domain.com", + "createdDate": "2018-10-09T21:05:25.0408858+00:00", + "provisioningState": "Succeeded", + "uniqueIdentifier": "22222222-2222-2222-2222-222222222222", + "latestOperationResult": {} + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.labservices/labaccounts/{devtestlab-name}/labs/{labName}", + "name": "{labName}", + "type": "Microsoft.LabServices/labAccounts/labs", + "location": "australiaeast", + "tags": { + "Name": "CreatedDate", + "Value": "8/30/118 9:37:32 PM" + } + }, + { + "properties": { + "maxUsersInLab": 1, + "userQuota": 100, + "invitationCode": "{invitationCode}", + "createdByObjectId": "11111111-1111-1111-1111-111111111111", + "userAccessMode": "Restricted", + "createdByUserPrincipalName": "YourNameHere@domain.com", + "createdDate": "2018-10-09T21:29:47.2453342+00:00", + "provisioningState": "Succeeded", + "uniqueIdentifier": "22222222-2222-2222-2222-222222222222", + "latestOperationResult": {} + }, + "id": "/subscriptions/{subscription-id}/resourcegroups/myResourceGroup/providers/microsoft.labservices/labaccounts/{devtestlab-name}/labs/{labName}", + "name": "{labName}", + "type": "Microsoft.LabServices/labAccounts/labs", + "location": "australiaeast", + "tags": { + "Value": "8/30/118 9:37:36 PM", + "Name": "CreatedDate" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/labservices/resource-manager/readme.go.md b/specification/labservices/resource-manager/readme.go.md new file mode 100644 index 000000000000..21bb938142ce --- /dev/null +++ b/specification/labservices/resource-manager/readme.go.md @@ -0,0 +1,27 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: ML + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2018-10 +``` + + +### Tag: package-2018-10 and go + +These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-10' && $(go) +output-folder: $(go-sdk-folder)/services/labservices/mgmt/2018-10-15/$(namespace) +``` diff --git a/specification/labservices/resource-manager/readme.md b/specification/labservices/resource-manager/readme.md new file mode 100644 index 000000000000..a696f126b072 --- /dev/null +++ b/specification/labservices/resource-manager/readme.md @@ -0,0 +1,144 @@ +# LabServices + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for LabServices. + + + +--- +## Getting Started +To build the SDK for LabServices, 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 LabServices API. + +``` yaml +openapi-type: arm +tag: package-2018-10 +``` + + +### Tag: package-2018-10 + +These settings apply only when `--tag=package-2018-10` is specified on the command line. + +``` yaml $(tag) == 'package-2018-10' +input-file: +- Microsoft.LabServices/stable/2018-10-15/ML.json +``` + +--- +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_labservices'] +``` + + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.LabServices + output-folder: $(csharp-sdks-folder)/LabServices/Management.LabServices/Generated + clear-output-folder: true +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.labservices + package-name: azure-mgmt-labservices + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt-labservices/azure/mgmt/labservices +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-mgmt-labservices +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.labservices +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-labservices +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2018-10 +``` + +### Tag: package-2018-10 and java + +These settings apply only when `--tag=package-2018-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.labservices.v2018_10_15 + output-folder: $(azure-libraries-for-java-folder)/labservices/resource-manager/v2018_10_15 +regenerate-manager: true +generate-interface: true +``` + + + diff --git a/specification/labservices/resource-manager/readme.nodejs.md b/specification/labservices/resource-manager/readme.nodejs.md new file mode 100644 index 000000000000..fb70ba2617b9 --- /dev/null +++ b/specification/labservices/resource-manager/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-arm-labservices + output-folder: $(node-sdks-folder)/lib/services/labservicesManagement + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/labservices/resource-manager/readme.ruby.md b/specification/labservices/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..02938ea7dfaf --- /dev/null +++ b/specification/labservices/resource-manager/readme.ruby.md @@ -0,0 +1,26 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_mgmt_LabServices +package-version: "0.16.0" +azure-arm: true +``` + +### Ruby multi-api + +``` yaml $(ruby) && $(multiapi) +batch: + - tag: package-2018-10 +``` + +### Tag: package-2018-10 and ruby + +These settings apply only when `--tag=package-2018-10 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-10' && $(ruby) +namespace: "Azure::LabServices::Mgmt::V2018_10_15" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_LabServices/lib +``` diff --git a/specification/labservices/resource-manager/readme.typescript.md b/specification/labservices/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..4f8b19e8bb2f --- /dev/null +++ b/specification/labservices/resource-manager/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-labservices" + output-folder: "$(typescript-sdks-folder)/packages/@azure/arm-labservices" + generate-metadata: true +``` From 993f167d153de48c735ea6efa9eb45ab6a79be1a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 19:49:26 -0500 Subject: [PATCH 293/464] typo: Microsoft.DataLakeAnalytics (#4676) - partion -> partition - formatxii -> format - occured -> occurred - underying -> underlying - Double word "delete" - Asunc -> Async --- .../preview/2015-10-01-preview/catalog.json | 2 +- .../preview/2015-11-01-preview/job.json | 6 +++--- .../preview/2016-03-20-preview/job.json | 10 +++++----- .../preview/2017-09-01-preview/job.json | 8 ++++---- .../stable/2016-11-01/catalog.json | 10 +++++----- .../stable/2016-11-01/job.json | 8 ++++---- .../preview/2015-10-01-preview/account.json | 12 ++++++------ .../preview/2015-10-01-preview/account.json | 6 +++--- 8 files changed, 31 insertions(+), 31 deletions(-) diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json index e8943294dd85..95331d8e363d 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/catalog.json @@ -2140,7 +2140,7 @@ "items": { "type": "string" }, - "description": "the list of partion keys in the index" + "description": "the list of partition keys in the index" }, "streamNames": { "type": "array", diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json index 62c0782c97dd..0d3a24a48e0a 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2015-11-01-preview/job.json @@ -295,7 +295,7 @@ "in": "query", "required": false, "type": "string", - "description": "The return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -359,7 +359,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "Gets the number of failures that occured in this stage." + "description": "Gets the number of failures that occurred in this stage." }, "maxVertexDataRead": { "type": "integer", @@ -737,7 +737,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "Gets the specific line number in the job where the error occured." + "description": "Gets the specific line number in the job where the error occurred." }, "message": { "type": "string", diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json index 453b306eb2f5..0db2aa94ac9d 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2016-03-20-preview/job.json @@ -295,7 +295,7 @@ "in": "query", "required": false, "type": "string", - "description": "The return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -359,7 +359,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "the number of failures that occured in this stage." + "description": "the number of failures that occurred in this stage." }, "maxVertexDataRead": { "type": "integer", @@ -693,7 +693,7 @@ "Diagnostics" : { "properties": { "columnNumber" : { - "description": "the column where the error occured.", + "description": "the column where the error occurred.", "type": "integer", "format": "int32", "readOnly": true @@ -705,7 +705,7 @@ "readOnly": true }, "lineNumber" : { - "description": "the line number the error occured on.", + "description": "the line number the error occurred on.", "type": "integer", "format": "int32", "readOnly": true @@ -779,7 +779,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "the specific line number in the job where the error occured." + "description": "the specific line number in the job where the error occurred." }, "message": { "type": "string", diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json index 2985663554f7..911c3e76cd92 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/preview/2017-09-01-preview/job.json @@ -1001,7 +1001,7 @@ "readOnly": true, "type": "integer", "format": "int32", - "description": "The number of failures that occured in this stage." + "description": "The number of failures that occurred in this stage." }, "maxVertexDataRead": { "readOnly": true, @@ -1250,13 +1250,13 @@ "readOnly": true, "type": "integer", "format": "int32", - "description": "The line number the error occured on." + "description": "The line number the error occurred on." }, "columnNumber": { "readOnly": true, "type": "integer", "format": "int32", - "description": "The column where the error occured." + "description": "The column where the error occurred." }, "start": { "readOnly": true, @@ -1466,7 +1466,7 @@ "readOnly": true, "type": "integer", "format": "int32", - "description": "The specific line number in the job where the error occured." + "description": "The specific line number in the job where the error occurred." }, "startOffset": { "readOnly": true, diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json index 243773558373..dedc81e58f54 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/catalog.json @@ -805,7 +805,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved the specified table from the underying database and schema combination", + "description": "Successfully retrieved the specified table from the underlying database and schema combination", "schema": { "$ref": "#/definitions/USqlTable" } @@ -1141,7 +1141,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved the specified table type from the underying database and schema combination", + "description": "Successfully retrieved the specified table type from the underlying database and schema combination", "schema": { "$ref": "#/definitions/USqlTableType" } @@ -1280,7 +1280,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved the specified package from the underying database and schema combination", + "description": "Successfully retrieved the specified package from the underlying database and schema combination", "schema": { "$ref": "#/definitions/USqlPackage" } @@ -1419,7 +1419,7 @@ ], "responses": { "200": { - "description": "Successfully retrieved the specified view from the underying database and schema combination", + "description": "Successfully retrieved the specified view from the underlying database and schema combination", "schema": { "$ref": "#/definitions/USqlView" } @@ -3706,7 +3706,7 @@ "items": { "type": "string" }, - "description": "the list of partion keys in the index" + "description": "the list of partition keys in the index" }, "streamNames": { "type": "array", diff --git a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json index 083bd538bbc6..128dc2377633 100644 --- a/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json +++ b/specification/datalake-analytics/data-plane/Microsoft.DataLakeAnalytics/stable/2016-11-01/job.json @@ -543,7 +543,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "the number of failures that occured in this stage." + "description": "the number of failures that occurred in this stage." }, "maxVertexDataRead": { "type": "integer", @@ -928,7 +928,7 @@ "Diagnostics": { "properties": { "columnNumber": { - "description": "the column where the error occured.", + "description": "the column where the error occurred.", "type": "integer", "format": "int32", "readOnly": true @@ -940,7 +940,7 @@ "readOnly": true }, "lineNumber": { - "description": "the line number the error occured on.", + "description": "the line number the error occurred on.", "type": "integer", "format": "int32", "readOnly": true @@ -1018,7 +1018,7 @@ "type": "integer", "readOnly": true, "format": "int32", - "description": "the specific line number in the job where the error occured." + "description": "the specific line number in the job where the error occurred." }, "message": { "type": "string", diff --git a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json index 95deea4c3445..3e3f8cd97ed4 100644 --- a/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json +++ b/specification/datalake-analytics/resource-manager/Microsoft.DataLakeAnalytics/preview/2015-10-01-preview/account.json @@ -608,7 +608,7 @@ "in": "query", "required": false, "type": "string", - "description": "The desired return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -716,7 +716,7 @@ "in": "query", "required": false, "type": "string", - "description": "The desired return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -817,7 +817,7 @@ "in": "query", "required": false, "type": "string", - "description": "The return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -911,7 +911,7 @@ "in": "query", "required": false, "type": "string", - "description": "The desired return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -977,7 +977,7 @@ "Account" ], "operationId": "Account_Delete", - "description": "Begins the delete delete process for the Data Lake Analytics account object specified by the account name.", + "description": "Begins the delete process for the Data Lake Analytics account object specified by the account name.", "parameters": [ { "name": "resourceGroupName", @@ -1546,7 +1546,7 @@ "status": { "type": "string", "readOnly": true, - "description": "the status of the AzureAsuncOperation", + "description": "the status of the AzureAsyncOperation", "enum": [ "InProgress", "Succeeded", diff --git a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json index 8bb9ccedf8ab..56630b2bc739 100644 --- a/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json +++ b/specification/datalake-store/resource-manager/Microsoft.DataLakeStore/preview/2015-10-01-preview/account.json @@ -533,7 +533,7 @@ "in": "query", "required": false, "type": "string", - "description": "The desired return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -627,7 +627,7 @@ "in": "query", "required": false, "type": "string", - "description": "The desired return format. Return the response in particular formatxii without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." + "description": "The desired return format. Return the response in particular format without access to request headers for standard content-type negotiation (e.g Orders?$format=json). Optional." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1000,7 +1000,7 @@ "status": { "type": "string", "readOnly": true, - "description": "the status of the AzureAsuncOperation", + "description": "the status of the AzureAsyncOperation", "enum": [ "InProgress", "Succeeded", From 00795ddd46e28a757e543b471672ad9ed908ab06 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 3 Dec 2018 20:07:24 -0500 Subject: [PATCH 294/464] typo: Microsoft.CognitiveServices (#4657) - Serices -> Services - Congitive -> Cognitive - proprties -> properties --- .../preview/2016-02-01-preview/cognitiveservices.json | 6 +++--- .../stable/2017-04-18/cognitiveservices.json | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json index a026e4757532..d50275e153d3 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/preview/2016-02-01-preview/cognitiveservices.json @@ -220,7 +220,7 @@ "$ref": "#/definitions/CognitiveServicesAccount" }, "examples": { - "application/json": "{\n \"id\": \"/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}\",\n \"name\": \"{name}\",\n \"type\": \"Microsoft.CognitiveSerices/accounts\",\n \"location\": \"North US\",\n \"tags\": {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n },\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t} \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n}" + "application/json": "{\n \"id\": \"/subscriptions/{id}/resourceGroups/{group}/providers/{rpns}/{type}/{name}\",\n \"name\": \"{name}\",\n \"type\": \"Microsoft.CognitiveServices/accounts\",\n \"location\": \"North US\",\n \"tags\": {\n \"key1\": \"value 1\",\n \"key2\": \"value 2\"\n },\n \"kind\" : \"resource kind\",\n \"sku\": {\n\t \"name\": \"sku code\"\n\t} \n \"etag\": \"00000000-0000-0000-0000-000000000000\",\n \"properties\": { }\n}" } }, "default": { @@ -333,7 +333,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the cognitive services account within the specified resource group. Congitive Services account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", + "description": "The name of the cognitive services account within the specified resource group. Cognitive Services account names must be between 3 and 24 characters in length and use numbers and lower-case letters only. ", "maxLength": 24, "minLength": 3, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$" @@ -594,7 +594,7 @@ "description": "The SKU of the cognitive services account." }, "CognitiveServicesAccountPropertiesCreateParameters": { - "description": "required empty proprties object. Must be an empty object, and must exist in the request." + "description": "required empty properties object. Must be an empty object, and must exist in the request." }, "CognitiveServicesAccount": { "description": "Cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.", diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json index f9d6903ce0b3..b2d89bb0da59 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json @@ -663,7 +663,7 @@ "schema": { "$ref": "#/definitions/CheckSkuAvailabilityParameter" }, - "description": "Check SKU Availablity POST body." + "description": "Check SKU Availability POST body." } ], "responses": { From 1b95b5954ecf4e659b115bfd53e526364aa70eca Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:09:05 -0500 Subject: [PATCH 295/464] typo: notificationhubs/resource-manager/Microsoft.NotificationHubs (#4722) - Aauthorization -> Authorization - Availibility -> Availability - availabile -> available - Pproperties -> Properties - APNS capitalization - MPNS capitalization - Regenrate -> Regenerate - notificationhub -> NotificationHub - reponse -> response --- .../stable/2014-09-01/notificationhubs.json | 4 +- .../stable/2016-03-01/notificationhubs.json | 14 +++---- .../stable/2017-04-01/notificationhubs.json | 40 +++++++++---------- 3 files changed, 29 insertions(+), 29 deletions(-) diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json index 4128e59850d1..4197986d223b 100644 --- a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2014-09-01/notificationhubs.json @@ -241,7 +241,7 @@ "in": "path", "required": true, "type": "string", - "description": "Aauthorization Rule Name." + "description": "Authorization Rule Name." }, { "name": "parameters", @@ -1163,7 +1163,7 @@ "description": "Gets or sets true if the name is available and can be used to create new Namespace/NotificationHub. Otherwise false." } }, - "description": "Description of a CheckAvailibility resource." + "description": "Description of a CheckAvailability resource." }, "NamespaceProperties": { "properties": { diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json index 02ea9d9b7924..3d5ecb386502 100644 --- a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2016-03-01/notificationhubs.json @@ -65,7 +65,7 @@ ], "responses": { "200": { - "description": "Checks if the Namespace name is a valid availabile name", + "description": "Checks if the Namespace name is a valid available name", "schema": { "$ref": "#/definitions/CheckAvailabilityResult" } @@ -287,7 +287,7 @@ "in": "path", "required": true, "type": "string", - "description": "Aauthorization Rule Name." + "description": "Authorization Rule Name." }, { "name": "parameters", @@ -664,7 +664,7 @@ ], "responses": { "200": { - "description": "Checks if the NotificationHub name is a valid availabile name", + "description": "Checks if the NotificationHub name is a valid available name", "schema": { "$ref": "#/definitions/CheckAvailabilityResult" } @@ -1299,7 +1299,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Description of a CheckAvailibility resource." + "description": "Description of a CheckAvailability resource." }, "NamespaceProperties": { "properties": { @@ -1460,7 +1460,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", - "description": "Pproperties of the Namespace AuthorizationRule." + "description": "Properties of the Namespace AuthorizationRule." } }, "allOf": [ @@ -1552,7 +1552,7 @@ }, "thumbprint": { "type": "string", - "description": "The Apns certificate Thumbprint" + "description": "The APNS certificate Thumbprint" } }, "description": "Description of a NotificationHub ApnsCredential." @@ -1629,7 +1629,7 @@ }, "thumbprint": { "type": "string", - "description": "The Mpns certificate Thumbprint" + "description": "The MPNS certificate Thumbprint" } }, "description": "Description of a NotificationHub MpnsCredential." diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json index 4b324fbb5659..69e745a9ea1d 100644 --- a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json @@ -101,7 +101,7 @@ ], "responses": { "200": { - "description": "Checks if the Namespace name is a valid availabile name", + "description": "Checks if the Namespace name is a valid available name", "schema": { "$ref": "#/definitions/CheckAvailabilityResult" } @@ -345,7 +345,7 @@ "in": "path", "required": true, "type": "string", - "description": "Aauthorization Rule Name." + "description": "Authorization Rule Name." }, { "name": "parameters", @@ -648,7 +648,7 @@ "Namespaces" ], "x-ms-examples": { - "NameSpaceAuthorizationRuleRegenrateKey": { + "NameSpaceAuthorizationRuleRegenerateKey": { "$ref": "./examples/Namespaces/NHNameSpaceAuthorizationRuleRegenrateKey.json" } }, @@ -747,7 +747,7 @@ ], "responses": { "200": { - "description": "Checks if the NotificationHub name is a valid availabile name", + "description": "Checks if the NotificationHub name is a valid available name", "schema": { "$ref": "#/definitions/CheckAvailabilityResult" } @@ -761,7 +761,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubCreate": { + "NotificationHubCreate": { "$ref": "./examples/NotificationHubs/NotificationHubCreate.json" } }, @@ -825,7 +825,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubPatch": { + "NotificationHubPatch": { "$ref": "./examples/NotificationHubs/NotificationHubPatch.json" } }, @@ -883,7 +883,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubDelete": { + "NotificationHubDelete": { "$ref": "./examples/NotificationHubs/NotificationHubDelete.json" } }, @@ -929,7 +929,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubGet": { + "NotificationHubGet": { "$ref": "./examples/NotificationHubs/NotificationHubGet.json" } }, @@ -1040,7 +1040,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleCreate": { + "NotificationHubAuthorizationRuleCreate": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleCreate.json" } }, @@ -1105,7 +1105,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleDelete": { + "NotificationHubAuthorizationRuleDelete": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleDelete.json" } }, @@ -1161,7 +1161,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleGet": { + "NotificationHubAuthorizationRuleGet": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleGet.json" } }, @@ -1219,7 +1219,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubListByNameSpace": { + "NotificationHubListByNameSpace": { "$ref": "./examples/NotificationHubs/NotificationHubListByNameSpace.json" } }, @@ -1266,7 +1266,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleListAll": { + "NotificationHubAuthorizationRuleListAll": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleListAll.json" } }, @@ -1320,7 +1320,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleListKey": { + "NotificationHubAuthorizationRuleListKey": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleListKey.json" } }, @@ -1378,7 +1378,7 @@ "NotificationHubs" ], "x-ms-examples": { - "notificationhubAuthorizationRuleRegenrateKey": { + "NotificationHubAuthorizationRuleRegenrateKey": { "$ref": "./examples/NotificationHubs/NotificationHubAuthorizationRuleRegenrateKey.json" } }, @@ -1542,7 +1542,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates NotificationHubs service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { @@ -1608,7 +1608,7 @@ "$ref": "#/definitions/Resource" } ], - "description": "Description of a CheckAvailibility resource." + "description": "Description of a CheckAvailability resource." }, "NamespaceProperties": { "properties": { @@ -1818,7 +1818,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/SharedAccessAuthorizationRuleProperties", - "description": "Pproperties of the Namespace AuthorizationRule." + "description": "Properties of the Namespace AuthorizationRule." } }, "allOf": [ @@ -1910,7 +1910,7 @@ }, "thumbprint": { "type": "string", - "description": "The Apns certificate Thumbprint" + "description": "The APNS certificate Thumbprint" }, "keyId": { "type": "string", @@ -2003,7 +2003,7 @@ }, "thumbprint": { "type": "string", - "description": "The Mpns certificate Thumbprint" + "description": "The MPNS certificate Thumbprint" } }, "description": "Description of a NotificationHub MpnsCredential." From 8459f064e6d29060cc6abd3293b0232cdd371792 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:09:29 -0500 Subject: [PATCH 296/464] typo: machinelearningservices/resource-manager/Microsoft.MachineLearningServices (#4706) - SSL capitalization - configugation -> configuration - creadentials -> credentials --- .../preview/2018-03-01-preview/machineLearningServices.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json index 6d9dcc5df093..6b91c6bc4f85 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json @@ -1371,10 +1371,10 @@ }, "SslConfiguration": { "type": "object", - "description": "The ssl configugation for scoring", + "description": "The SSL configuration for scoring", "properties": { "status": { - "description": "Enable or disable ssl for scoring", + "description": "Enable or disable SSL for scoring", "type": "string", "enum": [ "Disabled", @@ -1485,7 +1485,7 @@ "type": "object", "properties": { "administratorAccount": { - "description": "Admin creadentials for virtual machine.", + "description": "Admin credentials for virtual machine.", "$ref": "#/definitions/VirtualMachineSshCredentials" } } From f0eff4b3ad29635d242518bb332b0a0452eee8e1 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:10:19 -0500 Subject: [PATCH 297/464] typo: Microsoft.GuestConfiguration (#4694) - implmented -> implemented - assingment -> assignment - configuation -> configuration - trim trailing whitespace --- .../2018-01-20-preview/guestconfiguration.json | 6 +++--- .../2018-06-30-preview/guestconfiguration.json | 16 ++++++++-------- .../resource-manager/readme.md | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json index e16267809259..ced6beeadd7f 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json @@ -117,7 +117,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -172,7 +172,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -352,7 +352,7 @@ "enum": [ "DSC" ] - }, + }, "name": { "type": "string", "readOnly": true, diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json index d8ebd72c88e2..c64c31464d6b 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json @@ -111,7 +111,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -217,7 +217,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -397,7 +397,7 @@ "enum": [ "DSC" ] - }, + }, "name": { "type": "string", "description": "Name of the guest configuration." @@ -458,7 +458,7 @@ "ApplyOnly", "ApplyAndMonitor", "ApplyAndAutoCorrect" - ] + ] }, "allowModuleOverwrite": { "type": "string", @@ -470,7 +470,7 @@ "enum": [ "True", "False" - ] + ] }, "actionAfterReboot": { "type": "string", @@ -483,7 +483,7 @@ "enum": [ "ContinueConfiguration", "StopConfiguration" - ] + ] }, "refreshFrequencyMins": { "type": "number", @@ -503,7 +503,7 @@ "enum": [ "True", "False" - ] + ] }, "configurationModeFrequencyMins": { "type": "number", @@ -758,7 +758,7 @@ "properties": { "type": "object", "readOnly": true, - "description": "Properties of a guest configuation assignment resource." + "description": "Properties of a guest configuration assignment resource." } }, "description": "The guest configuration assignment resource." diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 32162bcc1210..f6c920d0d5bb 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -55,7 +55,7 @@ directive: - suppress: OperationsAPIImplementation from: guestconfiguration.json where: $.paths - reason: Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implmented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + reason: Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implemented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540 ``` --- # Code Generation From 0a5d37b3b4bc95caa27b5b725ea442c9ca92375b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:11:37 -0500 Subject: [PATCH 298/464] typo: Microsoft.CostManagement (#4668) - acount -> account - dategory -> category - upto -> up to - atleast -> at least - comaprison -> comparison - exeuction -> execution - occuring -> occurring - overriden -> overridden - managment -. management --- .../2018-08-01-preview/costmanagement.json | 30 +++++++++---------- .../2018-12-01-preview/costmanagement.json | 26 ++++++++-------- .../stable/2018-05-31/costmanagement.json | 16 +++++----- .../stable/2018-08-31/costmanagement.json | 26 ++++++++-------- 4 files changed, 49 insertions(+), 49 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json index 2cada3c5bc95..39a8195423e8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json @@ -475,7 +475,7 @@ "Reports" ], "operationId": "Reports_GetByBillingAccount", - "description": "Gets the report for a billing acount by report name.", + "description": "Gets the report for a billing account by report name.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1105,7 +1105,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -1178,7 +1178,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -1254,7 +1254,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -2355,7 +2355,7 @@ }, "aggregation": { "type": "object", - "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have upto 2 aggregation clauses.", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", "additionalProperties": { "type": "object", "$ref": "#/definitions/ReportAggregation" @@ -2363,7 +2363,7 @@ "maxItems": 2 }, "grouping": { - "description": "Array of group by expression to use in the report. Report can have upto 2 group by clauses.", + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", "type": "array", "items": { "$ref": "#/definitions/ReportGrouping" @@ -2434,7 +2434,7 @@ "description": "The filter expression to be used in the report.", "properties": { "and": { - "description": "The logical \"AND\" expression. Must have atleast 2 items.", + "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportFilter" @@ -2442,7 +2442,7 @@ "minItems": 2 }, "or": { - "description": "The logical \"OR\" expression. Must have atleast 2 items.", + "description": "The logical \"OR\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportFilter" @@ -2479,7 +2479,7 @@ "description": "The comparison expression to be used in the report.", "properties": { "name": { - "description": "The name of the column to use in comaprison.", + "description": "The name of the column to use in comparison.", "type": "string" }, "operator": { @@ -2522,7 +2522,7 @@ } }, "ReportExecution" : { - "description": "A report exeuction.", + "description": "A report execution.", "type": "object", "allOf": [ { @@ -2756,7 +2756,7 @@ "x-ms-mutability": [ "read", "create" - ], + ], "description": "Connector location" }, "tags": { @@ -2770,7 +2770,7 @@ "update" ], "description": "Resource tags." - }, + }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ConnectorProperties", @@ -2923,7 +2923,7 @@ "errorStartTime": { "format": "date-time", "type": "string", - "description": "Time the error started occuring (Last time error occurred in lastRun)", + "description": "Time the error started occurring (Last time error occurred in lastRun)", "readOnly": true } } @@ -2964,7 +2964,7 @@ "type": "string", "readOnly": true, "description": "Alert type" - }, + }, "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/AlertProperties", @@ -3024,7 +3024,7 @@ }, "closeTime": { "format": "date-time", - "description": "The time when the alert was closed (resolved / overriden).", + "description": "The time when the alert was closed (resolved / overridden).", "type": "string", "readOnly": true }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json index f0d08a3877cb..b670354f6fd2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json @@ -71,7 +71,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -153,7 +153,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -235,7 +235,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -314,7 +314,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -387,7 +387,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -565,7 +565,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -1048,7 +1048,7 @@ "Query" ], "operationId": "Query_UsageByManagmentGroup", - "description": "Lists the usage data for managment group.", + "description": "Lists the usage data for management group.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1102,7 +1102,7 @@ "Forecast" ], "operationId": "Forecast_UsageByManagmentGroup", - "description": "Lists the usage data for managment group.", + "description": "Lists the usage data for management group.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1318,7 +1318,7 @@ }, "aggregation": { "type": "object", - "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have upto 2 aggregation clauses.", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", "additionalProperties": { "type": "object", "$ref": "#/definitions/ReportConfigAggregation" @@ -1326,7 +1326,7 @@ "maxItems": 2 }, "grouping": { - "description": "Array of group by expression to use in the report. Report can have upto 2 group by clauses.", + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigGrouping" @@ -1424,7 +1424,7 @@ "description": "The filter expression to be used in the report.", "properties": { "and": { - "description": "The logical \"AND\" expression. Must have atleast 2 items.", + "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1432,7 +1432,7 @@ "minItems": 2 }, "or": { - "description": "The logical \"OR\" expression. Must have atleast 2 items.", + "description": "The logical \"OR\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1469,7 +1469,7 @@ "description": "The comparison expression to be used in the report.", "properties": { "name": { - "description": "The name of the column to use in comaprison.", + "description": "The name of the column to use in comparison.", "type": "string" }, "operator": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json index c3f48d02dfdc..3ce524b918b2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-05-31/costmanagement.json @@ -429,7 +429,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -502,7 +502,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -578,7 +578,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -1094,7 +1094,7 @@ }, "aggregation": { "type": "object", - "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have upto 2 aggregation clauses.", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", "additionalProperties": { "type": "object", "$ref": "#/definitions/ReportConfigAggregation" @@ -1102,7 +1102,7 @@ "maxItems": 2 }, "grouping": { - "description": "Array of group by expression to use in the report. Report can have upto 2 group by clauses.", + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigGrouping" @@ -1173,7 +1173,7 @@ "description": "The filter expression to be used in the report.", "properties": { "and": { - "description": "The logical \"AND\" expression. Must have atleast 2 items.", + "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1181,7 +1181,7 @@ "minItems": 2 }, "or": { - "description": "The logical \"OR\" expression. Must have atleast 2 items.", + "description": "The logical \"OR\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1218,7 +1218,7 @@ "description": "The comparison expression to be used in the report.", "properties": { "name": { - "description": "The name of the column to use in comaprison.", + "description": "The name of the column to use in comparison.", "type": "string" }, "operator": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-08-31/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-08-31/costmanagement.json index a141c061f34a..dd01495755a9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-08-31/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2018-08-31/costmanagement.json @@ -71,7 +71,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -153,7 +153,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -235,7 +235,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -314,7 +314,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -387,7 +387,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -463,7 +463,7 @@ }, { "name": "$expand", - "description": "May be used to expand the properties/data within a dimension dategory. By default, data is not included when listing dimensions.", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", "in": "query", "required": false, "type": "string" @@ -789,7 +789,7 @@ "Query" ], "operationId": "Query_UsageByManagmentGroup", - "description": "Lists the usage data for managment group.", + "description": "Lists the usage data for management group.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1005,7 +1005,7 @@ }, "aggregation": { "type": "object", - "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have upto 2 aggregation clauses.", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", "additionalProperties": { "type": "object", "$ref": "#/definitions/ReportConfigAggregation" @@ -1013,7 +1013,7 @@ "maxItems": 2 }, "grouping": { - "description": "Array of group by expression to use in the report. Report can have upto 2 group by clauses.", + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigGrouping" @@ -1069,7 +1069,7 @@ "name", "function" ] - }, + }, "ReportConfigSorting": { "description": "The order by expression to be used in the report.", "properties": { @@ -1111,7 +1111,7 @@ "description": "The filter expression to be used in the report.", "properties": { "and": { - "description": "The logical \"AND\" expression. Must have atleast 2 items.", + "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1119,7 +1119,7 @@ "minItems": 2 }, "or": { - "description": "The logical \"OR\" expression. Must have atleast 2 items.", + "description": "The logical \"OR\" expression. Must have at least 2 items.", "type": "array", "items": { "$ref": "#/definitions/ReportConfigFilter" @@ -1156,7 +1156,7 @@ "description": "The comparison expression to be used in the report.", "properties": { "name": { - "description": "The name of the column to use in comaprison.", + "description": "The name of the column to use in comparison.", "type": "string" }, "operator": { From 805e188cb7cda3b7117bca0a8ed67370d234362a Mon Sep 17 00:00:00 2001 From: Kedar Joshi Date: Mon, 3 Dec 2018 23:14:11 -0800 Subject: [PATCH 299/464] API Management service SKU API documentation (#4466) * added API management SKUS API documentation * added API management SKUS API documentation * added consumption sku definition as well in preview api version * added consumption sku definition as well in preview api version * added example * PR comments addressed * more PR comment fixes * correct casing --- .../2018-06-01-preview/apimdeployment.json | 185 +++++++++++++++++- .../ApiManagementListSKUs-Consumption.json | 24 +++ .../ApiManagementListSKUs-Dedicated.json | 65 ++++++ .../stable/2018-01-01/apimdeployment.json | 156 +++++++++++++++ .../examples/ApiManagementListSKUs.json | 65 ++++++ 5 files changed, 494 insertions(+), 1 deletion(-) create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Consumption.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Dedicated.json create mode 100644 specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSKUs.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json index 738d97051979..fa3f95b7bf20 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimdeployment.json @@ -64,6 +64,49 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": { + "get": { + "tags": [ + "ApiManagementServiceSkus" + ], + "summary": "Gets available SKUs for API Management service", + "description": "Gets all available SKU for a given API Management service", + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "x-ms-examples": { + "ApiManagementListSKUs-Dedicated": { + "$ref": "./examples/ApiManagementListSKUs-Dedicated.json" + }, + "ApiManagementListSKUs-Consumption": { + "$ref": "./examples/ApiManagementListSKUs-Consumption.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SKUs.", + "schema": { + "$ref": "#/definitions/ResourceSkuResults" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { "post": { "tags": [ @@ -646,6 +689,141 @@ } }, "definitions": { + "ResourceSkuResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuResult" + }, + "description": "The list of skus available for the service." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management service Skus." + } + }, + "required": [ + "value" + ], + "description": "The API Management service SKUs operation response." + }, + "ResourceSkuResult": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "readOnly": true, + "description": "Specifies API Management SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of API Management units." + } + }, + "description": "Describes an available API Management service SKU." + }, + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": true, + "values": [ + { + "value": "automatic", + "description": "Supported scale type automatic." + }, + { + "value": "manual", + "description": "Supported scale type manual." + }, + { + "value": "none", + "description": "Scaling not supported." + } + ] + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic", + "Consumption" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." + } + ] + } + } + }, + "description": "Describes an available API Management SKU." + }, "CertificateInformation": { "properties": { "expiry": { @@ -1022,7 +1200,8 @@ "Developer", "Standard", "Premium", - "Basic" + "Basic", + "Consumption" ], "x-ms-enum": { "name": "SkuType", @@ -1043,6 +1222,10 @@ { "value": "Basic", "description": "Basic SKU of Api Management." + }, + { + "value": "Consumption", + "description": "Consumption SKU of Api Management." } ] } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Consumption.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Consumption.json new file mode 100644 index 000000000000..e1e8a0389c81 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Consumption.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Consumption" + }, + "capacity": null + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Dedicated.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Dedicated.json new file mode 100644 index 000000000000..f015537bb4ee --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementListSKUs-Dedicated.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-06-01-preview", + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Developer" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "none" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Basic" + }, + "capacity": { + "minimum": 1, + "maximum": 2, + "default": 1, + "scaleType": "manual" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "automatic" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Premium" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "automatic" + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json index a3a6d8bc8496..b97403a1359d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/apimdeployment.json @@ -64,6 +64,46 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/skus": { + "get": { + "tags": [ + "ApiManagementServiceSkus" + ], + "summary": "Gets available SKUs for API Management service", + "description": "Gets all available SKU for a given API Management service", + "operationId": "ApiManagementServiceSkus_ListAvailableServiceSkus", + "x-ms-examples": { + "ApiManagementListSKUs": { + "$ref": "./examples/ApiManagementListSKUs.json" + } + }, + "parameters": [ + { + "$ref": "./apimanagement.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ServiceNameParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./apimanagement.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SKUs.", + "schema": { + "$ref": "#/definitions/ResourceSkuResults" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore": { "post": { "tags": [ @@ -646,6 +686,122 @@ } }, "definitions": { + "ResourceSkuResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuResult" + }, + "description": "The list of skus available for the service." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of API Management service Skus." + } + }, + "required": [ + "value" + ], + "description": "The API Management service SKUs operation response." + }, + "ResourceSkuResult": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "sku": { + "$ref": "#/definitions/ResourceSku", + "readOnly": true, + "description": "Specifies API Management SKU." + }, + "capacity": { + "$ref": "#/definitions/ResourceSkuCapacity", + "readOnly": true, + "description": "Specifies the number of API Management units." + } + }, + "description": "Describes an available API Management service SKU." + }, + "ResourceSkuCapacity": { + "properties": { + "minimum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The minimum capacity." + }, + "maximum": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The maximum capacity that can be set." + }, + "default": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The default capacity." + }, + "scaleType": { + "type": "string", + "readOnly": true, + "description": "The scale type applicable to the sku.", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "ResourceSkuCapacityScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a SKU." + }, + "ResourceSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Sku.", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/pricing/details/api-management/" + }, + "enum": [ + "Developer", + "Standard", + "Premium", + "Basic" + ], + "x-ms-enum": { + "name": "SkuType", + "modelAsString": true, + "values": [ + { + "value": "Developer", + "description": "Developer SKU of Api Management." + }, + { + "value": "Standard", + "description": "Standard SKU of Api Management." + }, + { + "value": "Premium", + "description": "Premium SKU of Api Management." + }, + { + "value": "Basic", + "description": "Basic SKU of Api Management." + } + ] + } + } + }, + "description": "Describes an available API Management SKU." + }, "CertificateInformation": { "properties": { "expiry": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSKUs.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSKUs.json new file mode 100644 index 000000000000..0fbbf306b526 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2018-01-01/examples/ApiManagementListSKUs.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-01-01", + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Developer" + }, + "capacity": { + "minimum": 1, + "maximum": 1, + "default": 1, + "scaleType": "none" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Basic" + }, + "capacity": { + "minimum": 1, + "maximum": 2, + "default": 1, + "scaleType": "manual" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 4, + "default": 1, + "scaleType": "automatic" + } + }, + { + "resourceType": "Microsoft.ApiManagement/service", + "sku": { + "name": "Premium" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "automatic" + } + } + ], + "nextLink": null + } + } + } +} \ No newline at end of file From a5166b0b07d33beebe1b9d51a3991077541174ec Mon Sep 17 00:00:00 2001 From: Manoj Soni Date: Mon, 3 Dec 2018 23:16:12 -0800 Subject: [PATCH 300/464] Changed machinelearning swagger for new AMLCompute type (#4344) * Adding new GA version 2018-12-01 * Changed machinelearning swagger for new AMLCompute for 1RP changes * Added Supported VMSize List API * replacing tabs with spaces * removing batchai reference from examples * renaming example files from batchai to amlcompute * missed adding renamed files in previous commit * Added remaining examples * removed tabs * adding more swagger improvements * removing resource id * added usage api swagger changes * CR feedbacks * CR feedbacks, examples corrected * autorest fixes * Adding patchAMLCompute.json * build fix for patch operation * AML GA Swagger updates: Changed machinelearning swagger for new AMLCompute type for GA version * updated api version to 2018-11-19 * CR feedbacks readonly * adding missing computes * removing deprecated api * version change * changing version * make patch compute long running operation * Add underlyingResourceAction and isAttachedCompute in machineLearningServices.json * Update deleteCompute.json sample * add enum and x-ms-enum for UnderlyingResourceAction * Update Delete/Detach casing just to be safe (although case doesn't matter) * Fixing AmlCompute * renaming files * renaming * adding properties for aks vnet support * patch swagger update * Added useraccount settings and list remote login info API for aml compute * remove unused param * list nodes * swagger build fixes * updated swagger for listnodes response simplification * rename to user account credentials * Changing vmPriority and allocationState to match MLC and other conventions --- .../2018-11-19/examples/ListUsages.json | 168 ++ .../examples/amlComputeListNodes.json | 29 + .../examples/createBasicAKSCompute.json | 44 + .../examples/createBasicAmlCompute.json | 53 + .../createBasicDataFactoryCompute.json | 44 + .../2018-11-19/examples/createWorkspace.json | 57 + .../2018-11-19/examples/deleteCompute.json | 19 + .../2018-11-19/examples/deleteWorkspace.json | 12 + .../2018-11-19/examples/getAKSCompute.json | 25 + .../2018-11-19/examples/getAmlCompute.json | 48 + .../2018-11-19/examples/getComputes.json | 41 + .../2018-11-19/examples/getWorkspace.json | 28 + .../getWorkspacesByResourceGroup.json | 48 + .../examples/getWorkspacesBySubscription.json | 47 + .../examples/listAmlComputeByWorkspace.json | 48 + .../examples/listKeysAKSCompute.json | 19 + .../examples/listKeysVirtualMachine.json | 22 + .../examples/listWorkspaceKeys.json | 32 + .../2018-11-19/examples/patchAmlCompute.json | 38 + .../examples/resyncWorkspaceKeys.json | 13 + .../examples/systemUpdateCompute.json | 18 + .../2018-11-19/examples/updateAKSCompute.json | 54 + .../2018-11-19/examples/updateAmlCompute.json | 57 + .../2018-11-19/examples/updateWorkspace.json | 34 + .../2018-11-19/machineLearningServices.json | 2182 +++++++++++++++++ 25 files changed, 3180 insertions(+) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/ListUsages.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicDataFactoryCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getComputes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesByResourceGroup.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysVirtualMachine.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/patchAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/resyncWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/systemUpdateCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/ListUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/ListUsages.json new file mode 100644 index 000000000000..65cdaf787a84 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/ListUsages.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 5, + "limit": 20, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "currentValue": 49, + "limit": 600, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 1, + "limit": 600, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 600, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 48, + "limit": 600, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 600, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Total Cluster Low Priority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard D Family Cluster Low Priority vCPUs", + "value": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Low Priority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard NC Family Cluster Low Priority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Low Priority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Low Priority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Low Priority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "currentValue": 0, + "limit": 150, + "name": { + "localizedValue": "Standard NV Family Cluster Low Priority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json new file mode 100644 index 000000000000..8d3f4773138c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "computeType": "AmlCompute", + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "ipAddress": "13.84.190.124", + "port": 50000 + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "ipAddress": "13.84.190.124", + "port": 50001 + } + ], + "nextLink": "nextLink", + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAKSCompute.json new file mode 100644 index 000000000000..763ca7c957be --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAmlCompute.json new file mode 100644 index 000000000000..c0952d5682e4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicAmlCompute.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicDataFactoryCompute.json new file mode 100644 index 000000000000..d89a89bfc87d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createBasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createWorkspace.json new file mode 100644 index 000000000000..c99586ab73e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/createWorkspace.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-11-19", + "parameters": { + "location": "eastus2euap", + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteCompute.json new file mode 100644 index 000000000000..81b909f7c33d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json new file mode 100644 index 000000000000..b123776bc765 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-11-19" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAKSCompute.json new file mode 100644 index 000000000000..cb6ce2fd383a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAKSCompute.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json new file mode 100644 index 000000000000..9e25f6eecf60 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + } + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getComputes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getComputes.json new file mode 100644 index 000000000000..b1fbecad5e4e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getComputes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspace.json new file mode 100644 index 000000000000..bf41ee9580da --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspace.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesByResourceGroup.json new file mode 100644 index 000000000000..5ccdd16054b9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesBySubscription.json new file mode 100644 index 000000000000..a1f5f308230f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getWorkspacesBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json new file mode 100644 index 000000000000..bf00f5370e39 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "resourceGroupName": "demo_resource_group", + "workspaceName": "demo_workspace", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/demo_resource_group/providers/Microsoft.MachineLearningServices/workspace/demo_workspace/clusters/demo_cluster", + "name": "demo_cluster", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "properties": { + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "succeeded", + "properties": { + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + } + } + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysAKSCompute.json new file mode 100644 index 000000000000..b4220168f8b5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysAKSCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysVirtualMachine.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysVirtualMachine.json new file mode 100644 index 000000000000..6a2fd603309a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listKeysVirtualMachine.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "administratorAccount": { + "username": "the user name", + "password": "the password", + "publicKeyData": "public key...", + "privateKeyData": "private key..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listWorkspaceKeys.json new file mode 100644 index 000000000000..4e63cbdd709e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listWorkspaceKeys.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + "body": + { + "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==", + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/patchAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/patchAmlCompute.json new file mode 100644 index 000000000000..ce56dbb81b5a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/patchAmlCompute.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "properties": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/resyncWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/resyncWorkspaceKeys.json new file mode 100644 index 000000000000..04af733658f7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/resyncWorkspaceKeys.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2018-11-19" + }, + "responses": { + "200": { + + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/systemUpdateCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/systemUpdateCompute.json new file mode 100644 index 000000000000..6b00e081a14a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/systemUpdateCompute.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json new file mode 100644 index 000000000000..f91b6b991dea --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "id": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json new file mode 100644 index 000000000000..9e1c1b5e78e4 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2018-11-19", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateWorkspace.json new file mode 100644 index 000000000000..6bbd49527892 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateWorkspace.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2018-11-19", + "parameters": { + "properties": { + "friendlyName": "New friendly name", + "description": "new description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "New friendly name", + "description": "new description" + } + } + } + } +} \ No newline at end of file diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json new file mode 100644 index 000000000000..55c2232bad05 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json @@ -0,0 +1,2182 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2018-11-19" + }, + "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.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces 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/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { "$ref": "./examples/getWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-examples": { + "Create Workspace": { "$ref": "./examples/createWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "Delete Workspace": { "$ref": "./examples/deleteWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-examples": { + "Update Workspace": { "$ref": "./examples/updateWorkspace.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { "$ref": "./examples/getWorkspacesByResourceGroup.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { "$ref": "./examples/listWorkspaceKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-examples": { + "Resync Workspace Keys": { "$ref": "./examples/resyncWorkspaceKeys.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { "$ref": "./examples/getWorkspacesBySubscription.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningCompute_ListByWorkspace", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { "$ref": "./examples/getComputes.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { "$ref": "./examples/getAKSCompute.json" }, + "Get a AML Compute": { "$ref": "./examples/getAmlCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { "$ref": "./examples/createBasicAmlCompute.json" }, + "Create AKS Compute": { "$ref": "./examples/createBasicAKSCompute.json" }, + "Create a DataFactory Compute": { "$ref": "./examples/createBasicDataFactoryCompute.json" }, + "Update a AML Compute": { "$ref": "./examples/updateAmlCompute.json" }, + "Update a AKS Compute": { "$ref": "./examples/updateAKSCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { "$ref": "./examples/patchAmlCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "202": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { "$ref": "./examples/deleteCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/ComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/amlComputeListNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { "$ref": "./examples/listKeysAKSCompute.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription identifier.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "Name of the resource group in which workspace is located.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Version of Azure Machine Learning resource provider API.", + "required": true + }, + "PaginationParameter": { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" +} + }, + "definitions": { + "Operation": { + "description": "Azure Machine Learning workspace 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.MachineLearningExperimentation", + "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 AML workspace operations supported by the AML workspace resource provider." + } + } + }, + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of the machine learning workspace in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + } + } + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "amlCompute": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the resource." + }, + "Resource": { + "description": "Azure Resource Manager resource envelope.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "readOnly": true, + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ResourceId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string" + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string" + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + } + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties":{ + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + } + ] + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute." + }, + "createdOn": { + "type": "string", + "description": "The date and time when the compute was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The date and time when the compute was last modified.", + "format": "date-time", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute" + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + }, + "readOnly": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string" + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "readOnly": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "minimum": 1 + }, + "agentVMSize": { + "description": "Agent virtual machine size", + "type": "string" + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration" + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "AML Compute properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + } + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute." + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation." + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "ServicePrincipalCredentials": { + "type": "object", + "description": "Service principal credentials.", + "properties": { + "clientId": { + "description": "Client Id", + "type": "string" + }, + "clientSecret": { + "description": "Client secret", + "type": "string" + } + }, + "required": [ + "clientId", + "clientSecret" + ] + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configugation for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ] + }, + "cert": { + "description": "Cert data", + "type": "string" + }, + "key": { + "description": "Key data", + "type": "string" + }, + "cname": { + "description": "CNAME of the cert", + "type": "string" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute" + } + }, + "required": [ + "maxNodeCount" + ] + }, + "NodeStateCounts": { + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ClusterUpdateProperties": { + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Desired scale settings for the amlCompute." + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "ComputeNodesInformation": { + "type": "object", + "description": "Compute nodes information related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "required": [ + "computeType" + ] + }, + "AmlComputeNodesInformation": { + "description": "Compute node information related to a AmlCompute.", + "allOf": [ + { + "$ref": "#/definitions/ComputeNodesInformation" + }, + { + "type": "object", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "description": "The collection of returned AmlCompute nodes details." + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeNodeInformation": { + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "ipAddress": { + "readOnly": true, + "type": "string", + "title": "IP address.", + "description": "Public IP address of the compute node." + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + } + }, + "x-ms-discriminator-value": "AmlCompute" + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string" + }, + "privateKeyData": { + "description": "Private key data", + "type": "string" + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret." + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin creadentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "AmlCompute", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "MachineLearningServiceError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse", + "readOnly": true + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Error message.", + "readOnly": true + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + } + } +} From bc1242333a5fe716facc05475ecd665b2a0af896 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:16:43 -0500 Subject: [PATCH 301/464] typo: Microsoft.DataLakeStore (#4677) - lexographical -> lexicographical - tooid -> tooId --- .../stable/2016-11-01/filesystem.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json index c7e80ed48e82..fe86a062c3e5 100644 --- a/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json +++ b/specification/datalake-store/data-plane/Microsoft.DataLakeStore/stable/2016-11-01/filesystem.json @@ -472,21 +472,21 @@ "in": "query", "required": false, "type": "string", - "description": "Gets or sets the item or lexographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional." + "description": "Gets or sets the item or lexicographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional." }, { "name": "listBefore", "in": "query", "required": false, "type": "string", - "description": "Gets or sets the item or lexographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional." + "description": "Gets or sets the item or lexicographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional." }, { "name": "tooId", "in": "query", "required": false, "type": "boolean", - "description": "An optional switch to return friendly names in place of owner and group. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." + "description": "An optional switch to return friendly names in place of owner and group. tooId=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." }, { "name": "op", @@ -593,7 +593,7 @@ "in": "query", "required": false, "type": "boolean", - "description": "An optional switch to return friendly names in place of owner and group. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." + "description": "An optional switch to return friendly names in place of owner and group. tooId=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." }, { "name": "op", @@ -1213,7 +1213,7 @@ "in": "query", "required": false, "type": "boolean", - "description": "An optional switch to return friendly names in place of object ID for ACL entries. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." + "description": "An optional switch to return friendly names in place of object ID for ACL entries. tooId=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs." }, { "name": "op", From 2535345d1055f1865523f5b5605759fbed77083a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 02:17:16 -0500 Subject: [PATCH 302/464] typo: cognitiveservices/data-plane/NewsSearch (#4654) - Double word "lets" --- .../data-plane/NewsSearch/stable/v1.0/NewsSearch.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json index 298d58342305..9118d279fa89 100644 --- a/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json +++ b/specification/cognitiveservices/data-plane/NewsSearch/stable/v1.0/NewsSearch.json @@ -258,7 +258,7 @@ }, "/news": { "get": { - "summary": "The News Category API lets lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", + "summary": "The News Category API lets you search on Bing and get back a list of top news articles by category. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", "operationId": "News_Category", "tags": [ "NewsCategory" @@ -446,7 +446,7 @@ }, "/news/trendingtopics": { "get": { - "summary": "The News Trending Topics API lets lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", + "summary": "The News Trending Topics API lets you search on Bing and get back a list of trending news topics that are currently trending on Bing. This section provides technical details about the query parameters and headers that you use to request news and the JSON response objects that contain them. For examples that show how to make requests, see [Searching the web for news](https://docs.microsoft.com/en-us/azure/cognitive-services/bing-news-search/search-the-web).", "operationId": "News_Trending", "tags": [ "NewsTrendingTopics" From 08249886dda08056aadcb30ced278b4996458210 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 07:39:42 -0500 Subject: [PATCH 303/464] typo: resources/resource-manager/Microsoft.Resources (#4755) - paramaters -> parameters - deploymentoutput -> deployment output - targetid -> targetId - informaton -> information - rsources -> resources - muct -> must --- .../stable/2015-11-01/resources.json | 4 ++-- .../stable/2016-02-01/resources.json | 4 ++-- .../stable/2016-07-01/resources.json | 4 ++-- .../Microsoft.Resources/stable/2016-09-01/links.json | 2 +- .../stable/2016-09-01/resources.json | 10 +++++----- .../stable/2017-05-10/resources.json | 6 +++--- .../stable/2018-02-01/resources.json | 6 +++--- .../stable/2018-05-01/resources.json | 6 +++--- 8 files changed, 21 insertions(+), 21 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json index 4520704e13f1..b853ef27a539 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/resources.json @@ -2215,7 +2215,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -2411,7 +2411,7 @@ }, "outputs": { "type": "object", - "description": "Gets or sets key/value pairs that represent deploymentoutput." + "description": "Gets or sets key/value pairs that represent deployment output." }, "providers": { "type": "array", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json index a5ca1179ff39..c44fc3aad6e0 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-02-01/resources.json @@ -1702,7 +1702,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -1946,7 +1946,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json index 89c387fbaf2c..02ab6f8245a5 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-07-01/resources.json @@ -1706,7 +1706,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -1954,7 +1954,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/links.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/links.json index 0ac6dd73b7b6..d5841cb56b5d 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/links.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/links.json @@ -173,7 +173,7 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply on the list resource links operation. The supported filter for list resource links is targetid. For example, $filter=targetid eq {value}" + "description": "The filter to apply on the list resource links operation. The supported filter for list resource links is targetId. For example, $filter=targetId eq {value}" }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json index 22fd72346f53..91e6cf5a9c4c 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-09-01/resources.json @@ -453,7 +453,7 @@ ], "responses": { "200": { - "description": "OK - Returns informatin about the resource provider.", + "description": "OK - Returns information about the resource provider.", "schema": { "$ref": "#/definitions/Provider" } @@ -932,7 +932,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the resource group containing the rsources to move.", + "description": "The name of the resource group containing the resources to move.", "pattern": "^[-\\w\\._\\(\\)]+$", "minLength": 1, "maxLength": 90 @@ -1945,7 +1945,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -2201,7 +2201,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", @@ -2466,7 +2466,7 @@ }, "location": { "type": "string", - "description": "The location of the resource group. It cannot be changed after the resource group has been created. It muct be one of the supported Azure locations." + "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations." }, "managedBy": { "type": "string", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json index b083edba5f23..cd2e78948043 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2017-05-10/resources.json @@ -453,7 +453,7 @@ ], "responses": { "200": { - "description": "OK - Returns informatin about the resource provider.", + "description": "OK - Returns information about the resource provider.", "schema": { "$ref": "#/definitions/Provider" } @@ -1994,7 +1994,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -2251,7 +2251,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json index 4620d6830dc1..d59181387f09 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-02-01/resources.json @@ -453,7 +453,7 @@ ], "responses": { "200": { - "description": "OK - Returns informatin about the resource provider.", + "description": "OK - Returns information about the resource provider.", "schema": { "$ref": "#/definitions/Provider" } @@ -1994,7 +1994,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -2255,7 +2255,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json index 13c788d880ff..e1fcaa1e7733 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-05-01/resources.json @@ -793,7 +793,7 @@ ], "responses": { "200": { - "description": "OK - Returns informatin about the resource provider.", + "description": "OK - Returns information about the resource provider.", "schema": { "$ref": "#/definitions/Provider" } @@ -2422,7 +2422,7 @@ "required": [ "uri" ], - "description": "Entity representing the reference to the deployment paramaters." + "description": "Entity representing the reference to the deployment parameters." }, "DeploymentProperties": { "properties": { @@ -2687,7 +2687,7 @@ }, "outputs": { "type": "object", - "description": "Key/value pairs that represent deploymentoutput." + "description": "Key/value pairs that represent deployment output." }, "providers": { "type": "array", From 216d3fe34c32f6daa2cc7cf9df143c106e0ded14 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 11:06:27 -0500 Subject: [PATCH 304/464] typo: resources/resource-manager/Microsoft.Features (#4754) - registerd -> registered --- .../Microsoft.Features/stable/2015-12-01/features.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json b/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json index ca28ad41d445..89cbd169245b 100644 --- a/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json +++ b/specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json @@ -219,7 +219,7 @@ ], "responses": { "200": { - "description": "OK - Returns metadata about the registerd feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", + "description": "OK - Returns metadata about the registered feature. The metadata includes the name of the feature, the registration state, the resource ID, and resource type.", "schema": { "$ref": "#/definitions/FeatureResult" } From f229d91f8129d42024ab16d7404d251a00349eb9 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Tue, 4 Dec 2018 08:59:37 -0800 Subject: [PATCH 305/464] Fix machinelearning generation for Node.js (#4739) --- .../resource-manager/readme.nodejs.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/specification/machinelearning/resource-manager/readme.nodejs.md b/specification/machinelearning/resource-manager/readme.nodejs.md index a8428e61d774..8030d3f7eec1 100644 --- a/specification/machinelearning/resource-manager/readme.nodejs.md +++ b/specification/machinelearning/resource-manager/readme.nodejs.md @@ -8,7 +8,14 @@ nodejs: azure-arm: true package-name: azure-arm-machinelearning output-folder: $(node-sdks-folder)/lib/services/machinelearning - generate-license-txt: true - generate-package-json: true - generate-readme-md: true + generate-license-txt: false + generate-package-json: false + generate-readme-md: false +batch: + - package-commitmentPlans: true + source-code-folder-path: lib/commitmentPlan + - package-webservices: true + source-code-folder-path: lib/webservices + - package-workspaces: true + source-code-folder-path: lib/workspaces ``` From 0ee2b4a782988ddc0c11c031d507e9ea01d0c73a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 12:01:52 -0500 Subject: [PATCH 306/464] typo: search/resource-manager/Microsoft.Search (#4758) - programatically -> programmatically - Trim trailing space --- .../Microsoft.Search/stable/2015-08-19/search.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json b/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json index 72f4eed18469..33549bd4f2b7 100644 --- a/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json +++ b/specification/search/resource-manager/Microsoft.Search/stable/2015-08-19/search.json @@ -894,7 +894,7 @@ "url": "https://aka.ms/search-rp-info" }, "x-ms-mutability": [ - "create", + "create", "read" ] }, @@ -928,13 +928,13 @@ "type": "object", "description": "Describes a particular API error with an error code and a message.", "properties": { - "code": { + "code": { "type": "string", - "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases." + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." }, "message": { "type": "string", - "description": "A message that describes the error in detail and provides debugging information." + "description": "A message that describes the error in detail and provides debugging information." }, "target": { "type": "string", From 47601eec13709a3d66a9607c03b26d42fcafeb57 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Tue, 4 Dec 2018 10:02:29 -0800 Subject: [PATCH 307/464] fix Go SDK codegen for labservices (#4767) Package name can't be upper-case characters. Make package name uniform with other SDKs. --- specification/labservices/resource-manager/readme.go.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/labservices/resource-manager/readme.go.md b/specification/labservices/resource-manager/readme.go.md index 21bb938142ce..b760fe2f8a35 100644 --- a/specification/labservices/resource-manager/readme.go.md +++ b/specification/labservices/resource-manager/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: ML + namespace: labservices clear-output-folder: true ``` @@ -16,12 +16,11 @@ batch: - tag: package-2018-10 ``` - ### Tag: package-2018-10 and go These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2018-10' && $(go) -output-folder: $(go-sdk-folder)/services/labservices/mgmt/2018-10-15/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-10-15/$(namespace) ``` From 1141e1c07e0ee0aa48ad0deb7cbc8fce6f94d04e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 13:27:51 -0500 Subject: [PATCH 308/464] typo: search/data-plane/Microsoft.Azure.Search.Data (#4757) - Autocomlete -> Autocomplete - Trim trailing space --- .../2017-11-11-preview/searchindex.json | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json index 1e02154dbd01..a1792858a7a3 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json @@ -4,10 +4,10 @@ "title": "SearchIndexClient", "description": "Client that can be used to query an Azure Search index and upload, merge, or delete documents.", "version": "2017-11-11-Preview", - "x-ms-code-generation-settings": { + "x-ms-code-generation-settings": { "useDateTimeOffset": true, - "syncMethods": "None" - } + "syncMethods": "None" + } }, "x-ms-parameterized-host": { "hostTemplate": "https://{searchServiceName}.{searchDnsSuffix}/indexes('{indexName}')", @@ -105,7 +105,7 @@ "twoTerms", "oneTermWithContext" ], - "x-ms-enum": { + "x-ms-enum": { "name": "AutocompleteMode", "modelAsString": false }, @@ -193,15 +193,15 @@ "operationId": "DocumentsProxy_AutocompletePost", "x-ms-examples": { "SearchIndexPostAutocomplete": { "$ref": "./examples/SearchIndexPostAutocomplete.json" } - }, - "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the Azure Search index.", "parameters": [ { "$ref": "#/parameters/ClientRequestIdParameter" }, { "$ref": "#/parameters/ApiVersionParameter" - }, + }, { "name": "AutocompleteRequest", "in": "body", @@ -224,7 +224,6 @@ } } } - } }, "definitions": { @@ -460,7 +459,7 @@ } }, "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." - }, + }, "AutocompleteRequest": { "properties": { "search": { @@ -505,7 +504,7 @@ } }, "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." - }, + }, "AutocompleteResult" : { "properties": { "value": { @@ -518,7 +517,7 @@ "x-ms-client-name": "Results" } }, - "description": "The result of Autocomlete query." + "description": "The result of Autocomplete query." }, "AutocompleteItem": { "properties": { From 56ee7e88f67b742aa8aa85bbbe76e9a4fb7c04fe Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 13:30:44 -0500 Subject: [PATCH 309/464] typo: redis/resource-manager/Microsoft.Cache (#4751) - subid -> subscriptionId - properites -> properties - occured -> occurred - Trim trailing space --- .../stable/2015-08-01/redis.json | 2 +- .../stable/2016-04-01/redis.json | 74 +++++++++---------- .../stable/2017-02-01/redis.json | 6 +- .../stable/2017-10-01/redis.json | 8 +- .../stable/2018-03-01/redis.json | 8 +- 5 files changed, 49 insertions(+), 49 deletions(-) diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json index 1a22fbfa0075..3fb151f817cf 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2015-08-01/redis.json @@ -443,7 +443,7 @@ }, "virtualNetwork": { "type": "string", - "description": "The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1" + "description": "The exact ARM resource ID of the virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.ClassicNetwork/VirtualNetworks/vnet1" }, "subnet": { "type": "string", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json index e30af2a9161a..2f05e60a35f5 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2016-04-01/redis.json @@ -65,8 +65,8 @@ "Redis" ], "operationId": "Redis_Create", - "x-ms-examples": { - "RedisCacheCreate": { "$ref": "./examples/RedisCacheCreate.json" } + "x-ms-examples": { + "RedisCacheCreate": { "$ref": "./examples/RedisCacheCreate.json" } }, "description": "Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.", "x-ms-long-running-operation": true, @@ -121,8 +121,8 @@ "Redis" ], "operationId": "Redis_Update", - "x-ms-examples": { - "RedisCacheUpdate": { "$ref": "./examples/RedisCacheUpdate.json" } + "x-ms-examples": { + "RedisCacheUpdate": { "$ref": "./examples/RedisCacheUpdate.json" } }, "description": "Update an existing Redis cache.", "parameters": [ @@ -164,14 +164,14 @@ } } } - }, + }, "delete": { "tags": [ "Redis" ], "operationId": "Redis_Delete", - "x-ms-examples": { - "RedisCacheDelete": { "$ref": "./examples/RedisCacheDelete.json" } + "x-ms-examples": { + "RedisCacheDelete": { "$ref": "./examples/RedisCacheDelete.json" } }, "description": "Deletes a Redis cache.", "x-ms-long-running-operation": true, @@ -211,8 +211,8 @@ "Redis" ], "operationId": "Redis_Get", - "x-ms-examples": { - "RedisCacheGet": { "$ref": "./examples/RedisCacheGet.json" } + "x-ms-examples": { + "RedisCacheGet": { "$ref": "./examples/RedisCacheGet.json" } }, "description": "Gets a Redis cache (resource description).", "parameters": [ @@ -253,8 +253,8 @@ "Redis" ], "operationId": "Redis_ListByResourceGroup", - "x-ms-examples": { - "RedisCacheListByResourceGroup": { "$ref": "./examples/RedisCacheListByResourceGroup.json" } + "x-ms-examples": { + "RedisCacheListByResourceGroup": { "$ref": "./examples/RedisCacheListByResourceGroup.json" } }, "description": "Lists all Redis caches in a resource group.", "parameters": [ @@ -291,8 +291,8 @@ "Redis" ], "operationId": "Redis_List", - "x-ms-examples": { - "RedisCacheList": { "$ref": "./examples/RedisCacheList.json" } + "x-ms-examples": { + "RedisCacheList": { "$ref": "./examples/RedisCacheList.json" } }, "description": "Gets all Redis caches in the specified subscription.", "parameters": [ @@ -322,8 +322,8 @@ "Redis" ], "operationId": "Redis_ListKeys", - "x-ms-examples": { - "RedisCacheListKeys": { "$ref": "./examples/RedisCacheListKeys.json" } + "x-ms-examples": { + "RedisCacheListKeys": { "$ref": "./examples/RedisCacheListKeys.json" } }, "description": "Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.", "parameters": [ @@ -364,8 +364,8 @@ "Redis" ], "operationId": "Redis_RegenerateKey", - "x-ms-examples": { - "RedisCacheRegenerateKey": { "$ref": "./examples/RedisCacheRegenerateKey.json" } + "x-ms-examples": { + "RedisCacheRegenerateKey": { "$ref": "./examples/RedisCacheRegenerateKey.json" } }, "description": "Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.", "parameters": [ @@ -415,8 +415,8 @@ "Redis" ], "operationId": "Redis_ForceReboot", - "x-ms-examples": { - "RedisCacheForceReboot": { "$ref": "./examples/RedisCacheForceReboot.json" } + "x-ms-examples": { + "RedisCacheForceReboot": { "$ref": "./examples/RedisCacheForceReboot.json" } }, "description": "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.", "parameters": [ @@ -454,7 +454,7 @@ "200": { "description": "Reboot operation successfully enqueued", "schema": { - "$ref": "#/definitions/RedisForceRebootResponse" + "$ref": "#/definitions/RedisForceRebootResponse" } } } @@ -466,8 +466,8 @@ "Redis" ], "operationId": "Redis_ImportData", - "x-ms-examples": { - "RedisCacheImport": { "$ref": "./examples/RedisCacheImport.json" } + "x-ms-examples": { + "RedisCacheImport": { "$ref": "./examples/RedisCacheImport.json" } }, "x-ms-long-running-operation": true, "description": "Import data into Redis cache.", @@ -521,8 +521,8 @@ "Redis" ], "operationId": "Redis_ExportData", - "x-ms-examples": { - "RedisCacheExport": { "$ref": "./examples/RedisCacheExport.json" } + "x-ms-examples": { + "RedisCacheExport": { "$ref": "./examples/RedisCacheExport.json" } }, "x-ms-long-running-operation": true, "description": "Export data from the redis cache to blobs in a container.", @@ -578,8 +578,8 @@ ], "operationId": "FirewallRules_List", "description": "Gets all firewall rules in the specified redis cache.", - "x-ms-examples": { - "RedisCacheFirewallRulesList": { "$ref": "./examples/RedisCacheFirewallRulesList.json" } + "x-ms-examples": { + "RedisCacheFirewallRulesList": { "$ref": "./examples/RedisCacheFirewallRulesList.json" } }, "parameters": [ { @@ -624,7 +624,7 @@ ], "operationId": "RedisFirewallRule_CreateOrUpdate", "description": "Create or update a redis cache firewall rule", - "x-ms-examples": { + "x-ms-examples": { "RedisCacheFirewallRuleCreate": { "$ref": "./examples/RedisCacheFirewallRuleCreate.json" } }, "parameters": [ @@ -687,7 +687,7 @@ ], "operationId": "RedisFirewallRule_Get", "description": "Gets a single firewall rule in a specified redis cache.", - "x-ms-examples": { + "x-ms-examples": { "RedisCacheFirewallRuleGet": { "$ref": "./examples/RedisCacheFirewallRuleGet.json" } }, "parameters": [ @@ -735,7 +735,7 @@ ], "operationId": "RedisFirewallRule_Delete", "description": "Deletes a single firewall rule in a specified redis cache.", - "x-ms-examples": { + "x-ms-examples": { "RedisCacheFirewallRuleDelete": { "$ref": "./examples/RedisCacheFirewallRuleDelete.json" } }, "parameters": [ @@ -783,8 +783,8 @@ "Redis" ], "operationId": "PatchSchedules_CreateOrUpdate", - "x-ms-examples": { - "RedisCachePatchSchedulesCreateOrUpdate": { "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json" } + "x-ms-examples": { + "RedisCachePatchSchedulesCreateOrUpdate": { "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json" } }, "description": "Create or replace the patching schedule for Redis cache (requires Premium SKU).", "parameters": [ @@ -838,8 +838,8 @@ "Redis" ], "operationId": "PatchSchedules_Delete", - "x-ms-examples": { - "RedisCachePatchSchedulesDelete": { "$ref": "./examples/RedisCachePatchSchedulesDelete.json" } + "x-ms-examples": { + "RedisCachePatchSchedulesDelete": { "$ref": "./examples/RedisCachePatchSchedulesDelete.json" } }, "description": "Deletes the patching schedule of a redis cache (requires Premium SKU).", "parameters": [ @@ -878,8 +878,8 @@ "Redis" ], "operationId": "PatchSchedules_Get", - "x-ms-examples": { - "RedisCachePatchSchedulesGet": { "$ref": "./examples/RedisCachePatchSchedulesGet.json" } + "x-ms-examples": { + "RedisCachePatchSchedulesGet": { "$ref": "./examples/RedisCachePatchSchedulesGet.json" } }, "description": "Gets the patching schedule of a redis cache (requires Premium SKU).", "parameters": [ @@ -984,7 +984,7 @@ "subnetId": { "type": "string", "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" }, "staticIP": { "type": "string", @@ -1499,4 +1499,4 @@ } } } - + diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-02-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-02-01/redis.json index a584ad79f627..8f938ebf2e55 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-02-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-02-01/redis.json @@ -1182,7 +1182,7 @@ "subnetId": { "type": "string", "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" }, "staticIP": { "type": "string", @@ -1725,13 +1725,13 @@ "items": { "$ref": "#/definitions/RedisLinkedServerWithProperties" }, - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." } }, "required": [ "value" ], - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." }, "RedisLinkedServerCreateProperties": { "description": "Create properties for a linked server", diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json index 8d79b8e6997a..4c04c4ae2a91 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2017-10-01/redis.json @@ -1370,7 +1370,7 @@ "subnetId": { "type": "string", "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" }, "staticIP": { "type": "string", @@ -1924,7 +1924,7 @@ "items": { "$ref": "#/definitions/RedisLinkedServerWithProperties" }, - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." }, "nextLink": { "type": "string", @@ -1932,7 +1932,7 @@ "description": "Link for next set." } }, - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." }, "RedisLinkedServerCreateProperties": { "description": "Create properties for a linked server", @@ -2053,7 +2053,7 @@ "readOnly": true, "type": "string", "format": "date-time", - "description": "Timestamp when upgrade notification occured." + "description": "Timestamp when upgrade notification occurred." }, "upsellNotification": { "readOnly": true, diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json index 89031d2b44c7..b01df7137639 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2018-03-01/redis.json @@ -1386,7 +1386,7 @@ "subnetId": { "type": "string", "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", - "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subid}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" }, "staticIP": { "type": "string", @@ -1958,7 +1958,7 @@ "items": { "$ref": "#/definitions/RedisLinkedServerWithProperties" }, - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." }, "nextLink": { "type": "string", @@ -1966,7 +1966,7 @@ "description": "Link for next set." } }, - "description": "List of linked servers (with properites) of a Redis cache." + "description": "List of linked servers (with properties) of a Redis cache." }, "RedisLinkedServerCreateProperties": { "description": "Create properties for a linked server", @@ -2087,7 +2087,7 @@ "readOnly": true, "type": "string", "format": "date-time", - "description": "Timestamp when upgrade notification occured." + "description": "Timestamp when upgrade notification occurred." }, "upsellNotification": { "readOnly": true, From 5522cc276e54c9a87e7c903240349aaa0ea4b2b8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 13:31:27 -0500 Subject: [PATCH 310/464] chore: Add initial EditorConfig (#4742) * chore: Add initial EditorConfig * chore: Add EditorConfig VS Code suggestion --- .editorconfig | 9 +++++++++ .vscode/extensions.json | 1 + 2 files changed, 10 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000000..ec1feb2198c5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*.json] +indent_style = space +indent_size = 2 +trim_trailing_whitespace = false diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 7aeb084ce335..d4550a2026f8 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,6 @@ { "recommendations": [ + "EditorConfig.EditorConfig", "vscode-docs-authoring" ] } From edffe3d62f3e9976138593b3eeea9930e4f4e78d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:00:11 -0500 Subject: [PATCH 311/464] chore: Rename microsoft.workloadmanager -> Microsoft.WorkloadMonitor (#4734) * chore: Rename microsoft.workloadmanager -> Microsoft.WorkloadMonitor Lower case is inconsistent with other API folders * fix: Metadata casing for Microsoft.WorkloadMonitor --- .../Microsoft.WorkloadMonitor.json | 0 .../examples/ComponentsSummary_List.json | 0 .../2018-08-31-preview/examples/Components_Get.json | 0 .../examples/Components_ListByResource.json | 0 .../examples/MonitorInstancesSummary_List.json | 0 .../examples/MonitorInstances_Get.json | 0 .../examples/MonitorInstances_ListByResource.json | 0 .../2018-08-31-preview/examples/Monitors_Get.json | 0 .../examples/Monitors_ListByResource.json | 0 .../2018-08-31-preview/examples/Monitors_Update.json | 0 .../examples/NotificationSettings_Get.json | 0 .../NotificationSettings_ListByResource.json | 0 .../examples/NotificationSettings_Update.json | 0 .../2018-08-31-preview/examples/Operations_List.json | 0 .../workloadmonitor/resource-manager/readme.md | 12 ++++++------ 15 files changed, 6 insertions(+), 6 deletions(-) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/ComponentsSummary_List.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Components_Get.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Components_ListByResource.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/MonitorInstancesSummary_List.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/MonitorInstances_Get.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Monitors_Get.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Monitors_ListByResource.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Monitors_Update.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/NotificationSettings_Get.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/NotificationSettings_Update.json (100%) rename specification/workloadmonitor/resource-manager/{microsoft.workloadmonitor => Microsoft.WorkloadMonitor}/preview/2018-08-31-preview/examples/Operations_List.json (100%) diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/ComponentsSummary_List.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/ComponentsSummary_List.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/ComponentsSummary_List.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/ComponentsSummary_List.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Components_Get.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_Get.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Components_Get.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Components_ListByResource.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstancesSummary_List.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstancesSummary_List.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstancesSummary_List.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstancesSummary_List.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstances_Get.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/MonitorInstances_ListByResource.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_Get.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_Get.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_Get.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_Get.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_ListByResource.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_ListByResource.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_ListByResource.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_ListByResource.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_Update.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_Update.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Monitors_Update.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Monitors_Update.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_Get.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_ListByResource.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/NotificationSettings_Update.json diff --git a/specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Operations_List.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Operations_List.json similarity index 100% rename from specification/workloadmonitor/resource-manager/microsoft.workloadmonitor/preview/2018-08-31-preview/examples/Operations_List.json rename to specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/examples/Operations_List.json diff --git a/specification/workloadmonitor/resource-manager/readme.md b/specification/workloadmonitor/resource-manager/readme.md index ce490ee4f4ef..3239c1ea90c7 100644 --- a/specification/workloadmonitor/resource-manager/readme.md +++ b/specification/workloadmonitor/resource-manager/readme.md @@ -1,11 +1,11 @@ -# Microsoft.WorkloadMonitor - +# Microsoft.WorkloadMonitor + > see https://aka.ms/autorest This is the AutoRest configuration file for Microsoft.WorkloadMonitor. --- -## Getting Started +## Getting Started To build the SDK for Microsoft.WorkloadMonitor, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -19,7 +19,7 @@ To see additional help and options, run: -### Basic Information +### Basic Information These are the global settings for the API. ``` yaml @@ -34,7 +34,7 @@ These settings apply only when `--tag=package-2018-08-31-preview` is specified o ``` yaml $(tag) == 'package-2018-08-31-preview' input-file: -- microsoft.workloadmonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json +- Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json ``` ``` yaml @@ -54,7 +54,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-python + - repo: azure-sdk-for-python - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node From 7c8b7a866c2eda1cb568d183ff9c59d599c5622e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:00:48 -0500 Subject: [PATCH 312/464] typo: mysql/resource-manager/Microsoft.DBforMySQL (#4718) - allowd -> allowed - relica -> replica - Trim trailing spaces --- .../preview/2017-12-01-preview/mysql.json | 2 +- .../stable/2017-12-01/mysql.json | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json index 09959796f525..018318240bc1 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json @@ -1238,7 +1238,7 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Parameters allowd to update for a server." + "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index 3bc599427fd3..582ae3f83679 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -48,7 +48,7 @@ "$ref":"./examples/ServerCreatePointInTimeRestore.json" }, "Create a server as a geo restore ": { - "$ref": "./examples/ServerCreateGeoRestoreMode.json" + "$ref": "./examples/ServerCreateGeoRestoreMode.json" }, "Create a replica server": { "$ref": "./examples/ServerCreateReplicaMode.json" @@ -686,7 +686,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ @@ -1368,7 +1368,7 @@ }, "masterServerId": { "type": "string", - "description": "The master server id of a relica server." + "description": "The master server id of a replica server." }, "replicaCapacity": { "type": "integer", @@ -1649,7 +1649,7 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Parameters allowd to update for a server." + "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { @@ -1779,7 +1779,7 @@ "readOnly": true } } - }, + }, "DatabaseProperties": { "properties": { "charset": { @@ -2231,7 +2231,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, + }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", From bce3dc09148bab1b44166749d9b828da96eaee61 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:01:03 -0500 Subject: [PATCH 313/464] typo: postgresql/resource-manager/Microsoft.DBforPostgreSQL (#4727) - allowd -> allowed - Trim trailing space --- .../preview/2017-12-01-preview/postgresql.json | 2 +- .../stable/2017-12-01/postgresql.json | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json index 55c8667ce500..70de9806a07a 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json @@ -1238,7 +1238,7 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Parameters allowd to update for a server." + "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json index 8bb2e1ed0186..622db149a3aa 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json @@ -47,8 +47,8 @@ "Create a database as a point in time restore":{ "$ref":"./examples/ServerCreatePointInTimeRestore.json" }, - "Create a server as a geo restore ": { - "$ref": "./examples/ServerCreateGeoRestoreMode.json" + "Create a server as a geo restore ": { + "$ref": "./examples/ServerCreateGeoRestoreMode.json" } }, "description": "Creates a new server, or will overwrite an existing server.", @@ -644,7 +644,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/databases/{databaseName}": { "put": { "tags": [ @@ -1573,7 +1573,7 @@ "description": "Application-specific metadata in the form of key-value pairs." } }, - "description": "Parameters allowd to update for a server." + "description": "Parameters allowed to update for a server." }, "ServerListResult": { "properties": { @@ -1703,7 +1703,7 @@ "readOnly": true } } - }, + }, "DatabaseProperties": { "properties": { "charset": { @@ -2155,7 +2155,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, + }, "DatabaseNameParameter": { "name": "databaseName", "in": "path", From e5d7700bb19188dde83acda2a5c840a161c21e6b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:01:59 -0500 Subject: [PATCH 314/464] typo: managementgroups/resource-manager/Microsoft.Management (#4709) - Resurse -> Recurse - Managment -> Management - Double word "the" --- .../preview/2017-08-31-preview/management.json | 6 +++--- .../preview/2018-01-01-preview/management.json | 4 ++-- .../preview/2018-03-01-preview/management.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-08-31-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-08-31-preview/management.json index 6449accd6c1e..6a83ef237208 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-08-31-preview/management.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2017-08-31-preview/management.json @@ -125,7 +125,7 @@ "GetManagementGroupWithExpand": { "$ref": "./examples/GetManagementGroupWithExpand.json" }, - "GetManagementGroupsWithExpandAndResurse": { + "GetManagementGroupsWithExpandAndRecurse": { "$ref": "./examples/GetManagementGroupWithExpandAndRecurse.json" } } @@ -449,7 +449,7 @@ "description": "The unique identifier (ID) of a management group.", "properties": { "childType": { - "title" : "Managment Group Child Info", + "title" : "Management Group Child Info", "$ref": "#/definitions/ManagementGroupType" }, "childId": { @@ -523,7 +523,7 @@ "description": "The unique identifier (ID) of a management group.", "properties": { "childType": { - "title" : "Managment Group Recursive Child Info", + "title" : "Management Group Recursive Child Info", "$ref": "#/definitions/ManagementGroupType" }, "childId": { diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json index 321145c03d1d..3a411aa21586 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-01-01-preview/management.json @@ -138,7 +138,7 @@ "GetManagementGroupWithExpand": { "$ref": "./examples/GetManagementGroupWithExpand.json" }, - "GetManagementGroupsWithExpandAndResurse": { + "GetManagementGroupsWithExpandAndRecurse": { "$ref": "./examples/GetManagementGroupWithExpandAndRecurse.json" } } @@ -1164,7 +1164,7 @@ "required": true, "type": "string", "description": "Subscription ID.", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method" }, "ApiVersionParameter": { "name": "api-version", diff --git a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json index f517d090124c..44c890b2287b 100644 --- a/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json +++ b/specification/managementgroups/resource-manager/Microsoft.Management/preview/2018-03-01-preview/management.json @@ -1404,7 +1404,7 @@ "name": "$filter", "in": "query", "required": false, - "description": "The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.", + "description": "The filter parameter allows you to filter on the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.", "type": "string", "x-ms-parameter-location": "method" }, From 74e61babf988a6d4662d8be3128309ef577cb758 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:02:14 -0500 Subject: [PATCH 315/464] typo: Microsoft.HanaOnAzure (#4695) - interaface -> interface --- .../preview/2017-11-03-preview/hanaonazure.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 0f4967f7191b..e68955be0e3c 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -472,7 +472,7 @@ "description": "Specifies the IP address of the network interface." } }, - "description": "Specifies the IP address of the network interaface." + "description": "Specifies the IP address of the network interface." }, "OperationList": { "type": "object", From 72e294356f0d03b3f869cee6e3b4546d81851e1b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 14:06:33 -0500 Subject: [PATCH 316/464] typo: reservations/resource-manager/Microsoft.Capacity (#4753) - AutofitGroup -> Autofit group - Seperator -> Separator --- .../Microsoft.Capacity/preview/2018-06-01/reservations.json | 2 +- specification/resources/resource-manager/readme.csharp.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json index 52a9b8f9407a..dcc7cf11bcfc 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2018-06-01/reservations.json @@ -1093,7 +1093,7 @@ }, "InstanceFlexibility": { "type": "string", - "description": "Allows reservation discount to be applied across skus within the same AutofitGroup. Not all skus support instance size flexibility.", + "description": "Allows reservation discount to be applied across skus within the same Autofit group. Not all skus support instance size flexibility.", "enum": [ "On", "Off", diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md index b7cc5b77b5cf..8dbbc8578b4a 100644 --- a/specification/resources/resource-manager/readme.csharp.md +++ b/specification/resources/resource-manager/readme.csharp.md @@ -125,7 +125,7 @@ input-file: - Microsoft.Authorization/preview/2015-10-01-preview/policy.json ``` -``` yaml $(Seperator) +``` yaml $(Separator) ########################################################################### ########################################################################### ``` @@ -193,7 +193,7 @@ input-file: - Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json ``` -``` yaml $(Seperator) +``` yaml $(Separator) ########################################################################### ########################################################################### ``` From 0a159a000a8e10a08430803b76562d6d1fabf18f Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 15:54:08 -0500 Subject: [PATCH 317/464] typo: Microsoft.DataFactory (#4675) - azure-mgmt-dafactory -> azure-mgmt-datafactory - arbitary -> arbitrary - requries -> requires - Fitler -> Filter --- .../preview/2017-09-01-preview/entityTypes/Pipeline.json | 2 +- specification/datafactory/resource-manager/readme.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json index 05876249e8ef..856bfc7a6ce7 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/preview/2017-09-01-preview/entityTypes/Pipeline.json @@ -2819,7 +2819,7 @@ ] }, "FilterActivityTypeProperties": { - "description": "Fitler activity properties.", + "description": "Filter activity properties.", "properties": { "items": { "description": "Input array on which filter should be applied.", diff --git a/specification/datafactory/resource-manager/readme.md b/specification/datafactory/resource-manager/readme.md index 98be8b907c64..2334976564cf 100644 --- a/specification/datafactory/resource-manager/readme.md +++ b/specification/datafactory/resource-manager/readme.md @@ -94,7 +94,7 @@ python: license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 namespace: azure.mgmt.datafactory - package-name: azure-mgmt-dafactory + package-name: azure-mgmt-datafactory package-version: 1.0.0 clear-output-folder: true ``` @@ -188,7 +188,7 @@ directive: from: datafactory.json reason: - Flattening does not work well with polymorphic models. - - TriggerResource.properties is an arbitary dictionary and cannot be flattened. + - TriggerResource.properties is an arbitrary dictionary and cannot be flattened. - suppress: R2018 # XmsEnumValidation where: - $.definitions.Expression.properties.type @@ -256,7 +256,7 @@ directive: - $.definitions.SelfHostedIntegrationRuntimeNode.properties.isActiveDispatcher - $.definitions.IntegrationRuntimeConnectionInfo.properties.isIdentityCertExprired reason: - - toBeExportedForShoebox is property we send to Azure Monitor which requries the boolean type + - toBeExportedForShoebox is property we send to Azure Monitor which requires the boolean type - The other properties are simple and self explanatory ``` From d956b2d86d094ee3308a3495a37f40e45bfd74f4 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 16:07:00 -0500 Subject: [PATCH 318/464] typo: recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices (#4749) - vCeneter -> vCenter - classfication -> classification - indentifier -> identifier - Recoery -> Recovery - proprties -> properties - occurence -> occurrence - Overriden -> Overridden - upto -> up to - exensions -> extensions - updation -> update - mappping -> mapping - reveived -> received - priviliges -> privileges - umber -> under - behaviour -> behavior - datastore -> data store - Onprem -> On-prem - inidicating -> indicating - Entites -> Entities - migraton -> migration - accerated -> accelerated - RunAs capitialization --- .../stable/2016-08-10/service.json | 68 ++++++++--------- .../stable/2018-01-10/service.json | 74 +++++++++---------- 2 files changed, 71 insertions(+), 71 deletions(-) diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/service.json index f617cae554b0..042489a91666 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2016-08-10/service.json @@ -594,7 +594,7 @@ { "name": "vCenterName", "in": "path", - "description": "vCeneter name", + "description": "vCenter name", "required": true, "type": "string" }, @@ -950,7 +950,7 @@ { "name": "storageClassificationName", "in": "path", - "description": "Storage classfication name.", + "description": "Storage classification name.", "required": true, "type": "string" } @@ -5093,7 +5093,7 @@ { "name": "jobName", "in": "path", - "description": "Job indentifier.", + "description": "Job identifier.", "required": true, "type": "string" } @@ -5483,7 +5483,7 @@ "tags": [ "ReplicationFabrics" ], - "summary": "Creates an Azure Site Recoery fabric.", + "summary": "Creates an Azure Site Recovery fabric.", "description": "The operation to create an Azure Site Recovery fabric (for e.g. Hyper-V site)", "operationId": "ReplicationFabrics_Create", "consumes": [ @@ -5535,7 +5535,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Creates an Azure Site Recoery fabric.": { + "Creates an Azure Site Recovery fabric.": { "$ref": "./examples/ReplicationFabrics_Create.json" } } @@ -5910,7 +5910,7 @@ } }, "AlertProperties": { - "description": "The proprties of an alert.", + "description": "The properties of an alert.", "type": "object", "properties": { "sendToOwners": { @@ -6019,7 +6019,7 @@ }, "timeOfOccurrence": { "format": "date-time", - "description": "The time of occurence of the event.", + "description": "The time of occurrence of the event.", "type": "string" }, "fabricId": { @@ -6048,7 +6048,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -6060,7 +6060,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -6254,7 +6254,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -6807,7 +6807,7 @@ "type": "string" }, "endTime": { - "description": "Date time to get jobs upto.", + "description": "Date time to get jobs up to.", "type": "string" }, "fabricId": { @@ -6905,7 +6905,7 @@ } }, "NetworkMapping": { - "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate exensions in subsequent versions.", + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", "type": "object", "allOf": [ { @@ -7381,7 +7381,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -7478,7 +7478,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -7624,7 +7624,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -8031,7 +8031,7 @@ } }, "UpdateRecoveryPlanInputProperties": { - "description": "Recovery plan updation properties.", + "description": "Recovery plan update properties.", "type": "object", "properties": { "groups": { @@ -9020,7 +9020,7 @@ "properties": { "properties": { "$ref": "#/definitions/StorageClassificationProperties", - "description": "Proprties of the storage object." + "description": "Properties of the storage object." } } }, @@ -9062,7 +9062,7 @@ "properties": { "properties": { "$ref": "#/definitions/StorageClassificationMappingProperties", - "description": "Proprties of the storage mappping object." + "description": "Properties of the storage mapping object." } } }, @@ -9142,7 +9142,7 @@ }, "lastHeartbeat": { "format": "date-time", - "description": "The time when the last heartbeat was reveived by vCenter.", + "description": "The time when the last heartbeat was received by vCenter.", "type": "string" }, "discoveryStatus": { @@ -9242,7 +9242,7 @@ "type": "string" }, "runAsAccountId": { - "description": "The CS account Id which has priviliges to update the vCenter.", + "description": "The CS account Id which has privileges to update the vCenter.", "type": "string" } } @@ -9361,7 +9361,7 @@ "properties": { "resourceCount": { "format": "int32", - "description": "The count of total resources umder the container.", + "description": "The count of total resources under the container.", "type": "integer" }, "issues": { @@ -9472,7 +9472,7 @@ "x-ms-discriminator-value": "VmmToVmm" }, "AzureToAzureCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to Azure to Azure Network mapping.", + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", "type": "object", "allOf": [ { @@ -9488,7 +9488,7 @@ "x-ms-discriminator-value": "AzureToAzure" }, "VmmToAzureCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to Vmm to Azure Network mapping.", + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", "type": "object", "allOf": [ { @@ -9499,7 +9499,7 @@ "x-ms-discriminator-value": "VmmToAzure" }, "VmmToVmmCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to vmm to vmm Network mapping.", + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", "type": "object", "allOf": [ { @@ -9526,7 +9526,7 @@ "x-ms-discriminator-value": "AzureToAzure" }, "VmmToAzureUpdateNetworkMappingInput": { - "description": "Update network mappings input properties/behaviour specific to vmm to azure.", + "description": "Update network mappings input properties/behavior specific to vmm to azure.", "type": "object", "allOf": [ { @@ -9537,7 +9537,7 @@ "x-ms-discriminator-value": "VmmToAzure" }, "VmmToVmmUpdateNetworkMappingInput": { - "description": "Update network mappings input properties/behaviour specific to vmm to vmm.", + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", "type": "object", "allOf": [ { @@ -9979,7 +9979,7 @@ } }, "DataStore": { - "description": "The datastore details of the MT.", + "description": "The data store details of the MT.", "type": "object", "properties": { "symbolicName": { @@ -10572,7 +10572,7 @@ "type": "string" }, "datastores": { - "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "description": "The data stores of the on-premise machine. Value can be list of strings that contain data store names.", "type": "array", "items": { "type": "string" @@ -10853,7 +10853,7 @@ "type": "string" }, "datastores": { - "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names", + "description": "The data stores of the on-premise machine Value can be list of strings that contain data store names", "type": "array", "items": { "type": "string" @@ -11541,7 +11541,7 @@ "type": "string" }, "datastoreName": { - "description": "The target datastore name.", + "description": "The target data store name.", "type": "string" }, "diskExclusionInput": { @@ -11959,7 +11959,7 @@ "x-ms-discriminator-value": "HyperVVirtualMachine" }, "DiskDetails": { - "description": "Onprem disk details data.", + "description": "On-prem disk details data.", "type": "object", "properties": { "maxSizeMB": { @@ -12019,7 +12019,7 @@ "type": "string" }, "discoveryType": { - "description": "A value inidicating the discovery type of the machine. Value can be vCenter or physical.", + "description": "A value indicating the discovery type of the machine. Value can be vCenter or physical.", "type": "string" }, "diskDetails": { @@ -12366,7 +12366,7 @@ "type": "string" }, "datastoreName": { - "description": "The target datastore name.", + "description": "The target data store name.", "type": "string" }, "diskExclusionInput": { @@ -12710,7 +12710,7 @@ "x-ms-discriminator-value": "VmNicUpdatesTaskDetails" }, "ConsistencyCheckTaskDetails": { - "description": "This class contains monitoring details of all the inconsistent Protected Entites in Vmm.", + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", "type": "object", "allOf": [ { diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json index 3445404c5856..464ff28f2ac8 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-01-10/service.json @@ -4642,7 +4642,7 @@ { "name": "storageClassificationName", "in": "path", - "description": "Storage classfication name.", + "description": "Storage classification name.", "required": true, "type": "string" } @@ -5121,7 +5121,7 @@ { "name": "vCenterName", "in": "path", - "description": "vCeneter name", + "description": "vCenter name", "required": true, "type": "string" }, @@ -5279,7 +5279,7 @@ { "name": "jobName", "in": "path", - "description": "Job indentifier.", + "description": "Job identifier.", "required": true, "type": "string" } @@ -7849,7 +7849,7 @@ } }, "AlertProperties": { - "description": "The proprties of an alert.", + "description": "The properties of an alert.", "type": "object", "properties": { "sendToOwners": { @@ -8065,7 +8065,7 @@ "x-ms-discriminator-value": "Azure" }, "AzureToAzureCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to Azure to Azure Network mapping.", + "description": "Create network mappings input properties/behavior specific to Azure to Azure Network mapping.", "type": "object", "allOf": [ { @@ -8196,7 +8196,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -8235,7 +8235,7 @@ } }, "ConsistencyCheckTaskDetails": { - "description": "This class contains monitoring details of all the inconsistent Protected Entites in Vmm.", + "description": "This class contains monitoring details of all the inconsistent Protected Entities in Vmm.", "type": "object", "allOf": [ { @@ -8405,7 +8405,7 @@ } }, "CurrentJobDetails": { - "description": "Current job details of the migraton item.", + "description": "Current job details of the migration item.", "type": "object", "properties": { "jobName": { @@ -8443,7 +8443,7 @@ } }, "DataStore": { - "description": "The datastore details of the MT.", + "description": "The data store details of the MT.", "type": "object", "properties": { "symbolicName": { @@ -8540,7 +8540,7 @@ } }, "DiskDetails": { - "description": "Onprem disk details data.", + "description": "On-prem disk details data.", "type": "object", "properties": { "maxSizeMB": { @@ -8787,7 +8787,7 @@ }, "timeOfOccurrence": { "format": "date-time", - "description": "The time of occurence of the event.", + "description": "The time of occurrence of the event.", "type": "string" }, "fabricId": { @@ -8816,7 +8816,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -8864,7 +8864,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -11002,7 +11002,7 @@ "type": "string" }, "datastores": { - "description": "The datastores of the on-premise machine. Value can be list of strings that contain datastore names.", + "description": "The data stores of the on-premise machine. Value can be list of strings that contain data store names.", "type": "array", "items": { "type": "string" @@ -11278,7 +11278,7 @@ "type": "string" }, "datastoreName": { - "description": "The target datastore name.", + "description": "The target data store name.", "type": "string" }, "diskExclusionInput": { @@ -11624,7 +11624,7 @@ "type": "string" }, "datastores": { - "description": "The datastores of the on-premise machine Value can be list of strings that contain datastore names", + "description": "The data stores of the on-premise machine Value can be list of strings that contain data store names", "type": "array", "items": { "type": "string" @@ -11690,7 +11690,7 @@ "type": "string" }, "datastoreName": { - "description": "The target datastore name.", + "description": "The target data store name.", "type": "string" }, "diskExclusionInput": { @@ -11994,7 +11994,7 @@ "type": "string" }, "endTime": { - "description": "Date time to get jobs upto.", + "description": "Date time to get jobs up to.", "type": "string" }, "fabricId": { @@ -12562,7 +12562,7 @@ } }, "NetworkMapping": { - "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate exensions in subsequent versions.", + "description": "Network Mapping model. Ideally it should have been possible to inherit this class from prev version in InheritedModels as long as there is no difference in structure or method signature. Since there were no base Models for certain fields and methods viz NetworkMappingProperties and Load with required return type, the class has been introduced in its entirety with references to base models to facilitate extensions in subsequent versions.", "type": "object", "allOf": [ { @@ -13147,7 +13147,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -13243,7 +13243,7 @@ "type": "object", "properties": { "instanceType": { - "description": "Gets the class type. Overriden in derived classes.", + "description": "Gets the class type. Overridden in derived classes.", "type": "string", "readOnly": true } @@ -14581,7 +14581,7 @@ "properties": { "resourceCount": { "format": "int32", - "description": "The count of total resources umder the container.", + "description": "The count of total resources under the container.", "type": "integer" }, "issues": { @@ -14789,7 +14789,7 @@ "properties": { "properties": { "$ref": "#/definitions/StorageClassificationProperties", - "description": "Proprties of the storage object." + "description": "Properties of the storage object." } } }, @@ -14821,7 +14821,7 @@ "properties": { "properties": { "$ref": "#/definitions/StorageClassificationMappingProperties", - "description": "Proprties of the storage mappping object." + "description": "Properties of the storage mapping object." } } }, @@ -15372,7 +15372,7 @@ } }, "UpdateRecoveryPlanInputProperties": { - "description": "Recovery plan updation properties.", + "description": "Recovery plan update properties.", "type": "object", "properties": { "groups": { @@ -15490,7 +15490,7 @@ "type": "string" }, "runAsAccountId": { - "description": "The CS account Id which has priviliges to update the vCenter.", + "description": "The CS account Id which has privileges to update the vCenter.", "type": "string" } } @@ -15581,7 +15581,7 @@ }, "lastHeartbeat": { "format": "date-time", - "description": "The time when the last heartbeat was reveived by vCenter.", + "description": "The time when the last heartbeat was received by vCenter.", "type": "string" }, "discoveryStatus": { @@ -15687,7 +15687,7 @@ "x-ms-discriminator-value": "VMM" }, "VmmToAzureCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to Vmm to Azure Network mapping.", + "description": "Create network mappings input properties/behavior specific to Vmm to Azure Network mapping.", "type": "object", "allOf": [ { @@ -15709,7 +15709,7 @@ "x-ms-discriminator-value": "VmmToAzure" }, "VmmToAzureUpdateNetworkMappingInput": { - "description": "Update network mappings input properties/behaviour specific to vmm to azure.", + "description": "Update network mappings input properties/behavior specific to vmm to azure.", "type": "object", "allOf": [ { @@ -15720,7 +15720,7 @@ "x-ms-discriminator-value": "VmmToAzure" }, "VmmToVmmCreateNetworkMappingInput": { - "description": "Create network mappings input properties/behaviour specific to vmm to vmm Network mapping.", + "description": "Create network mappings input properties/behavior specific to vmm to vmm Network mapping.", "type": "object", "allOf": [ { @@ -15742,7 +15742,7 @@ "x-ms-discriminator-value": "VmmToVmm" }, "VmmToVmmUpdateNetworkMappingInput": { - "description": "Update network mappings input properties/behaviour specific to vmm to vmm.", + "description": "Update network mappings input properties/behavior specific to vmm to vmm.", "type": "object", "allOf": [ { @@ -15875,7 +15875,7 @@ "type": "string" }, "enableAcceleratedNetworkingOnRecovery": { - "description": "A value indicating whether the NIC has accerated networking enabled.", + "description": "A value indicating whether the NIC has accelerated networking enabled.", "type": "boolean" } } @@ -15901,7 +15901,7 @@ "type": "string" }, "enableAcceleratedNetworkingOnRecovery": { - "description": "Whether the NIC has accerated networking enabled.", + "description": "Whether the NIC has accelerated networking enabled.", "type": "boolean" } } @@ -16069,11 +16069,11 @@ } }, "dataMoverRunAsAccountId": { - "description": "The data mover runas account Id.", + "description": "The data mover RunAs account Id.", "type": "string" }, "snapshotRunAsAccountId": { - "description": "The snapshot runas account Id.", + "description": "The snapshot RunAs account Id.", "type": "string" }, "targetVmName": { @@ -16151,12 +16151,12 @@ "type": "string" }, "dataMoverRunAsAccountId": { - "description": "The data mover runas account Id.", + "description": "The data mover RunAs account Id.", "type": "string", "readOnly": true }, "snapshotRunAsAccountId": { - "description": "The snapshot runas account Id.", + "description": "The snapshot RunAs account Id.", "type": "string", "readOnly": true }, From 30cffeaa847ab61f77caf0c45a8ce7ec31a4aa9a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 16:49:14 -0500 Subject: [PATCH 319/464] typo: frontdoor/Microsoft.Network (#4692) - FrontDoor casing - double word "the" - reponse -> response - ruleset -> rule set - thresold -> threshold - overrideruleGroup -> override rule group --- .../preview/2018-08-01-preview/README.md | 4 ++-- .../preview/2018-08-01-preview/frontdoor.json | 14 +++++++------- .../2018-08-01-preview/webapplicationfirewall.json | 12 ++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/README.md b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/README.md index 3c951a6dac88..ec2a85eedc8e 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/README.md +++ b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/README.md @@ -1,4 +1,4 @@ -# Public Preview API specification for Frontdoor Azure Resource +# Public Preview API specification for FrontDoor Azure Resource This directory contains preview schema specifications for the new Front Door Azure Resource. The API will be added to support Front Door on Azure Resource Manager. @@ -6,7 +6,7 @@ The base swagger document for new features in this preview: [FrontDoor.json](./F ## Overview The Front Door ARM API supports CRUD functionality on four objects in the resource schema: -`Frontdoor`, a collection of child objects `BackendPool`, a collection of child objects `FrontendEndpoints` and the primary child object `RoutingRule`, which each reference one `BackendPool` and `FrontendEndpoints` . Each routing rule encapsulates +`FrontDoor`, a collection of child objects `BackendPool`, a collection of child objects `FrontendEndpoints` and the primary child object `RoutingRule`, which each reference one `BackendPool` and `FrontendEndpoints` . Each routing rule encapsulates all of the settings needed to configure the AzureFD backend infrastructure to set up a reverse-proxy route to accelerate traffic, detect backend availability, and balance between healthy members of the pool. diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json index dc0c261ba68a..35eb5a6fa79a 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/frontdoor.json @@ -1649,7 +1649,7 @@ } }, "FrontDoorListResult": { - "description": "Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the the next set of results.", + "description": "Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -1720,7 +1720,7 @@ } }, "RoutingRuleListResult": { - "description": "Result of the request to list Routing Rules. It contains a list of Routing Rule objects and a URL link to get the the next set of results.", + "description": "Result of the request to list Routing Rules. It contains a list of Routing Rule objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -1904,7 +1904,7 @@ } }, "LoadBalancingSettingsListResult": { - "description": "Result of the request to list load balancing settings. It contains a list of load balancing settings objects and a URL link to get the the next set of results.", + "description": "Result of the request to list load balancing settings. It contains a list of load balancing settings objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -1977,7 +1977,7 @@ } }, "HealthProbeSettingsListResult": { - "description": "Result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings objects and a URL link to get the the next set of results.", + "description": "Result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2079,7 +2079,7 @@ } }, "BackendPoolListResult": { - "description": "Result of the request to list Backend Pools. It contains a list of Backend Pools objects and a URL link to get the the next set of results.", + "description": "Result of the request to list Backend Pools. It contains a list of Backend Pools objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2322,7 +2322,7 @@ } }, "FrontendEndpointsListResult": { - "description": "Result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the the next set of results.", + "description": "Result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -2390,7 +2390,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/webapplicationfirewall.json b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/webapplicationfirewall.json index 53bfa1cf3447..2dd4ac5b2220 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/webapplicationfirewall.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/preview/2018-08-01-preview/webapplicationfirewall.json @@ -134,7 +134,7 @@ "tags": [ "CreateOrUpdateWebApplicationFirewallPolicy" ], - "description": "Creates or update policy with specified ruleset name within a resource group.", + "description": "Creates or update policy with specified rule set name within a resource group.", "operationId": "Policies_CreateOrUpdate", "parameters": [ { @@ -303,7 +303,7 @@ } }, "WebApplicationFirewallPolicyListResult": { - "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the the next set of results.", + "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", "properties": { "value": { "type": "array", @@ -400,7 +400,7 @@ "type": "integer" }, "rateLimitThreshold": { - "description": "Defines rate limit thresold", + "description": "Defines rate limit threshold", "type": "integer" }, "matchConditions": { @@ -534,7 +534,7 @@ "type": "integer" }, "version": { - "description": "defines version of the ruleset", + "description": "defines version of the rule set", "type": "integer" }, "ruleSetType": { @@ -574,7 +574,7 @@ ], "properties": { "ruleGroupOverride": { - "description": "Describes overrideruleGroup", + "description": "Describes override rule group", "type": "string", "enum": [ "SqlInjection", @@ -601,7 +601,7 @@ } }, "ErrorResponse": { - "description": "Error reponse indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "code": { From 114e4139f190040e07d22fadf41a080ea5bd6360 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 16:49:34 -0500 Subject: [PATCH 320/464] typo: Microsoft.Devices (#4684) - provisoning -> provisioning - assosiated -> associated - SKU's -> SKUs - etailed -> detailed - whitespace trimming --- .../preview/2017-08-21-preview/iotdps.json | 5 ++-- .../stable/2017-11-15/iotdps.json | 29 +++++++++---------- .../stable/2018-01-22/iotdps.json | 29 +++++++++---------- 3 files changed, 30 insertions(+), 33 deletions(-) diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json index 399426e5d15d..e28e12752c25 100644 --- a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2017-08-21-preview/iotdps.json @@ -8,7 +8,6 @@ "title": "iotDpsClient", "description": "API for using the Azure IoT Hub Device Provisioning Service features." }, - "host": "management.azure.com", "schemes": [ "https" @@ -1330,7 +1329,7 @@ }, "IotDpsSkuInfo": { "type": "object", - "description": "List of possible provisoning service SKUs.", + "description": "List of possible provisioning service SKUs.", "properties": { "name": { "enum": [ @@ -1410,7 +1409,7 @@ }, "iotHubs": { "type": "array", - "description": "List of IoT hubs assosciated with this provisioning service.", + "description": "List of IoT hubs associated with this provisioning service.", "items": { "$ref": "#/definitions/IotHubDefinitionDescription" } diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2017-11-15/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2017-11-15/iotdps.json index 72d074c3d45e..c5da01c95330 100644 --- a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2017-11-15/iotdps.json +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2017-11-15/iotdps.json @@ -8,7 +8,6 @@ "title": "iotDpsClient", "description": "API for using the Azure IoT Hub Device Provisioning Service features." }, - "host": "management.azure.com", "schemes": [ "https" @@ -221,7 +220,7 @@ ], "operationId": "DpsCertificate_Delete", "summary": "Delete the Provisioning Service Certificate.", - "description": "Deletes the specified certificate assosciated with the Provisioning Service", + "description": "Deletes the specified certificate associated with the Provisioning Service", "x-ms-examples": { "DPSDeleteCertificate": { "$ref": "./examples/DPSDeleteCertificate.json" } }, @@ -1009,7 +1008,7 @@ "name": "request", "in": "body", "required": true, - "description": "The name of the certificate", + "description": "The name of the certificate", "schema": { "$ref": "#/definitions/VerificationCodeRequest" } @@ -1399,10 +1398,10 @@ }, "IotDpsSkuInfo": { "type": "object", - "description": "List of possible provisoning service SKUs.", + "description": "List of possible provisioning service SKUs.", "properties": { "name": { - "description": "Sku name.", + "description": "Sku name.", "enum": [ "S1" ], @@ -1433,11 +1432,11 @@ "type": "string" }, "properties": { - "description": "Service specific properties for a provisioning service", + "description": "Service specific properties for a provisioning service", "$ref": "#/definitions/IotDpsPropertiesDescription" }, "sku": { - "description": "SKU info for a provisioning service.", + "description": "SKU info for a provisioning service.", "$ref": "#/definitions/IotDpsSkuInfo" } }, @@ -1452,7 +1451,7 @@ ] }, "IotDpsPropertiesDescription": { - "description": "the service specific properties of a provisoning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", "type": "object", "properties": { "state": { @@ -1483,7 +1482,7 @@ }, "iotHubs": { "type": "array", - "description": "List of IoT hubs assosciated with this provisioning service.", + "description": "List of IoT hubs associated with this provisioning service.", "items": { "$ref": "#/definitions/IotHubDefinitionDescription" } @@ -1711,7 +1710,7 @@ "description": "List of shared access keys.", "properties": { "value": { - "description": "The list of shared access policies.", + "description": "The list of shared access policies.", "type": "array", "items": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" @@ -1729,14 +1728,14 @@ "description": "List of available SKUs.", "properties": { "value": { - "description": "The list of SKU's", + "description": "The list of SKUs", "type": "array", "items": { "$ref": "#/definitions/IotDpsSkuDefinition" } }, "nextLink": { - "description": "The next link.", + "description": "The next link.", "type": "string", "readOnly": true } @@ -1744,10 +1743,10 @@ }, "IotDpsSkuDefinition": { "type": "object", - "description": "Available SKU's of tier and units.", + "description": "Available SKUs of tier and units.", "properties": { "name": { - "description": "SKU name.", + "description": "SKU name.", "enum": [ "S1" ], @@ -1793,7 +1792,7 @@ } }, "message": { - "description": "message containing a etailed reason name is unavailable", + "description": "message containing a detailed reason name is unavailable", "type": "string" } } diff --git a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json index e99d28c91bca..88b3ac65d890 100644 --- a/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json +++ b/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2018-01-22/iotdps.json @@ -8,7 +8,6 @@ "title": "iotDpsClient", "description": "API for using the Azure IoT Hub Device Provisioning Service features." }, - "host": "management.azure.com", "schemes": [ "https" @@ -221,7 +220,7 @@ ], "operationId": "DpsCertificate_Delete", "summary": "Delete the Provisioning Service Certificate.", - "description": "Deletes the specified certificate assosciated with the Provisioning Service", + "description": "Deletes the specified certificate associated with the Provisioning Service", "x-ms-examples": { "DPSDeleteCertificate": { "$ref": "./examples/DPSDeleteCertificate.json" } }, @@ -1009,7 +1008,7 @@ "name": "request", "in": "body", "required": true, - "description": "The name of the certificate", + "description": "The name of the certificate", "schema": { "$ref": "#/definitions/VerificationCodeRequest" } @@ -1399,10 +1398,10 @@ }, "IotDpsSkuInfo": { "type": "object", - "description": "List of possible provisoning service SKUs.", + "description": "List of possible provisioning service SKUs.", "properties": { "name": { - "description": "Sku name.", + "description": "Sku name.", "enum": [ "S1" ], @@ -1433,11 +1432,11 @@ "type": "string" }, "properties": { - "description": "Service specific properties for a provisioning service", + "description": "Service specific properties for a provisioning service", "$ref": "#/definitions/IotDpsPropertiesDescription" }, "sku": { - "description": "Sku info for a provisioning Service.", + "description": "Sku info for a provisioning Service.", "$ref": "#/definitions/IotDpsSkuInfo" } }, @@ -1452,7 +1451,7 @@ ] }, "IotDpsPropertiesDescription": { - "description": "the service specific properties of a provisoning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", + "description": "the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope", "type": "object", "properties": { "state": { @@ -1483,7 +1482,7 @@ }, "iotHubs": { "type": "array", - "description": "List of IoT hubs assosciated with this provisioning service.", + "description": "List of IoT hubs associated with this provisioning service.", "items": { "$ref": "#/definitions/IotHubDefinitionDescription" } @@ -1711,7 +1710,7 @@ "description": "List of shared access keys.", "properties": { "value": { - "description": "The list of shared access policies.", + "description": "The list of shared access policies.", "type": "array", "items": { "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule[AccessRightsDescription]" @@ -1729,14 +1728,14 @@ "description": "List of available SKUs.", "properties": { "value": { - "description": "The list of SKU's", + "description": "The list of SKUs", "type": "array", "items": { "$ref": "#/definitions/IotDpsSkuDefinition" } }, "nextLink": { - "description": "The next link.", + "description": "The next link.", "type": "string", "readOnly": true } @@ -1744,10 +1743,10 @@ }, "IotDpsSkuDefinition": { "type": "object", - "description": "Available Sku's of tier and units.", + "description": "Available SKUs of tier and units.", "properties": { "name": { - "description": "Sku name.", + "description": "Sku name.", "enum": [ "S1" ], @@ -1793,7 +1792,7 @@ } }, "message": { - "description": "message containing a etailed reason name is unavailable", + "description": "message containing a detailed reason name is unavailable", "type": "string" } } From fc8d22beb1dcb2b5fd66da94128d85215ede2961 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 4 Dec 2018 16:50:52 -0500 Subject: [PATCH 321/464] typo: cognitiveservices/data-plane/LUIS (#4656) - Double word "in" - explict -> explicit - resopnse -> response - idenfied -> identified - idenfitied -> identified - Objet -> Object - analized -> analyzed --- .../LUIS/Authoring/stable/v2.0/LUIS-Authoring.json | 14 +++++++------- .../LUIS/Runtime/stable/v2.0/LUIS-Runtime.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json index 102493766dfe..3aaaf2bf0dcd 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json @@ -2444,7 +2444,7 @@ }, "/apps/import": { "post": { - "description": "Imports an application to LUIS, the application's structure should be included in in the request body.", + "description": "Imports an application to LUIS, the application's structure should be included in the request body.", "operationId": "Apps_Import", "parameters": [ { @@ -5293,7 +5293,7 @@ ], "responses": { "200": { - "description": "A list of the explict list items", + "description": "A list of the explicit list items", "schema": { "$ref": "#/definitions/ExplicitListItemList" } @@ -7728,7 +7728,7 @@ "type": "object", "properties": { "sentimentAnalysis": { - "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse", + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response", "type": "boolean", "x-nullable": false }, @@ -7753,7 +7753,7 @@ "type": "string" }, "entityLabels": { - "description": "The idenfied entities within the utterance.", + "description": "The identified entities within the utterance.", "items": { "type": "object", "$ref": "#/definitions/EntityLabelObject" @@ -7761,7 +7761,7 @@ "type": "array" }, "intentName": { - "description": "The idenfitied intent representing the utterance.", + "description": "The identified intent representing the utterance.", "type": "string" } } @@ -7833,7 +7833,7 @@ } }, "PrebuiltExtractorNames": { - "description": "Objet model for adding a prebuilt entity to the application.", + "description": "Object model for adding a prebuilt entity to the application.", "type": "array", "items": { "type": "string" @@ -9192,7 +9192,7 @@ "format": "uuid" }, "sentimentAnalysis": { - "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the resopnse", + "description": "Setting sentiment analysis as true returns the Sentiment of the input utterance along with the response", "type": "boolean", "x-nullable": false, "x-ms-client-name": "IsSentimentAnalysisEnabled" diff --git a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json index f746f4c067d9..63aef12d1da8 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json +++ b/specification/cognitiveservices/data-plane/LUIS/Runtime/stable/v2.0/LUIS-Runtime.json @@ -205,7 +205,7 @@ "description": "Prediction, based on the input query, containing intent(s) and entities.", "properties": { "query": { - "description": "The input utterance that was analized.", + "description": "The input utterance that was analyzed.", "type": "string" }, "alteredQuery": { From f9c6c44b496c8787fde0cf9d519a2e3b0e73530a Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Tue, 4 Dec 2018 15:38:32 -0800 Subject: [PATCH 322/464] Fix Node.js output-folder for cognitiveservices QnAMaker (#4774) --- .../cognitiveservices/data-plane/QnAMaker/readme.nodejs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md index c5b34edc925f..4a819e11716c 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.nodejs.md @@ -6,7 +6,7 @@ Please also specify `--node-sdks-folder= Date: Tue, 4 Dec 2018 17:10:02 -0800 Subject: [PATCH 323/464] Generate readme files for Node.js cognitiveservices customvision packages (#4775) --- .../data-plane/CustomVision/Prediction/readme.nodejs.md | 2 +- .../data-plane/CustomVision/Training/readme.nodejs.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md index c681f575213d..c2fb20fd683d 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.nodejs.md @@ -11,5 +11,5 @@ nodejs: azure-arm: false generate-license-txt: true generate-package-json: true - generate-readme-md: false + generate-readme-md: true ``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md index f0e2d036893e..a7a0081f7b5d 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.nodejs.md @@ -11,5 +11,5 @@ nodejs: azure-arm: false generate-license-txt: true generate-package-json: true - generate-readme-md: false + generate-readme-md: true ``` From 3c8521487d5aa6bc56b7b741c8a0bc732e36e1fb Mon Sep 17 00:00:00 2001 From: Vipul Modi - MSFT Date: Tue, 4 Dec 2018 22:55:12 -0800 Subject: [PATCH 324/464] Swagger specification for Service Fabric runtime version 6.4 (#4591) * Swagger specification for Service Fabric runtime version 6.4 * fix typos specificed -> specified, sucessful -> successful, resturns -> returns, commited -> committed, Double word "maximum", Double word "with" * typo: Parition to Partition * remove invalid character --- .../6.4/examples/BackupPartition-1.json | 13 + .../6.4/examples/BackupPartition-2.json | 19 + .../6.4/examples/BackupPartition-3.json | 20 + .../6.4/examples/CreateApplication-1.json | 16 + .../6.4/examples/CreateBackupPolicy-1.json | 35 + .../6.4/examples/CreateBackupPolicy-2.json | 32 + .../stable/6.4/examples/CreateName-1.json | 14 + .../stable/6.4/examples/CreateService-1.json | 21 + .../stable/6.4/examples/CreateService-2.json | 23 + .../stable/6.4/examples/CreateService-3.json | 47 + .../stable/6.4/examples/CreateService-4.json | 44 + .../6.4/examples/DeleteBackupPolicy.json | 12 + .../examples/DisableApplicationBackup.json | 15 + .../6.4/examples/DisablePartitionBackup.json | 15 + .../6.4/examples/DisableServiceBackup.json | 15 + .../6.4/examples/EnableApplicationBackup.json | 15 + .../6.4/examples/EnablePartitionBackup.json | 15 + .../6.4/examples/EnableServiceBackup.json | 15 + .../GetAllEntitiesBackedUpByPolicy-1.json | 28 + .../GetAllEntitiesBackedUpByPolicy-2.json | 25 + ...tApplicationBackupConfigurationInfo-1.json | 40 + ...tApplicationBackupConfigurationInfo-2.json | 32 + .../examples/GetApplicationBackupList-1.json | 109 + .../examples/GetApplicationBackupList-2.json | 64 + .../examples/GetApplicationBackupList-3.json | 64 + .../examples/GetApplicationBackupList-4.json | 65 + .../6.4/examples/GetApplicationEventList.json | 28 + .../examples/GetApplicationInfoByName-1.json | 27 + .../examples/GetApplicationInfoList-1.json | 39 + .../examples/GetApplicationInfoList-2.json | 30 + .../GetApplicationTypeInfoList-1.json | 86 + .../GetApplicationTypeInfoList-2.json | 50 + .../GetApplicationTypeInfoList-3.json | 61 + .../examples/GetApplicationsEventList.json | 37 + .../6.4/examples/GetBackupPolicyByName.json | 37 + .../6.4/examples/GetBackupPolicyList-1.json | 64 + .../6.4/examples/GetBackupPolicyList-2.json | 43 + .../GetBackupsFromBackupLocation-1.json | 74 + .../GetBackupsFromBackupLocation-2.json | 75 + .../stable/6.4/examples/GetChaosEvents.json | 63 + .../6.4/examples/GetClusterEventList.json | 56 + .../6.4/examples/GetClusterVersion-1.json | 16 + .../GetContainerLogsDeployedOnNode-1.json | 20 + .../GetContainerLogsDeployedOnNode-2.json | 21 + .../GetContainerLogsDeployedOnNode-3.json | 21 + .../6.4/examples/GetCorrelatedEventList.json | 31 + .../examples/GetDataLossProgress-Running.json | 19 + .../6.4/examples/GetDataLossProgress.json | 26 + .../GetDeployedApplicationInfoByName-1.json | 29 + .../GetDeployedApplicationInfoList-1.json | 40 + .../GetDeployedApplicationInfoList-2.json | 30 + .../GetDeployedApplicationInfoList-3.json | 50 + .../6.4/examples/GetFaultOperationList.json | 53 + .../6.4/examples/GetImageStoreContent.json | 92 + .../stable/6.4/examples/GetNodeEventList.json | 33 + .../stable/6.4/examples/GetNodeInfo-1.json | 44 + .../6.4/examples/GetNodeInfoList-1.json | 73 + .../6.4/examples/GetNodeInfoList-2.json | 100 + .../stable/6.4/examples/GetNodeInfoList.json | 152 + .../GetNodeTransitionProgress-Running.json | 18 + .../examples/GetNodeTransitionProgress.json | 25 + .../6.4/examples/GetNodesEventList.json | 47 + .../GetPartitionBackupConfigurationInfo.json | 25 + .../examples/GetPartitionBackupList-1.json | 65 + .../examples/GetPartitionBackupList-2.json | 42 + .../examples/GetPartitionBackupList-3.json | 64 + .../examples/GetPartitionBackupList-4.json | 43 + .../examples/GetPartitionBackupProgress.json | 26 + .../6.4/examples/GetPartitionEventList.json | 38 + .../examples/GetPartitionRestartProgress.json | 26 + .../examples/GetPartitionRestoreProgress.json | 24 + .../6.4/examples/GetPartitionsEventList.json | 57 + .../6.4/examples/GetPropertyInfo-1.json | 30 + .../6.4/examples/GetPropertyInfoList-1.json | 43 + .../6.4/examples/GetPropertyInfoList-2.json | 51 + .../6.4/examples/GetPropertyInfoList-3.json | 37 + .../GetQuorumLossProgress-Running.json | 19 + .../6.4/examples/GetQuorumLossProgress.json | 26 + .../6.4/examples/GetReplicaEventList.json | 36 + .../6.4/examples/GetReplicasEventList.json | 52 + .../GetServiceBackupConfigurationInfo-1.json | 41 + .../GetServiceBackupConfigurationInfo-2.json | 32 + .../6.4/examples/GetServiceBackupList-1.json | 109 + .../6.4/examples/GetServiceBackupList-2.json | 64 + .../6.4/examples/GetServiceBackupList-3.json | 64 + .../6.4/examples/GetServiceBackupList-4.json | 65 + .../6.4/examples/GetServiceEventList.json | 35 + .../examples/GetServiceTypeInfoByName-1.json | 39 + .../examples/GetServiceTypeInfoList-1.json | 36 + .../6.4/examples/GetServicesEventList.json | 51 + .../6.4/examples/GetSubNameInfoList-1.json | 22 + .../6.4/examples/GetSubNameInfoList-2.json | 28 + .../6.4/examples/GetSubNameInfoList-3.json | 24 + .../6.4/examples/GetUploadSessionById.json | 34 + .../6.4/examples/GetUploadSessionByPath.json | 50 + .../6.4/examples/InvokeContainerApi.json | 27 + .../6.4/examples/InvokeContainerApi_Post.json | 29 + .../stable/6.4/examples/PutProperty-1.json | 19 + .../stable/6.4/examples/PutProperty-2.json | 20 + .../Replicas/CodePackages/get_logs.json | 18 + .../Applications/Services/Replicas/get.json | 57 + .../Applications/Services/Replicas/list.json | 105 + .../Resources/Applications/Services/get.json | 51 + .../Resources/Applications/Services/list.json | 56 + .../Applications/create_update.autoscale.json | 102 + .../Resources/Applications/create_update.json | 81 + .../Resources/Applications/delete.json | 13 + .../examples/Resources/Applications/get.json | 23 + .../examples/Resources/Applications/list.json | 28 + .../Resources/Gateways/create_update.json | 193 + .../examples/Resources/Gateways/delete.json | 13 + .../6.4/examples/Resources/Gateways/get.json | 72 + .../6.4/examples/Resources/Gateways/list.json | 77 + .../Resources/Networks/create_update.json | 41 + .../examples/Resources/Networks/delete.json | 13 + .../6.4/examples/Resources/Networks/get.json | 21 + .../6.4/examples/Resources/Networks/list.json | 26 + .../Resources/Secrets/create_update.json | 41 + .../examples/Resources/Secrets/delete.json | 13 + .../6.4/examples/Resources/Secrets/get.json | 21 + .../6.4/examples/Resources/Secrets/list.json | 35 + .../Resources/Secrets/values/create.json | 36 + .../Resources/Secrets/values/delete.json | 15 + .../Resources/Secrets/values/get.json | 20 + .../Resources/Secrets/values/list.json | 29 + .../Resources/Secrets/values/list_value.json | 16 + .../Resources/Volumes/create_update.json | 52 + .../examples/Resources/Volumes/delete.json | 13 + .../6.4/examples/Resources/Volumes/get.json | 25 + .../6.4/examples/Resources/Volumes/list.json | 30 + .../stable/6.4/examples/RestorePartition.json | 21 + .../6.4/examples/ResumeApplicationBackup.json | 12 + .../6.4/examples/ResumePartitionBackup.json | 12 + .../6.4/examples/ResumeServiceBackup.json | 12 + .../StartClusterConfigurationUpgrade-1.json | 42 + .../6.4/examples/SubmitPropertyBatch-1.json | 67 + .../examples/SuspendApplicationBackup.json | 12 + .../6.4/examples/SuspendPartitionBackup.json | 12 + .../6.4/examples/SuspendServiceBackup.json | 12 + .../6.4/examples/UpdateBackupPolicy.json | 36 + .../stable/6.4/examples/UpdateService-1.json | 34 + .../stable/6.4/examples/UpdateService-2.json | 17 + .../stable/6.4/servicefabric.json | 26829 ++++++++++++++++ .../servicefabric/data-plane/readme.go.md | 11 +- .../servicefabric/data-plane/readme.md | 14 +- 145 files changed, 32492 insertions(+), 3 deletions(-) create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateApplication-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateName-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-4.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DeleteBackupPolicy.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableApplicationBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisablePartitionBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableServiceBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableApplicationBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnablePartitionBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableServiceBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-4.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoByName-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationsEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyByName.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetChaosEvents.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterVersion-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetCorrelatedEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress-Running.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoByName-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetFaultOperationList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetImageStoreContent.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfo-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress-Running.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodesEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupConfigurationInfo.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-4.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestartProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestoreProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionsEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfo-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress-Running.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicaEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicasEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-4.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoByName-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServicesEventList.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-3.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionById.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionByPath.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi_Post.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.autoscale.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/create_update.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/create_update.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/create_update.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/create.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list_value.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/create_update.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/delete.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/get.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/list.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/RestorePartition.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeApplicationBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumePartitionBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeServiceBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/StartClusterConfigurationUpgrade-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SubmitPropertyBatch-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendApplicationBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendPartitionBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendServiceBackup.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateBackupPolicy.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-1.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-2.json create mode 100644 specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-1.json new file mode 100644 index 000000000000..223bea6a418b --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-1.json @@ -0,0 +1,13 @@ +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, which is already configured for periodic backups. The newly created backup will be saved at the same location where the periodic backups are being saved.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": {} + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-2.json new file mode 100644 index 000000000000..139e6f9180fd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-2.json @@ -0,0 +1,19 @@ +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific Azure blob storage account.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + } + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-3.json new file mode 100644 index 000000000000..431789b1b5c3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/BackupPartition-3.json @@ -0,0 +1,20 @@ +{ + "operationId": "BackupPartition", + "description": "This example shows how to trigger backup of a partition now, and save the backup to a specific file share accessible from all cluster nodes.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "BackupPartitionDescription": { + "BackupStorage": { + "StorageKind": "FileShare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "mydomain\\backupaccount", + "PrimaryPassword": "abcd1234" + } + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateApplication-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateApplication-1.json new file mode 100644 index 000000000000..c71542c2be64 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateApplication-1.json @@ -0,0 +1,16 @@ +{ + "operationId": "CreateApplication", + "description": "This example shows how to create a Service Fabric application without overriding any application parameter values.", + "parameters": { + "api-version": "6.0", + "ApplicationDescription": { + "Name": "fabric:/samples/CalcApp", + "TypeVersion": "1.0", + "TypeName": "CalculatorApp" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-1.json new file mode 100644 index 000000000000..44e8f003e38a --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-1.json @@ -0,0 +1,35 @@ +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 3 months, with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.4", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 20, + "RetentionDuration": "P3M" + } + } + }, + "responses": { + "201": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-2.json new file mode 100644 index 000000000000..baa2b22f48cf --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateBackupPolicy-2.json @@ -0,0 +1,32 @@ +{ + "operationId": "CreateBackupPolicy", + "description": "This example shows how to create a backup policy which takes backup every 10 minutes which shall get deleted after 20 days, with file share as the backup location.", + "parameters": { + "api-version": "6.4", + "BackupPolicyDescription": { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "abcd1234" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 20, + "RetentionDuration": "P20D" + } + } + }, + "responses": { + "201": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateName-1.json new file mode 100644 index 000000000000..87d2807cc3b8 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateName-1.json @@ -0,0 +1,14 @@ +{ + "operationId": "CreateName", + "description": "This example shows how to create a new Service Fabric name. The name can be created under an existing name that represents an appliction or a service or under a completely new name.", + "parameters": { + "api-version": "6.0", + "NameDescription": { + "Name": "fabric:/samples/CalculatorApp/CalculatorService/Name-1" + } + }, + "responses": { + "201": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-1.json new file mode 100644 index 000000000000..8b8c341523c2 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-1.json @@ -0,0 +1,21 @@ +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateless Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 4 + } + }, + "responses": { + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-2.json new file mode 100644 index 000000000000..b8d3c24c9f78 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-2.json @@ -0,0 +1,23 @@ +{ + "operationId": "CreateService", + "description": "This example shows how to create a basic stateful Service Fabric service.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "HasPersistedState": false + } + }, + "responses": { + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-3.json new file mode 100644 index 000000000000..1badea855fbb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-3.json @@ -0,0 +1,47 @@ +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateless Service Fabric service with a dns name definied and auto scaling based on cpu usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateless", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test1", + "ServiceTypeName": "StatelessFrontendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "Singleton" + }, + "InstanceCount": 2, + "PlacementConstraints": "Color==Blue", + "CorrelationScheme": [], + "ServiceLoadMetrics": [], + "ServicePlacementPolicies": [], + "DefaultMoveCost": "Low", + "IsDefaultMoveCostSpecified": true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ServiceDnsName": "test1.test", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.300000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 1, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-4.json new file mode 100644 index 000000000000..246bb902dbca --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/CreateService-4.json @@ -0,0 +1,44 @@ +{ + "operationId": "CreateService", + "description": "This example shows how to create a stateful Service Fabric service with named partitions and scaling enabled based on memory usage.", + "parameters": { + "applicationId": "test", + "api-version": "6.0", + "ServiceDescription": { + "ServiceKind": "Stateful", + "ApplicationName": "fabric:\/test", + "ServiceName": "fabric:\/test\/test2", + "ServiceTypeName": "StatefulBackendService", + "InitializationData": [], + "PartitionDescription": { + "PartitionScheme": "NamedPartitionSchemeDescription", + "Count" : 1, + "Names" : ["0"] + }, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize" : 2, + "HasPersistedState" : true, + "ServicePackageActivationMode": "ExclusiveProcess", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AverageServiceLoad", + "MetricName": "servicefabric:\/_MemoryInMB", + "LowerLoadThreshold": 500, + "UpperLoadThreshold": 900, + "ScaleIntervalInSeconds": 600 + }, + "ScalingMechanism": { + "Kind": "AddRemoveIncrementalNamedPartition", + "MinPartitionCount": 1, + "MaxPartitionCount": 3, + "ScaleIncrement": 1 + } + } + ] + } + }, + "responses": { + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DeleteBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DeleteBackupPolicy.json new file mode 100644 index 000000000000..9cccb92e79ad --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DeleteBackupPolicy.json @@ -0,0 +1,12 @@ +{ + "operationId": "DeleteBackupPolicy", + "description": "This example shows how to delete an existing backup policy which is currently not associated with any backup entity.", + "parameters": { + "api-version": "6.4", + "backupPolicyName": "SampleBackupPolicy" + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableApplicationBackup.json new file mode 100644 index 000000000000..e7273dd70a6d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableApplicationBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "DisableApplicationBackup", + "description": "This example shows how to disable periodic backup for a stateful application which was previously enabled.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "DisableBackupDescription": { + "CleanBackup": true + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisablePartitionBackup.json new file mode 100644 index 000000000000..feb770c60c0c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisablePartitionBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "DisablePartitionBackup", + "description": "This example shows how to disable periodic backup for a stateful partition which was previously enabled.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "DisableBackupDescription": { + "CleanBackup": false + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableServiceBackup.json new file mode 100644 index 000000000000..d71208492ea4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/DisableServiceBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "DisableServiceBackup", + "description": "This example shows how to disable periodic backup for a stateful service which was previously enabled.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "DisableBackupDescription": { + "CleanBackup": true + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableApplicationBackup.json new file mode 100644 index 000000000000..d13d3315f57c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableApplicationBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnableApplicationBackup", + "description": "This example shows how to enable periodic backup for a stateful application.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnablePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnablePartitionBackup.json new file mode 100644 index 000000000000..e448dc293309 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnablePartitionBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnablePartitionBackup", + "description": "This example shows how to enable periodic backup for a stateful partition.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableServiceBackup.json new file mode 100644 index 000000000000..9f86e60fab13 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/EnableServiceBackup.json @@ -0,0 +1,15 @@ +{ + "operationId": "EnableServiceBackup", + "description": "This example shows how to enable periodic backup for a stateful service.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "EnableBackupDescription": { + "BackupPolicyName": "DailyAzureBackupPolicy" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-1.json new file mode 100644 index 000000000000..a29ccf03c3de --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-1.json @@ -0,0 +1,28 @@ +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/DemoApp", + "Items": [ + { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + }, + { + "EntityKind": "Application", + "ApplicationName": "fabric:/DemoApp" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-2.json new file mode 100644 index 000000000000..f27a949d5f01 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetAllEntitiesBackedUpByPolicy-2.json @@ -0,0 +1,25 @@ +{ + "operationId": "GetAllEntitiesBackedUpByPolicy", + "description": "This example shows how to get list of backup entities that are currently associated with a backup policy. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "backupPolicyName": "DailyAzureBackupPolicy", + "MaxResults": 2, + "ContinuationToken": "fabric:/DemoApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "EntityKind": "Service", + "ServiceName": "fabric:/VotingApp/VotingActorService" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-1.json new file mode 100644 index 000000000000..6434c23f57da --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-1.json @@ -0,0 +1,40 @@ +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService", + "Items": [ + { + "Kind": "Application", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ApplicationName": "fabric:/CalcApp", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Service", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-2.json new file mode 100644 index 000000000000..0c8dda64f90c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupConfigurationInfo-2.json @@ -0,0 +1,32 @@ +{ + "operationId": "GetApplicationBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this application and entities (services and partitions) under this application. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-1.json new file mode 100644 index 000000000000..324c9b1a77da --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-1.json @@ -0,0 +1,109 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups within a time range.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "ServiceManifestVersion":"1.0.0", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "ServiceManifestVersion": "1.0.0", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "ServiceManifestVersion": "1.0.0", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-2.json new file mode 100644 index 000000000000..65f681bc519b --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-2.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get the latest backup for each partition within an application.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceName": "fabric:/CalcApp/CalcService", + "ServiceManifestVersion": "1.0.0", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-3.json new file mode 100644 index 000000000000..c95d74cb064f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-3.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-4.json new file mode 100644 index 000000000000..60a3959eb6e8 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationBackupList-4.json @@ -0,0 +1,65 @@ +{ + "operationId": "GetApplicationBackupList", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationEventList.json new file mode 100644 index 000000000000..791e2d8a81dd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationEventList.json @@ -0,0 +1,28 @@ +{ + "operationId": "GetApplicationEventList", + "description": "This example shows how to get all application-related events during a certain time window.", + "parameters": { + "applicationId": "app1", + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoByName-1.json new file mode 100644 index 000000000000..cf3db52049cc --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoByName-1.json @@ -0,0 +1,27 @@ +{ + "operationId": "GetApplicationInfo", + "description": "This example shows how to get information about an application using it's identifier. If the application is found, information about it is returned with 200 status code. If the application is not found, empty content is returned with 204 status code.", + "parameters": { + "api-version": "6.0", + "applicationId": "samples~CalculatorApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-1.json new file mode 100644 index 000000000000..fdfb2ddb517d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-1.json @@ -0,0 +1,39 @@ +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to get information about applications on the cluster. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-2.json new file mode 100644 index 000000000000..bdab44df784c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationInfoList-2.json @@ -0,0 +1,30 @@ +{ + "operationId": "GetApplicationInfoList", + "description": "This example shows how to page through the information about applications on the cluster using the ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining one result and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "MaxResults": 2, + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "TypeVersion": "1.0", + "Status": "Ready", + "Parameters": [], + "HealthState": "Ok", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-1.json new file mode 100644 index 000000000000..7057ba96a7e4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-1.json @@ -0,0 +1,86 @@ +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to get information about application types that are provisioned or being provisioned in the cluster. The number of results in a page are limited to maximum of five using MaxResult parameter.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueApp+2.0", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "ServiceInstanceCount", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "GatewayPort", + "Value": "8505" + }, + { + "Key": "ServiceInstanceCount", + "Value": "1000" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-2.json new file mode 100644 index 000000000000..ab3ffc6a26f3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-2.json @@ -0,0 +1,50 @@ +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to page through the information about application types that are provisioned or being provisioned in the cluster using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "MaxResults": 5, + "ContinuationToken": "PersistentQueueApp+2.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ + { + "Key": "MinReplicaSetSize", + "Value": "2" + }, + { + "Key": "TargetReplicaSetSize", + "Value": "3" + } + ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-3.json new file mode 100644 index 000000000000..c7d613655e79 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationTypeInfoList-3.json @@ -0,0 +1,61 @@ +{ + "operationId": "GetApplicationTypeInfoList", + "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", + "parameters": { + "api-version": "6.0", + "ExcludeApplicationParameters": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Name": "CalculatorApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "CalculatorApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "GatewayApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "PersistentQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "1.0", + "DefaultParameterList": [ ], + "Status": "Available" + }, + { + "Name": "VolatileQueueApp", + "Version": "2.0", + "DefaultParameterList": [ ], + "Status": "Available" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationsEventList.json new file mode 100644 index 000000000000..77dbd38c39ca --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetApplicationsEventList.json @@ -0,0 +1,37 @@ +{ + "operationId": "GetApplicationsEventList", + "description": "This example shows how to get all applications-related events during a certain time window.", + "parameters": { + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App1Type", + "ApplicationTypeVersion": "1.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app1", + "EventInstanceId": "8a7a0c42-67ca-4cd3-9160-edcdb822db10", + "TimeStamp": "2018-04-03T20:21:23.5774199Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ApplicationCreated", + "ApplicationTypeName": "App2Type", + "ApplicationTypeVersion": "4.0.1", + "ApplicationDefinitionKind": "ServiceFabricApplicationDescription", + "ApplicationId": "app2", + "EventInstanceId": "d50574bc-6a31-4945-8275-7639bec7a0b3", + "TimeStamp": "2018-04-03T20:21:59.74842Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyByName.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyByName.json new file mode 100644 index 000000000000..043094d88fd6 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyByName.json @@ -0,0 +1,37 @@ +{ + "operationId": "GetBackupPolicyByName", + "description": "This example shows how to query a backup policy by name.", + "parameters": { + "api-version": "6.4", + "backupPolicyName": "DailyAzureBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 20, + "RetentionDuration": "P20D" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-1.json new file mode 100644 index 000000000000..4f20cebb8669 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-1.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "FileShare10MinBackupPolicy", + "Items": [ + { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 30, + "RetentionDuration": "P29D" + } + }, + { + "Name": "FileShare10MinBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT10M" + }, + "Storage": { + "StorageKind": "FileShare", + "FriendlyName": "FileShare_myshare", + "Path": "\\\\myshare\\backupshare", + "PrimaryUserName": "backupaccount", + "PrimaryPassword": "****" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 20, + "RetentionDuration": "P20D" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-2.json new file mode 100644 index 000000000000..d4a40408cc49 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupPolicyList-2.json @@ -0,0 +1,43 @@ +{ + "operationId": "GetBackupPolicyList", + "description": "This example shows how to get list of backup policies. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "MaxResults": 2, + "ContinuationToken": "FileShare10MinBackupPolicy" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "AutoRestoreOnDataLoss": false, + "Name": "SampleBackupPolicy", + "MaxIncrementalBackups": 5, + "Schedule": { + "ScheduleKind": "FrequencyBased", + "Interval": "PT4H5M" + }, + "Storage": { + "Path": "\\\\myshare\\BackupStore", + "PrimaryUserName": "myuser1", + "PrimaryPassword": "****", + "SecondaryUserName": "myuser2", + "SecondaryPassword": "****", + "StorageKind": "FileShare", + "FriendlyName": "" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 0, + "RetentionDuration": "P20D" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-1.json new file mode 100644 index 000000000000..ecca77ab4ebc --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-1.json @@ -0,0 +1,74 @@ +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups from a specified backup location. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-2.json new file mode 100644 index 000000000000..5b6b4aa07059 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetBackupsFromBackupLocation-2.json @@ -0,0 +1,75 @@ +{ + "operationId": "GetBackupsFromBackupLocation", + "description": "This example shows how to get list of application backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "MaxResults": 2, + "GetBackupByStorageQueryDescription": { + "Storage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupEntity": { + "EntityKind": "Application", + "ApplicationName": "fabric:/CalcApp" + } + }, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetChaosEvents.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetChaosEvents.json new file mode 100644 index 000000000000..4f0757539944 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetChaosEvents.json @@ -0,0 +1,63 @@ +{ + "operationId": "GetChaosEvents", + "description": "This example shows how to get Chaos events in a single response message without the need for paging through ContinuationToken parameter.", + "parameters": { + "api-version": "6.2", + "StartTimeUtc": "0", + "EndTimeUtc": "3155378975999999999" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "History": [ + { + "ChaosEvent": { + "Kind": "Started", + "TimeStampUtc": "2017-04-14T04:27:19.049Z", + "ChaosParameters": { + "MaxClusterStabilizationTimeoutInSeconds": 30, + "MaxConcurrentFaults": 3, + "WaitTimeBetweenIterationsInSeconds": 10, + "WaitTimeBetweenFaultsInSeconds": 1, + "TimeToRunInSeconds": "3600", + "EnableMoveReplicaFaults": true, + "ClusterHealthPolicy": { + "ConsiderWarningAsError": true, + "MaxPercentUnhealthyNodes": 0, + "MaxPercentUnhealthyApplications": 10, + "ApplicationTypeHealthPolicyMap": [ + { + "Key": "myapp", + "Value": 3 + } + ] + }, + "Context": { + "Map": { + "k1": "v1", + "k2": "v2", + "k3": "v5" + } + } + } + } + }, + { + "ChaosEvent": { + "Kind": "ExecutingFaults", + "TimeStampUtc": "2017-04-14T04:27:20.667Z", + "Faults": [ + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_1, PartitionId: 6a91b09a-bd76-45da-afaa-ed0fd9bfe7d2, ReplicaId: 131366172775684622", + "ActionType: CodePackageRestart, NodeName: N0050, ApplicationName: fabric:/TestApp1, ServiceManifestName: SP1, ServiceManifestName: , CodePackageName: CP1.", + "ActionType: RestartReplica, ServiceUri: fabric:/TestApp1/PersistServ_6R_3, PartitionId: baa3a51e-5c42-435e-89d3-6e97b2164661, ReplicaId: 131366172988968762" + ] + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterEventList.json new file mode 100644 index 000000000000..5f8623cd13ef --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterEventList.json @@ -0,0 +1,56 @@ +{ + "operationId": "GetClusterEventList", + "description": "This example shows how to get all cluster-related events during a certain time window.", + "parameters": { + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ClusterUpgradeStarted", + "CurrentClusterVersion": "0.0.0.0:", + "TargetClusterVersion": "6.2:1.0", + "UpgradeType": "Rolling", + "RollingUpgradeMode": "UnmonitoredAuto", + "FailureAction": "Manual", + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:18:59.4313064Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainCompleted", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(0 1 2)", + "UpgradeDomainElapsedTimeInMs": 78.5288, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:19:59.5729953Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeDomainCompleted", + "TargetClusterVersion": "6.2:1.0", + "UpgradeState": "RollingForward", + "UpgradeDomains": "(3 4)", + "UpgradeDomainElapsedTimeInMs": 0.0, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.6271949Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ClusterUpgradeCompleted", + "TargetClusterVersion": "6.2:1.0", + "OverallUpgradeElapsedTimeInMs": 120196.5212, + "EventInstanceId": "090add3c-8f56-4d35-8d57-a855745b6064", + "TimeStamp": "2018-04-03T20:20:59.8134457Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterVersion-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterVersion-1.json new file mode 100644 index 000000000000..54519e1daaa2 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetClusterVersion-1.json @@ -0,0 +1,16 @@ +{ + "operationId": "GetClusterVersion", + "description": "This example retrieves the current (or lowest version during upgrade) cluster version.", + "parameters": { + "api-version": "6.4" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Version": "6.4.514.9494" + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-1.json new file mode 100644 index 000000000000..7dc4ab531340 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-1.json @@ -0,0 +1,20 @@ +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "HTTP Server started listening on port 8080\r\n" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-2.json new file mode 100644 index 000000000000..14d00f2fbd60 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-2.json @@ -0,0 +1,21 @@ +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get last 10 lines of container logs for container deployed on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Tail": "10" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "UTC Time Now: 04\/02\/2018 22:06:31\r\nUTC Time Now: 04\/02\/2018 22:06:32\r\nUTC Time Now: 04\/02\/2018 22:06:33\r\nUTC Time Now: 04\/02\/2018 22:06:344\r\nUTC Time Now: 04\/02\/2018 22:06:35\r\nUTC Time Now: 04\/02\/2018 22:06:36\r\nUTC Time Now: 04\/02\/2018 22:06:37\r\nUTC Time Now: 04\/02\/2018 22:06:38\r\nUTC Time Now: 04\/02\/2018 22:06:39\r\nUTC Time Now: 04\/02\/2018 22:06:40\r\n" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-3.json new file mode 100644 index 000000000000..04b9076c49fb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetContainerLogsDeployedOnNode-3.json @@ -0,0 +1,21 @@ +{ + "operationId": "GetContainerLogsDeployedOnNode", + "description": "This example shows how to get container logs of previous dead container on a Service Fabric node for the given code package.", + "parameters": { + "api-version": "6.2", + "nodeName": "_Node_0", + "applicationId": "SimpleHttpServerApp", + "ServiceManifestName": "SimpleHttpServerSvcPkg", + "CodePackageName": "Code", + "Previous": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Content": "Exception encountered: System.Net.Http.HttpRequestException: Response status code does not indicate success: 500 (Internal Server Error).\r\n\tat System.Net.Http.HttpResponseMessage.EnsureSuccessStatusCode()\r\n" + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetCorrelatedEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetCorrelatedEventList.json new file mode 100644 index 000000000000..5147fa79126c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetCorrelatedEventList.json @@ -0,0 +1,31 @@ +{ + "operationId": "GetCorrelatedEventList", + "description": "This example shows how to get all correlated events for a given eventInstanceId.", + "parameters": { + "eventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "api-version": "6.4" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "Kind": "PartitionPrimaryMoveAnalysis", + "WhenMoveCompleted": "2018-04-03T20:06:55.966073Z", + "PreviousNode": "node3(b9d52c016a15a8f57673d3b8041e2d35)", + "CurrentNode": "node1(cf68563e16a44f808e86197a9cf83de5)", + "MoveReason": "ApplicationHostDown", + "RelevantTraces": "", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "59dde2bc-a833-412e-a56d-8f6ada0c7963", + "TimeStamp": "2018-04-03T20:07:55.966073Z", + "HasCorrelatedEvents": true, + "Metadata": { + "Delay": "00:00:20", + "Duration": "00:01:59" + } + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress-Running.json new file mode 100644 index 000000000000..a32244dcd235 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress-Running.json @@ -0,0 +1,19 @@ +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of output when a data loss operation is in a Running State. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress.json new file mode 100644 index 000000000000..2a5854f737cd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDataLossProgress.json @@ -0,0 +1,26 @@ +{ + "operationId": "GetDataLossProgress", + "description": "This shows an example of possible output when GetDataLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "7216486c-1ee9-4b00-99b2-92b26fcb07f5", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeDataLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoByName-1.json new file mode 100644 index 000000000000..ea4e89a83714 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoByName-1.json @@ -0,0 +1,29 @@ +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to get information about an application deployed on a specified node by using an application identifier. If the application is found it's information is returned with 200 status code. An empty response with status code 204 is returned, if the specified application is not deployed on the node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "applicationId": "samples~CalculatorApp", + "IncludeHealthState": true + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_1\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-1.json new file mode 100644 index 000000000000..f61fdb1b0967 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-1.json @@ -0,0 +1,40 @@ +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to specify the number of applications returned by the query when getting information about applications deployed on a specific node. The number of results in a page are limited to maximum of 2 using the MaxResult parameter. Health state is not requested in this example, so the returned health state will be Unknown.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/samples/PQueueApp1", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Unknown" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-2.json new file mode 100644 index 000000000000..3fda665b418c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-2.json @@ -0,0 +1,30 @@ +{ + "operationId": "GetDeployedApplicationInfoListByName", + "description": "This example demonstrates the paging functionality available when getting information about applications deployed on a specific node. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "ContinuationToken": "fabric:/samples/PQueueApp1" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Unknown" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-3.json new file mode 100644 index 000000000000..d222c7f9550e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetDeployedApplicationInfoList-3.json @@ -0,0 +1,50 @@ +{ + "operationId": "GetDeployedApplicationInfoList", + "description": "This example shows how to include the health state of each deployed application when getting information about applications deployed on a specific node.", + "parameters": { + "api-version": "6.1", + "nodeName": "_Node_0", + "IncludeHealthState": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Id": "samples~CalculatorApp", + "Name": "fabric:/samples/CalculatorApp", + "TypeName": "CalculatorApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\CalculatorApp_App0\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~PQueueApp1", + "Name": "fabric:/samples/PQueueApp1", + "TypeName": "PersistentQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\PersistentQueueApp_App1\\temp", + "HealthState": "Ok" + }, + { + "Id": "samples~VQueueApp1", + "Name": "fabric:/samples/VQueueApp1", + "TypeName": "VolatileQueueApp", + "Status": "Active", + "WorkDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\work", + "LogDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\log", + "TempDirectory": "C:\\SfDevCluster\\Data\\_App\\_Node_0\\VolatileQueueApp_App2\\temp", + "HealthState": "Ok" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetFaultOperationList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetFaultOperationList.json new file mode 100644 index 000000000000..a1833242ccec --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetFaultOperationList.json @@ -0,0 +1,53 @@ +{ + "operationId": "GetFaultOperationList", + "description": "This shows an example of possible output for GetFaultOperationList", + "parameters": { + "TypeFilter": "0xFF", + "StateFilter": "0xFF", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": + [ + { + "OperationId": "00000000-0000-0000-0000-000000000010", + "State": "Completed", + "Type": "PartitionDataLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000020", + "State": "Completed", + "Type": "PartitionQuorumLoss" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000030", + "State": "Completed", + "Type": "PartitionRestart" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000500", + "State": "Faulted", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000700", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "00000000-0000-0000-0000-000000000710", + "State": "Completed", + "Type": "NodeTransition" + }, + { + "OperationId": "88ef90f9-0b94-46b0-b817-a6ea20c07f8a", + "State": "Completed", + "Type": "PartitionRestart" + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetImageStoreContent.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetImageStoreContent.json new file mode 100644 index 000000000000..46e1abd19641 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetImageStoreContent.json @@ -0,0 +1,92 @@ +{ + "operationId": "GetImageStoreContent", + "description": "This example shows how to get image store content under the given relative path.", + "parameters": { + "api-version": "6.2", + "contentPath": "Store\\CalcServiceApp" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "StoreFiles": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\ApplicationManifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "23", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "897", + "ModifiedDate": "2017-09-28T17:44:22.609Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "25", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "26", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "27", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.468Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "19", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "744", + "ModifiedDate": "2017-09-28T17:44:22.578Z" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Manifest.2.0.xml.checksum", + "FileVersion": { + "EpochDataLossNumber": "131510254310497004", + "VersionNumber": "24", + "EpochConfigurationNumber": "25769803776" + }, + "FileSize": "66", + "ModifiedDate": "2017-09-28T17:44:22.484Z" + } + ], + "StoreFolders": [ + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Code.2.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Config.1.0", + "FileCount": "2" + }, + { + "StoreRelativePath": "Store\\CalcServiceApp\\CalcService.Data.2.0", + "FileCount": "2" + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeEventList.json new file mode 100644 index 000000000000..7646f15c70c4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeEventList.json @@ -0,0 +1,33 @@ +{ + "operationId": "GetNodeEventList", + "description": "This example shows how to get all node-related events during a certain time window.", + "parameters": { + "nodeName": "node1", + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpenSucceeded", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfo-1.json new file mode 100644 index 000000000000..2b16e40bdac4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfo-1.json @@ -0,0 +1,44 @@ +{ + "operationId": "GetNodeInfo", + "description": "This example shows how to get information about an node using it's identifier. If the node is found, information about it is returned with 200 status code. If the node is not found, empty content is returned with 204 status code.", + "parameters": { + "api-version": "6.0", + "nodeName": "_Node_1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "Name": "_testnode_0", + "IpAddressOrFQDN": "10.0.0.4", + "Type": "testnode", + "CodeVersion": "6.3.139.9494", + "ConfigVersion": "5", + "NodeStatus": "Up", + "NodeUpTimeInSeconds": "18688", + "HealthState": "Ok", + "IsSeedNode": true, + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "Id": { + "Id": "2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId": "131738240209152398", + "NodeDeactivationInfo": { + "NodeDeactivationIntent": "Invalid", + "NodeDeactivationStatus": "None", + "NodeDeactivationTask": [], + "PendingSafetyChecks": [] + }, + "IsStopped": false, + "NodeDownTimeInSeconds": "0", + "NodeUpAt": "2018-06-18T19:33:52.944Z", + "NodeDownAt": "2018-06-18T19:33:39.514Z" + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-1.json new file mode 100644 index 000000000000..5a54696257e9 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-1.json @@ -0,0 +1,73 @@ +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about the nodes in the cluster when the number of results returned is limited by the MaxResults parameter.", + "parameters":{ + "api-version":"6.3", + "MaxResults":2 + }, + "responses":{ + "200":{ + "headers":{ + }, + "body":{ + "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326", + "Items":[ + { + "Name":"_testnode_1", + "IpAddressOrFQDN":"10.0.0.5", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"102016", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"1", + "FaultDomain":"fd:/1", + "Id":{ + "Id":"ebd986a1134b3643a8117fb41b259bf" + }, + "InstanceId":"131738274982501335", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:31:39.842Z", + "NodeDownAt":"2018-06-18T20:31:37.374Z" + }, + { + "Name":"_testnode_0", + "IpAddressOrFQDN":"10.0.0.4", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"105483", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"0", + "FaultDomain":"fd:/0", + "Id":{ + "Id":"2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId":"131738240209152398", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:33:52.944Z", + "NodeDownAt":"2018-06-18T19:33:39.514Z" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-2.json new file mode 100644 index 000000000000..2150bd646792 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList-2.json @@ -0,0 +1,100 @@ +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about nodes in the cluster which appear on a sequential page, by using the ContinuationToken parameter.", + "parameters":{ + "api-version":"6.3", + "ContinuationToken":"2acb9f55540659b1c95f27cc128ab326" + }, + "responses":{ + "200":{ + "headers":{ + }, + "body":{ + "ContinuationToken":"", + "Items":[ + { + "Name":"_Node_4", + "IpAddressOrFQDN":"10.0.0.8", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"101547", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"4", + "FaultDomain":"fd:/4", + "Id":{ + "Id":"ba9383d728221add7fa996bf67b757fb" + }, + "InstanceId":"131737415865259763", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-17T20:40:07.378Z", + "NodeDownAt":"2018-06-17T20:33:11.877Z" + }, + { + "Name":"_Node_3", + "IpAddressOrFQDN":"10.0.0.7", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15615", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"3", + "FaultDomain":"fd:/3", + "Id":{ + "Id":"d6a18a0935a3e39aeae2a049eb97255d" + }, + "InstanceId":"131738275300526952", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:32:18.884Z", + "NodeDownAt":"2018-06-18T20:31:59.128Z" + }, + { + "Name":"_Node_2", + "IpAddressOrFQDN":"10.0.0.6", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"19819", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"2", + "FaultDomain":"fd:/2", + "Id":{ + "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" + }, + "InstanceId":"131738233282843485", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:22:15.272Z", + "NodeDownAt":"2018-06-18T19:22:02.740Z" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList.json new file mode 100644 index 000000000000..650938549686 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeInfoList.json @@ -0,0 +1,152 @@ +{ + "operationId":"GetNodeInfoList", + "description":"This example shows how to get information about all the nodes in the cluster when the information fits in a single response message without the need for paging through ContinuationToken parameter.", + "parameters":{ + "api-version":"6.3" + }, + "responses":{ + "200":{ + "headers":{}, + "body":{ + "ContinuationToken":"", + "Items":[ + { + "Name":"_Node_1", + "IpAddressOrFQDN":"10.0.0.5", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15275", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"1", + "FaultDomain":"fd:/1", + "Id":{ + "Id":"ebd986a1134b3643a8117fb41b259bf" + }, + "InstanceId":"131738274982501335", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:31:39.842Z", + "NodeDownAt":"2018-06-18T20:31:37.374Z" + }, + { + "Name":"_Node_0", + "IpAddressOrFQDN":"10.0.0.4", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"18742", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"0", + "FaultDomain":"fd:/0", + "Id":{ + "Id":"2acb9f55540659b1c95f27cc128ab326" + }, + "InstanceId":"131738240209152398", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:33:52.944Z", + "NodeDownAt":"2018-06-18T19:33:39.514Z" + }, + { + "Name":"_Node_4", + "IpAddressOrFQDN":"10.0.0.8", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"101168", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"4", + "FaultDomain":"fd:/4", + "Id":{ + "Id":"ba9383d728221add7fa996bf67b757fb" + }, + "InstanceId":"131737415865259763", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-17T20:40:07.378Z", + "NodeDownAt":"2018-06-17T20:33:11.877Z" + }, + { + "Name":"_Node_3", + "IpAddressOrFQDN":"10.0.0.7", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"15236", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"3", + "FaultDomain":"fd:/3", + "Id":{ + "Id":"d6a18a0935a3e39aeae2a049eb97255d" + }, + "InstanceId":"131738275300526952", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T20:32:18.884Z", + "NodeDownAt":"2018-06-18T20:31:59.128Z" + }, + { + "Name":"_Node_2", + "IpAddressOrFQDN":"10.0.0.6", + "Type":"testnode", + "CodeVersion":"6.3.139.9494", + "ConfigVersion":"5", + "NodeStatus":"Up", + "NodeUpTimeInSeconds":"19440", + "HealthState":"Ok", + "IsSeedNode":true, + "UpgradeDomain":"2", + "FaultDomain":"fd:/2", + "Id":{ + "Id":"f2af91e5e9c8254dedb75b1424a9e3fc" + }, + "InstanceId":"131738233282843485", + "NodeDeactivationInfo":{ + "NodeDeactivationIntent":"Invalid", + "NodeDeactivationStatus":"None", + "NodeDeactivationTask":[], + "PendingSafetyChecks":[] + }, + "IsStopped":false, + "NodeDownTimeInSeconds":"0", + "NodeUpAt":"2018-06-18T19:22:15.272Z", + "NodeDownAt":"2018-06-18T19:22:02.740Z" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress-Running.json new file mode 100644 index 000000000000..901902f2ce40 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress-Running.json @@ -0,0 +1,18 @@ +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of output when GetTransitionProgress has a State of Running.", + "parameters": { + "nodeName": "N0060", + "OperationId": "ed903556-acf1-489c-9f33-b484c31f9087", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress.json new file mode 100644 index 000000000000..28a337aa3685 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodeTransitionProgress.json @@ -0,0 +1,25 @@ +{ + "operationId": "GetNodeTransitionProgress", + "description": "This shows an example of possible output when GetTransitionProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "nodeName": "N0060", + "OperationId": "a9c24269-88e9-4812-b4ad-a0bf2b724ad4", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "NodeTransitionResult": { + "ErrorCode": 0, + "NodeResult": { + "NodeName": "N0060", + "NodeInstanceId": "131366982707950527" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodesEventList.json new file mode 100644 index 000000000000..5774f22bced1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetNodesEventList.json @@ -0,0 +1,47 @@ +{ + "operationId": "GetNodesEventList", + "description": "This example shows how to get all nodes-related events during a certain time window.", + "parameters": { + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "NodeOpenSucceeded", + "NodeInstance": 131672596159209215, + "NodeId": "ba001a8bb353543e646be031afb10f1e", + "UpgradeDomain": "0", + "FaultDomain": "fd:/0", + "IpAddressOrFQDN": "100.78.240.56", + "Hostname": "RD0003FF5089AA", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node1", + "EventInstanceId": "ecbce04a-a42b-4b70-a800-dfc6bc4f9b89", + "TimeStamp": "2018-04-03T20:06:55.966073Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "NodeOpenSucceeded", + "NodeInstance": 131672596186027906, + "NodeId": "ba03ef91259835c54d674889849a7cee", + "UpgradeDomain": "3", + "FaultDomain": "fd:/3", + "IpAddressOrFQDN": "100.72.76.122", + "Hostname": "RD0003FF6047A8", + "IsSeedNode": false, + "NodeVersion": "6.2:1.0", + "NodeName": "node2", + "EventInstanceId": "67730c48-752c-4209-bf28-3c121555a4c0", + "TimeStamp": "2018-04-03T20:06:58.6357365Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupConfigurationInfo.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupConfigurationInfo.json new file mode 100644 index 000000000000..52f99e1eee01 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupConfigurationInfo.json @@ -0,0 +1,25 @@ +{ + "operationId": "GetPartitionBackupConfigurationInfo", + "description": "This example shows how to get backup configuration for a partition.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Service", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-1.json new file mode 100644 index 000000000000..b8375350c679 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-1.json @@ -0,0 +1,65 @@ +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups within a time range.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-2.json new file mode 100644 index 000000000000..9a37f48ae87e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-2.json @@ -0,0 +1,42 @@ +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get the latest backup for the specified partition.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-3.json new file mode 100644 index 000000000000..48b4db00284e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-3.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-4.json new file mode 100644 index 000000000000..788c3fbc0139 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupList-4.json @@ -0,0 +1,43 @@ +{ + "operationId": "GetPartitionBackupList", + "description": "This example shows how to get list of partition backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "be06a49c-be67-4eb1-a602-b983605be862", + "BackupChainId": "be06a49c-be67-4eb1-a602-b983605be862", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-02 08.59.53.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "639", + "CreationTimeUtc": "2018-01-02T08:59:53Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupProgress.json new file mode 100644 index 000000000000..4cc3d0b13a36 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionBackupProgress.json @@ -0,0 +1,26 @@ +{ + "operationId": "GetPartitionBackupProgress", + "description": "This shows an example of possible output when GetPartitionBackupProgress has reached a BackupState of Success. If the BackupState has a value of BackupInProgress, only the BackupState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.4" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "BackupState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "FailureError": null + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionEventList.json new file mode 100644 index 000000000000..d04b871523c9 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionEventList.json @@ -0,0 +1,38 @@ +{ + "operationId": "GetPartitionEventList", + "description": "This example shows how to get all partition-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigured", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestartProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestartProgress.json new file mode 100644 index 000000000000..7cc25203d70e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestartProgress.json @@ -0,0 +1,26 @@ +{ + "operationId": "GetPartitionRestartProgress", + "description": "This shows an example of possible output when GetPartitionRestartProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "6eb7f0d3-49ca-4cb1-81b7-ac2d56b5c5d1", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "RestartPartitionResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestoreProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestoreProgress.json new file mode 100644 index 000000000000..fbc3ba3f66f1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionRestoreProgress.json @@ -0,0 +1,24 @@ +{ + "operationId": "GetPartitionRestoreProgress", + "description": "This shows an example of possible output when GetPartitionRestoreProgress has reached a RestoreState of Success. If the RestoreState has a value of RestoreInProgress, only the RestoreState field will have a value.", + "parameters": { + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "api-version": "6.4" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "RestoreState": "Success", + "TimeStampUtc": "2018-01-01T09:00:55Z", + "RestoredEpoch": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "RestoredLsn": "261", + "FailureError": null + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionsEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionsEventList.json new file mode 100644 index 000000000000..26751d595220 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPartitionsEventList.json @@ -0,0 +1,57 @@ +{ + "operationId": "GetPartitionsEventList", + "description": "This example shows how to get all partitions-related events during a certain time window.", + "parameters": { + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "PartitionReconfigured", + "NodeName": "node1", + "NodeInstanceId": "ba001a8bb353543e646be031afb10f1e", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934595, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 203.1935, + "Phase3DurationMs": 0.0262, + "Phase4DurationMs": 628.8527, + "TotalDurationMs": 832.0724, + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "EventInstanceId": "e00fa5b7-f747-40dd-9e09-f5a031e96de4", + "TimeStamp": "2018-04-03T20:21:47.3778996Z", + "HasCorrelatedEvents": true + }, + { + "Kind": "PartitionReconfigured", + "NodeName": "node2", + "NodeInstanceId": "ba0459d257b028296deba8bd5add33cb", + "ServiceType": "Svc1Type", + "CcEpochDataLossVersion": 131672604833413107, + "CcEpochConfigVersion": 8589934596, + "ReconfigType": "Other", + "Result": "Completed", + "Phase0DurationMs": 0.0, + "Phase1DurationMs": 0.0, + "Phase2DurationMs": 205.667, + "Phase3DurationMs": 407.7781, + "Phase4DurationMs": 630.0935, + "TotalDurationMs": 1243.5386, + "PartitionId": "e12acfb3-2a43-4a1a-a252-aa5388ef1aec", + "EventInstanceId": "9aeb234a-16ef-4e8a-974e-26c60d6f2b86", + "TimeStamp": "2018-04-03T20:21:49.5155104Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfo-1.json new file mode 100644 index 000000000000..74665c5ff263 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfo-1.json @@ -0,0 +1,30 @@ +{ + "operationId": "GetPropertyInfo", + "description": "This example shows how to get a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyName": "AppData" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Name": "CalculatorAppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "Metadata": { + "TypeId": "String", + "CustomTypeId": "EquationType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 12, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "12" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-1.json new file mode 100644 index 000000000000..de3586fa9946 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-1.json @@ -0,0 +1,43 @@ +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-2.json new file mode 100644 index 000000000000..1475549419ca --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-2.json @@ -0,0 +1,51 @@ +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to get all Service Fabric properties and their values under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "PersistentQueueAppData$131439231986491349", + "IsConsistent": true, + "Properties": [ + { + "Name": "CalculatorAppData", + "Value": { + "Kind": "Int64", + "Data": "4534" + }, + "Metadata": { + "TypeId": "Int64", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:27:19.049Z", + "SequenceNumber": "10" + } + }, + { + "Name": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [6, 7, 8, 9, 10] + }, + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationDataType", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T04:36:19.049Z", + "SequenceNumber": "12" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-3.json new file mode 100644 index 000000000000..ed04219db38f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetPropertyInfoList-3.json @@ -0,0 +1,37 @@ +{ + "operationId": "GetPropertyInfoList", + "description": "This example shows how to page through the information about properties under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "IncludeValues": true, + "ContinuationToken": "PersistentQueueAppData$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "Properties": [ + { + "Name": "VolatileQueueAppData", + "Value": { + "Kind": "Double", + "Data": 67.89 + }, + "Metadata": { + "TypeId": "Double", + "CustomTypeId": "", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 8, + "LastModifiedUtcTimestamp": "2017-07-17T04:01:19.049Z", + "SequenceNumber": "8" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress-Running.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress-Running.json new file mode 100644 index 000000000000..9789fb25cd70 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress-Running.json @@ -0,0 +1,19 @@ +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has a State of Running. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Running" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress.json new file mode 100644 index 000000000000..9c2391300712 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetQuorumLossProgress.json @@ -0,0 +1,26 @@ +{ + "operationId": "GetQuorumLossProgress", + "description": "This shows an example of possible output when GetQuorumLossProgress has reached a State of Completed. If the State has a value of Running, only the State field will have a value.", + "parameters": { + "serviceId": "fabric:/myapp/myservice", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "OperationId": "81fbaee7-4f49-44bb-a350-4cb2b51dbf26", + "api-version": "6.0" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "State": "Completed", + "InvokeQuorumLossResult": { + "ErrorCode": 0, + "SelectedPartition": { + "ServiceName": "fabric:/myapp/myservice", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicaEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicaEventList.json new file mode 100644 index 000000000000..7dd44619a3b4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicaEventList.json @@ -0,0 +1,36 @@ +{ + "operationId": "GetPartitionReplicaEventList", + "description": "This example shows how to get all replica-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "replicaId": 131672608994209130, + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaNewHealthReport", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicasEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicasEventList.json new file mode 100644 index 000000000000..4caf2ba16921 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetReplicasEventList.json @@ -0,0 +1,52 @@ +{ + "operationId": "GetPartitionReplicasEventList", + "description": "This example shows how to get all replicas-related events during a certain time window.", + "parameters": { + "partitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "StatefulReplicaNewHealthReport", + "ReplicaInstanceId": 131672608994209130, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677787, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:43:38Z", + "PartitionId": "f2a6a893-39be-4c7d-b07f-72bc2d36de89", + "ReplicaId": 131672608994209130, + "EventInstanceId": "b2684da3-df81-4add-8baa-201f73e9195d", + "TimeStamp": "2018-04-03T21:43:38.8904013Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "StatefulReplicaNewHealthReport", + "ReplicaInstanceId": 177872608994339550, + "SourceId": "TestSource", + "Property": "", + "HealthState": "Error", + "TimeToLiveMs": 922337203685477, + "SequenceNumber": 131672654189677788, + "Description": "", + "RemoveWhenExpired": false, + "SourceUtcTimestamp": "2018-04-03T21:44:38Z", + "PartitionId": "f549f3b3-08c2-4ec4-adb4-415e024cb0ef", + "ReplicaId": 177872608994339550, + "EventInstanceId": "4a8851d8-35a3-4618-b4ac-03ffa191c350", + "TimeStamp": "2018-04-03T21:44:38.8904013Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-1.json new file mode 100644 index 000000000000..0ecc3ff2f4cb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-1.json @@ -0,0 +1,41 @@ +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "Items": [ + { + "Kind": "Service", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + }, + { + "Kind": "Partition", + "PolicyName": "BackupPolicy2", + "PolicyInheritedFrom": "Partition", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "SuspensionInfo": { + "IsSuspended": false, + "SuspensionInheritedFrom": "Invalid" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-2.json new file mode 100644 index 000000000000..4f92e9ce6e2d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupConfigurationInfo-2.json @@ -0,0 +1,32 @@ +{ + "operationId": "GetServiceBackupConfigurationInfo", + "description": "This example shows how to get list of backup configuration for this service and partitions under this service. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "Kind": "Partition", + "PolicyName": "BackupPolicy1", + "PolicyInheritedFrom": "Application", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionId": "7216486c-1ee9-4b00-99b2-92b26fcb07f6", + "SuspensionInfo": { + "IsSuspended": true, + "SuspensionInheritedFrom": "Partition" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-1.json new file mode 100644 index 000000000000..f910be4b18b1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-1.json @@ -0,0 +1,109 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups within a time range.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "StartDateTimeFilter": "2018-01-01T00:00:00Z", + "EndDateTimeFilter": "2018-01-01T23:59:59Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-2.json new file mode 100644 index 000000000000..136e5533ab2f --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-2.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get the latest backup for each partition within a service.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "Latest": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-3.json new file mode 100644 index 000000000000..628a7cac43d3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-3.json @@ -0,0 +1,64 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2 + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "Items": [ + { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "261", + "CreationTimeUtc": "2018-01-01T09:00:55Z", + "FailureError": null + }, + { + "BackupId": "7903dc2a-228d-44b0-b7c8-a13a6c9b46bd", + "BackupChainId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 17.01.02.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "446", + "CreationTimeUtc": "2018-01-01T17:01:02Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-4.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-4.json new file mode 100644 index 000000000000..150d8579c269 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceBackupList-4.json @@ -0,0 +1,65 @@ +{ + "operationId": "GetServiceBackupList", + "description": "This example shows how to get list of service backups. The number of results in a page are limited to maximum of two using the MaxResult parameter. This example uses the ContinuationToken parameter. The value of this parameter is provided from the previous query; in this case the example shown above. The response contains the remaining results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService", + "MaxResults": 2, + "ContinuationToken": "fabric:/CalcApp/CalcService#1daae3f5-7fd6-42e9-b1ba-8c05f873994d#7903dc2a-228d-44b0-b7c8-a13a6c9b46bd" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "Items": [ + { + "BackupId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 09.01.02.zip", + "BackupType": "Full", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "161", + "CreationTimeUtc": "2018-01-01T09:01:02Z", + "FailureError": null + }, + { + "BackupId": "d55a2d98-258b-4a34-8fe5-2063e81af9dc", + "BackupChainId": "0ff4fdbe-131c-4dfb-8249-7b4029ddc014", + "ApplicationName": "fabric:/CalcApp", + "ServiceManifestVersion": "1.0.0", + "ServiceName": "fabric:/CalcApp/CalcService", + "PartitionInformation": { + "LowKey": "-9223372036854775808", + "HighKey": "9223372036854775807", + "ServicePartitionKind": "Int64Range", + "Id": "81645ec7-d260-4c59-9533-8f129bde8e83" + }, + "BackupLocation": "CalcApp\\CalcService\\81645ec7-d260-4c59-9533-8f129bde8e83\\2018-01-01 17.00.34.zip", + "BackupType": "Incremental", + "EpochOfLastBackupRecord": { + "DataLossVersion": "131462452931584510", + "ConfigurationVersion": "8589934592" + }, + "LsnOfLastBackupRecord": "246", + "CreationTimeUtc": "2018-01-01T17:00:34Z", + "FailureError": null + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceEventList.json new file mode 100644 index 000000000000..c07a17beb96c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceEventList.json @@ -0,0 +1,35 @@ +{ + "operationId": "GetServiceEventList", + "description": "This example shows how to get all service-related events during a certain time window.", + "parameters": { + "serviceId": "app1~svc1", + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoByName-1.json new file mode 100644 index 000000000000..8fc70e01daf3 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoByName-1.json @@ -0,0 +1,39 @@ +{ + "operationId": "GetServiceTypeInfoByName", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specified service type is not found in the cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0", + "serviceTypeName": "Actor1ActorServiceType" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + }, + "204": { + "headers": {}, + "body": "" + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoList-1.json new file mode 100644 index 000000000000..ccc292e62e0c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServiceTypeInfoList-1.json @@ -0,0 +1,36 @@ +{ + "operationId": "GetServiceTypeInfoList", + "description": "This example shows how to get information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "parameters": { + "api-version": "6.0", + "applicationTypeName": "Application2Type", + "ApplicationTypeVersion": "1.0.0" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "ServiceTypeDescription": { + "IsStateful": true, + "ServiceTypeName": "Actor1ActorServiceType", + "PlacementConstraints": "", + "HasPersistedState": true, + "Kind": "Stateful", + "Extensions": [ + { + "Key": "__GeneratedServiceType__", + "Value": "\r\n \r\n \r\n \r\n \r\n \r\n \r\n " + } + ], + "LoadMetrics": [], + "ServicePlacementPolicies": [] + }, + "ServiceManifestVersion": "1.0.0", + "ServiceManifestName": "Actor1Pkg", + "IsServiceGroup": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServicesEventList.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServicesEventList.json new file mode 100644 index 000000000000..04e7298785ad --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetServicesEventList.json @@ -0,0 +1,51 @@ +{ + "operationId": "GetServicesEventList", + "description": "This example shows how to get all services-related events during a certain time window.", + "parameters": { + "api-version": "6.4", + "StartTimeUtc": "2018-04-03T18:00:00Z", + "EndTimeUtc": "2018-04-04T18:00:00Z" + }, + "responses": { + "200": { + "headers": { + }, + "body": [ + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc1Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "bd936249-183d-4e29-94ab-2e198e4e2e87", + "ServiceId": "app1/svc1", + "EventInstanceId": "8ba26506-4a93-4b8c-ae14-29a2841b3003", + "TimeStamp": "2018-04-03T20:22:38.0560496Z", + "HasCorrelatedEvents": false + }, + { + "Kind": "ServiceCreated", + "ServiceTypeName": "Svc2Type", + "ApplicationName": "fabric:/app1", + "ApplicationTypeName": "App1Type", + "ServiceInstance": 131672605579916062, + "IsStateful": true, + "PartitionCount": 2, + "TargetReplicaSetSize": 3, + "MinReplicaSetSize": 2, + "ServicePackageVersion": "1.0:1.0", + "PartitionId": "87413d64-0134-4b23-a439-c2692c4e3ec3", + "ServiceId": "app1/svc2", + "EventInstanceId": "03246d3b-77f5-4ca2-b065-7b8671711318", + "TimeStamp": "2018-04-03T20:22:38.056197Z", + "HasCorrelatedEvents": false + } + ] + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-1.json new file mode 100644 index 000000000000..d2aad11d56b1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-1.json @@ -0,0 +1,22 @@ +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to get information about all sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/CalculatorApp", + "fabric:/samples/mynames" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-2.json new file mode 100644 index 000000000000..441fa7ea5da7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-2.json @@ -0,0 +1,28 @@ +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to recursively get information about all child sub names of a given Service Fabric name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps", + "fabric:/samples/data", + "fabric:/samples/CalculatorApp", + "fabric:/samples/CalculatorApp/CalculatorService", + "fabric:/samples/CalculatorApp/CalculatorService/Name-1", + "fabric:/samples/CalculatorApp/CalculatorService/Name-2", + "fabric:/samples/mynames/name-1" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-3.json new file mode 100644 index 000000000000..661dbcc22deb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetSubNameInfoList-3.json @@ -0,0 +1,24 @@ +{ + "operationId": "GetSubNameInfoList", + "description": "This example shows how to page through the information about sub names under a given Service Fabric name using ContinuationToken parameter. The value of this parameter is provided from the previous query, in this case the example shown above. The response contains the remaining two results and an empty ContinuationToken. The empty ContinuationToken indicates that additional results are not available.", + "parameters": { + "api-version": "6.0", + "nameId": "samples", + "Recursive": true, + "ContinuationToken": "fabric:/samples/apps/PersistentQueueApp$131439231986491349" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "ContinuationToken": "", + "IsConsistent": true, + "SubNames": [ + "fabric:/samples/apps/VolatileQueueApp", + "fabric:/samples/apps/NotepadApp" + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionById.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionById.json new file mode 100644 index 000000000000..2cee9beefa54 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionById.json @@ -0,0 +1,34 @@ +{ + "operationId": "GetImageStoreUploadSessionById", + "description": "This example shows how to get image store upload session by a given ID.", + "parameters": { + "api-version": "6.0", + "session-id": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "4a2340e8-d8d8-497c-95fe-cdaa1052f33b", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:06:37.260Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "402128" + }, + { + "StartPosition": "730105", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionByPath.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionByPath.json new file mode 100644 index 000000000000..5f5ad736f03e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/GetUploadSessionByPath.json @@ -0,0 +1,50 @@ +{ + "operationId": "GetImageStoreUploadSessionByPath", + "description": "This example shows how to get image store upload session by a given relative path.", + "parameters": { + "api-version": "6.0", + "contentPath": "SwaggerTest\\Common.dll" + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "UploadSessions": [ + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "2032ac6c-a348-4594-86da-dab0f2bb1ae1", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.627Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "207615" + }, + { + "StartPosition": "626977", + "EndPosition": "2097151" + } + ] + }, + { + "StoreRelativePath": "SwaggerTest\\Common.dll", + "SessionId": "fb2da2b2-7cb4-45d2-a2e6-c4888d205bc5", + "FileSize": "2097152", + "ModifiedDate": "2017-09-28T17:28:11.643Z", + "ExpectedRanges": [ + { + "StartPosition": "0", + "EndPosition": "616947" + }, + { + "StartPosition": "1087529", + "EndPosition": "2097151" + } + ] + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi.json new file mode 100644 index 000000000000..bb4610ae2e2d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi.json @@ -0,0 +1,27 @@ +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP GET for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "Node01", + "applicationId": "samples/winnodejs", + "ServiceManifestName": "NodeServicePackage", + "CodePackageName": "NodeService.Code", + "CodePackageInstanceId": "131668159770315380", + "ContainerApiRequestBody": { + "UriPath": "/containers/{id}/logs?stdout=true&stderr=true" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "text/plain; charset=utf-8", + "Body": "vEthernet (Container NIC ec5c19b2) 172.17.201.44\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi_Post.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi_Post.json new file mode 100644 index 000000000000..dfbdcf541aef --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/InvokeContainerApi_Post.json @@ -0,0 +1,29 @@ +{ + "operationId": "InvokeContainerApi", + "description": "This example shows how to call container API with HTTP POST for a code package deployed on a node.", + "parameters": { + "api-version": "6.2", + "nodeName": "N0020", + "applicationId": "samples/nodejs1", + "ServiceManifestName": "NodeOnSF", + "CodePackageName": "Code", + "CodePackageInstanceId": "131673596679688285", + "ContainerApiRequestBody": { + "HttpVerb": "POST", + "UriPath": "/containers/{id}/update", + "Body": "{ \"CpuShares\": 512}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContainerApiResult": { + "Status": 200, + "Content-Type": "application/json", + "Body": "{\"Warnings\":null}\n" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-1.json new file mode 100644 index 000000000000..511aa04cf3ed --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-1.json @@ -0,0 +1,19 @@ +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "Binary", + "Data": [0, 1, 2, 3, 4, 5] + } + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-2.json new file mode 100644 index 000000000000..1d597a75d6c0 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/PutProperty-2.json @@ -0,0 +1,20 @@ +{ + "operationId": "PutProperty", + "description": "This example shows how to create or update a Service Fabric property under a given name with a custom type.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "PropertyDescription": { + "PropertyName": "AppData", + "Value": { + "Kind": "String", + "Data": "1+2=3" + }, + "CustomTypeId": "EquationType" + } + }, + "responses": { + "200": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json new file mode 100644 index 000000000000..dbf77d13f9cd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json @@ -0,0 +1,18 @@ +{ + "operationId": "MeshCodePackage_GetContainerLogs", + "description": "This example shows how to get logs from the container of service replica. If the container exists, the logs are returned with an OK (200) status code, otherwise an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sbzDocApp", + "serviceResourceName": "sbzDocService", + "replicaName": "0", + "codePackageName": "sbzDocCode" + }, + "responses": { + "200": { + "body": { + "Content": " * Running on http://0.0.0.0:8080/ (Press CTRL+C to quit)\n * Downloading style https://assets-cdn.github.com/assets/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css\n * Downloading style https://assets-cdn.github.com/assets/github-a698da0d53574b056d3c79ac732d4a70.css\n * Downloading style https://assets-cdn.github.com/assets/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css\n * Cached all downloads in /root/.grip/cache-4.5.2\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET / HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/frameworks-8f281eb0a8d2308ceb36e714ba3c3aec.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/site-83dc1f7ebc9c7461fe1eab799b56c4c4.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/asset/github-a698da0d53574b056d3c79ac732d4a70.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:02] \"GET /__/grip/static/octicons/octicons.css HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/octicons/octicons.woff2?ef21c39f0ca9b1b5116e5eb7ac5eabe6 HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:03] \"GET /__/grip/static/favicon.ico HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:05] \"GET /seabreeze-index.md HTTP/1.1\" 200 -\n167.220.0.83 - - [06/Apr/2018 07:16:09] \"GET /seabreeze-api-application_get.md HTTP/1.1\" 200 -\n" + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/get.json new file mode 100644 index 000000000000..f6e7eab04de5 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/get.json @@ -0,0 +1,57 @@ +{ + "operationId": "MeshServiceReplica_Get", + "description": "This example shows how to get information about given replica of a service. If the replica exists, its description is returned along with an OK (200) status code. If the replica does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService", + "replicaName": "0" + }, + "responses": { + "200": { + "body": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/list.json new file mode 100644 index 000000000000..ee73a7748f5d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/Replicas/list.json @@ -0,0 +1,105 @@ +{ + "operationId": "MeshServiceReplica_List", + "description": "This example shows how to list replicas of a service resources for a given application.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "0" + }, + { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + }, + "instanceView": { + "restartCount": 1, + "currentState": { + "state": "Running", + "exitCode": "0" + }, + "previousState": { + "state": "NotSpecified", + "exitCode": "0" + } + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "replicaName": "1" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/get.json new file mode 100644 index 000000000000..52d8e749caab --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/get.json @@ -0,0 +1,51 @@ +{ + "operationId": "MeshService_Get", + "description": "This example shows how to get a service resource for a given application. If the service resource exists, its description is returned along with an OK (200) status code. If the service resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication", + "serviceResourceName": "helloWorldService" + }, + "responses": { + "200": { + "body": { + "name": "helloWorldService", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/list.json new file mode 100644 index 000000000000..3cc5e7635da0 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/Services/list.json @@ -0,0 +1,56 @@ +{ + "operationId": "MeshService_List", + "description": "This example shows how to list all service resources for a given application.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "helloWorldService", + "properties": { + "osType": "Linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ], + "description": "SeaBreeze Hello World Service.", + "replicaCount": 1, + "healthState": "Ok", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.autoscale.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.autoscale.json new file mode 100644 index 000000000000..2826884763dc --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.autoscale.json @@ -0,0 +1,102 @@ +{ + "operationId": "MeshApplication_CreateOrUpdate", + "description": "This example shows how to create or update a application resource with services that autoscale based on the policies.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication", + "applicationResourceDescription": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "services": [ + { + "name": "helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "replicaCount": 1, + "autoScalingPolicies": [ + { + "name": "MyAutoScaleRule", + "trigger": { + "kind": "AverageLoad", + "metric": { + "kind": "Resource", + "name": "cpu" + }, + "lowerLoadThreshold": 0.3, + "upperLoadThreshold": 0.8, + "scaleIntervalInSeconds": 3600 + }, + "mechanism": { + "kind": "AddRemoveReplica", + "minCount": 1, + "maxCount": 4, + "scaleIncrement": 1 + } + } + ], + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + }, + "201": { + "body": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Unknown", + "status": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.json new file mode 100644 index 000000000000..2a7592662cbb --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/create_update.json @@ -0,0 +1,81 @@ +{ + "operationId": "MeshApplication_CreateOrUpdate", + "description": "This example shows how to create or update a application resource.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication", + "applicationResourceDescription": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "services": [ + { + "name": "helloWorldService", + "properties": { + "description": "SeaBreeze Hello World Service.", + "osType": "linux", + "codePackages": [ + { + "name": "helloWorldCode", + "image": "seabreeze/sbz-helloworld:1.0-alpine", + "endpoints": [ + { + "name": "helloWorldListener", + "port": 80 + } + ], + "resources": { + "requests": { + "memoryInGB": 1, + "cpu": 1 + } + } + } + ], + "replicaCount": 1, + "networkRefs": [ + { + "name": "sampleNetwork", + "endpointRefs": [ + { + "name": "helloWorldListener" + } + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + }, + "201": { + "body": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Unknown", + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/delete.json new file mode 100644 index 000000000000..6d95d21f61c5 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/delete.json @@ -0,0 +1,13 @@ +{ + "operationId": "MeshApplication_Delete", + "description": "This example shows how to delete an existing application resource. If the application resource exists and is deleted successfully, an empty response with 200 status code is returned. If the application resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/get.json new file mode 100644 index 000000000000..4d5e666458cd --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/get.json @@ -0,0 +1,23 @@ +{ + "operationId": "MeshApplication_Get", + "description": "This example shows how to get a application resource. If the application resource exists, its description is returned along with an OK (200) status code. If the application resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "applicationResourceName": "sampleApplication" + }, + "responses": { + "200": { + "body": { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/list.json new file mode 100644 index 000000000000..e807a242321c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Applications/list.json @@ -0,0 +1,28 @@ +{ + "operationId": "MeshApplication_List", + "description": "This example shows how to list all application resources.", + "parameters": { + "api-version": "6.4-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "sampleApplication", + "properties": { + "description": "Service Fabric Mesh sample application.", + "serviceNames": [ + "helloWorldService" + ], + "healthState": "Ok", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/create_update.json new file mode 100644 index 000000000000..9f1a8f7d4d23 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/create_update.json @@ -0,0 +1,193 @@ +{ + "operationId": "MeshGateway_CreateOrUpdate", + "description": "This example shows how to create or update a gateway resource.", + "parameters": { + "api-version": "6.4-preview", + "gatewayResourceName": "sampleGateway", + "gatewayResourceDescription": { + "name": "sampleGateway", + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleGateway", + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Ready", + "ipAddress": "192.168.1.1" + } + } + }, + "201": { + "body": { + "name": "sampleGateway", + "properties": { + "description": "Service Fabric Mesh Hello World sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Creating", + "ipAddress": "" + } + } + }, + "202": {} + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/delete.json new file mode 100644 index 000000000000..61493d8b00de --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/delete.json @@ -0,0 +1,13 @@ +{ + "operationId": "MeshGateway_Delete", + "description": "This example shows how to delete an existing gateway resource. If the gateway resource exists and is deleted successfully, an empty response with 200 status code is returned. If the gateway resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/get.json new file mode 100644 index 000000000000..443eb1d4bc91 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/get.json @@ -0,0 +1,72 @@ +{ + "operationId": "MeshGateway_Get", + "description": "This example shows how to get a gateway resource. If the gateway resource exists, its description is returned along with an OK (200) status code. If the gateway resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "gatewayResourceName": "sampleGateway" + }, + "responses": { + "200": { + "body": { + "name": "sampleGateway", + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Ready", + "ipAddress": "192.168.1.1" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/list.json new file mode 100644 index 000000000000..e737dda49f0d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Gateways/list.json @@ -0,0 +1,77 @@ +{ + "operationId": "MeshGateway_List", + "description": "This example shows how to list all gateway resources.", + "parameters": { + "api-version": "6.4-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "sampleGateway", + "properties": { + "description": "Service Fabric Mesh sample gateway.", + "sourceNetwork": { + "name": "Open" + }, + "destinationNetwork": { + "name": "helloWorldNetwork" + }, + "tcp": [ + { + "name": "web", + "port": 80, + "destination": { + "applicationName": "helloWorldApp", + "serviceName": "helloWorldService", + "endpointName": "helloWorldListener" + } + } + ], + "http": [ + { + "name": "contosoWebsite", + "port": 8081, + "hosts": [ + { + "name": "contoso.com", + "routes": [ + { + "name": "index", + "match": { + "path": { + "value": "/index", + "rewrite": "/", + "type": "prefix" + }, + "headers": [ + { + "name": "accept", + "value": "application/json", + "type": "exact" + } + ] + }, + "destination": { + "applicationName": "httpHelloWorldApp", + "serviceName": "indexService", + "endpointName": "indexHttpEndpoint" + } + } + ] + } + ] + } + ], + "status": "Ready", + "ipAddress": "192.168.1.1" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/create_update.json new file mode 100644 index 000000000000..e20715f46dc4 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/create_update.json @@ -0,0 +1,41 @@ +{ + "operationId": "MeshNetwork_CreateOrUpdate", + "description": "This example shows how to create or update a network resource.", + "parameters": { + "api-version": "6.4-preview", + "networkResourceName": "sampleNetwork", + "networkResourceDescription": { + "name": "sampleNetwork", + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleNetwork", + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + }, + "201": { + "body": { + "name": "sampleNetwork", + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/delete.json new file mode 100644 index 000000000000..8ccd62176808 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/delete.json @@ -0,0 +1,13 @@ +{ + "operationId": "MeshGateway_Delete", + "description": "This example shows how to delete an existing network resource. If the network resource exists and is deleted successfully, an empty response with 200 status code is returned. If the network resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/get.json new file mode 100644 index 000000000000..3dacfeedf16e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/get.json @@ -0,0 +1,21 @@ +{ + "operationId": "MeshGateway_Get", + "description": "This example shows how to get a network resource. If the network resource exists, its description is returned along with an OK (200) status code. If the network resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "networkResourceName": "sampleNetwork" + }, + "responses": { + "200": { + "body": { + "name": "sampleNetwork", + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/list.json new file mode 100644 index 000000000000..dbca38c49ac7 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Networks/list.json @@ -0,0 +1,26 @@ +{ + "operationId": "MeshGateway_List", + "description": "This example shows how to list all network resources.", + "parameters": { + "api-version": "6.4-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "sampleNetwork", + "properties": { + "kind": "Local", + "description": "Service Fabric Mesh sample network.", + "networkAddressPrefix": "2.0.0.0/16", + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/create_update.json new file mode 100644 index 000000000000..bac9d6d237ef --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/create_update.json @@ -0,0 +1,41 @@ +{ + "operationId": "MeshSecret_CreateOrUpdate", + "description": "This example shows how to create or update a secret resource.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString", + "secretResourceDescription": { + "name": "dbConnectionString", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!" + } + } + }, + "responses": { + "200": { + "body": { + "name": "dbConnectionString", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + }, + "201": { + "body": { + "name": "dbConnectionString", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Creating" + } + } + }, + "202": {} + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/delete.json new file mode 100644 index 000000000000..bd9940e59b2d --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/delete.json @@ -0,0 +1,13 @@ +{ + "operationId": "MeshSecret_Delete", + "description": "This example shows how to delete an existing secret resource. If the secret resource exists and is deleted successfully, an empty response with 200 status code is returned. If the secret resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/get.json new file mode 100644 index 000000000000..433b1a90bbe8 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/get.json @@ -0,0 +1,21 @@ +{ + "operationId": "MeshSecret_Get", + "description": "This example shows how to get a secret resource. If the secret resource exists, its description is returned along with an OK (200) status code. If the secret resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "name": "dbConnectionString", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/list.json new file mode 100644 index 000000000000..3d64768d6f0c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/list.json @@ -0,0 +1,35 @@ +{ + "operationId": "MeshSecret_List", + "description": "This example shows how to list all secret resources.", + "parameters": { + "api-version": "6.4-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "dbConnectionString", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "Mongo DB connection string for backend database!", + "status": "Ready" + } + }, + { + "name": "contosoServiceApiKey", + "properties": { + "kind": "inlinedValue", + "contentType": "text/plain", + "description": "API Key to access contoso service APIs", + "status": "Ready" + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/create.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/create.json new file mode 100644 index 000000000000..4fa0ee15906e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/create.json @@ -0,0 +1,36 @@ +{ + "operationId": "MeshSecretValue_AddValue", + "description": "This example shows how to add a new value of a secret resource; the secret value is provided as plaintext.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1", + "secretValueResourceDescription": { + "name": "v1", + "properties": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + }, + "responses": { + "200": { + "body": { + "name": "v1", + "properties": { + "value": null + } + } + }, + "201": { + "body": { + "name": "v1", + "properties": { + "value": null + } + } + }, + "202": { + } + } +} + diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/delete.json new file mode 100644 index 000000000000..78f62cc08431 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/delete.json @@ -0,0 +1,15 @@ +{ + "operationId": "MeshSecretValue_Delete", + "description":"This example shows how to delete a secret value. If the specified named value exists and is deleted successfully, an empty response with 200 status code is returned. If the specified named value does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} + diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/get.json new file mode 100644 index 000000000000..ba770190cf88 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/get.json @@ -0,0 +1,20 @@ +{ + "operationId": "MeshSecretValue_Get", + "description":"This example shows how to get the specified secret value resource. If the specified named value exists, its information is returned along with status code 200. The information does not include the value. To get the unecnrypted value use ListMeshSecretValue operation. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "name": "v1", + "properties": { + "value": null + } + } + } + } +} + diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list.json new file mode 100644 index 000000000000..b647c7f64976 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list.json @@ -0,0 +1,29 @@ +{ + "operationId": "MeshSecretValue_List", + "description": "This example shows how to list names of all values of a secret resource, not including their respective values.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString" + }, + "responses": { + "200": { + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "v1", + "properties": { + "value": null + } + }, + { + "name": "v2", + "properties": { + "value": null + } + } + ] + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list_value.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list_value.json new file mode 100644 index 000000000000..e23a120ac25e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Secrets/values/list_value.json @@ -0,0 +1,16 @@ +{ + "operationId": "MeshSecretValue_Show", + "description": "This example shows how to get the unencrypted value of the secret. If the specified named value resource exists, its unencrypted value is returned along with status code 200. If the specified named value does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "secretResourceName": "dbConnectionString", + "secretValueResourceName": "v1" + }, + "responses": { + "200": { + "body": { + "value": "mongodb://contoso123:0Fc3IolnL12312asdfawejunASDF@asdfYXX2t8a97kghVcUzcDv98hawelufhawefafnoQRGwNj2nMPL1Y9qsIr9Srdw==@contoso123.documents.azure.com:10255/mydatabase?ssl=true" + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/create_update.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/create_update.json new file mode 100644 index 000000000000..d8c44b3f7a53 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/create_update.json @@ -0,0 +1,52 @@ +{ + "operationId": "MeshVolume_CreateOrUpdate", + "description": "This example shows how to create or update a volume resource.", + "parameters": { + "api-version": "6.4-preview", + "volumeResourceName": "sampleVolume", + "volumeResourceDescription": { + "properties": { + "description": "Service Fabric Mesh sample volume.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": "provide-account-key-here", + "shareName": "sharel" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleVolume", + "properties": { + "description": "Service Fabric Mesh sample volume.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": null, + "shareName": "sharel" + }, + "status": "Ready" + } + } + }, + "201": { + "body": { + "name": "sampleVolume", + "properties": { + "description": "Service Fabric Mesh Hello World sample volume.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": null, + "shareName": "sharel" + }, + "status": "Creating" + } + } + }, + "202": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/delete.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/delete.json new file mode 100644 index 000000000000..9c324d3a5c36 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/delete.json @@ -0,0 +1,13 @@ +{ + "operationId": "MeshVolume_Delete", + "description": "This example shows how to delete an existing volume resource. If the volume resource exists and is deleted successfully, an empty response with 200 status code is returned. If the volume resource does not exist, an empty response with 204 status code is returned.", + "parameters": { + "api-version": "6.4-preview", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/get.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/get.json new file mode 100644 index 000000000000..56de5fe39c3c --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/get.json @@ -0,0 +1,25 @@ +{ + "operationId": "MeshVolume_Get", + "description": "This example shows how to get a volume resource. If the volume resource exists, its description is returned along with an OK (200) status code. If the volume resource does not exist, an error is returned with an appropriate status code.", + "parameters": { + "api-version": "6.4-preview", + "volumeResourceName": "sampleVolume" + }, + "responses": { + "200": { + "body": { + "name": "sampleVolume", + "properties": { + "description": "Service Fabric Mesh sample volume.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": null, + "shareName": "sharel" + }, + "status": "Ready" + } + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/list.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/list.json new file mode 100644 index 000000000000..306096163da8 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/Resources/Volumes/list.json @@ -0,0 +1,30 @@ +{ + "operationId": "MeshVolume_List", + "description": "This example shows how to list all volume resources.", + "parameters": { + "api-version": "6.4-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "ContinuationToken": "", + "Items": [ + { + "name": "sampleVolume", + "properties": { + "description": "Service Fabric Mesh sample volume.", + "provider": "SFAzureFile", + "azureFileParameters": { + "accountName": "sbzdemoaccount", + "accountKey": null, + "shareName": "sharel" + }, + "status": "Ready" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/RestorePartition.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/RestorePartition.json new file mode 100644 index 000000000000..673d9fa6a2e5 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/RestorePartition.json @@ -0,0 +1,21 @@ +{ + "operationId": "RestorePartition", + "description": "This example shows how to trigger restore of a partition now by specifying the backup to be used to restore.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d", + "RestorePartitionDescription": { + "BackupId": "3a056ac9-7206-43c3-8424-6f6103003eba", + "BackupStorage": { + "StorageKind": "AzureBlobStore", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "BackupLocation": "CalcApp\\CalcService\\1daae3f5-7fd6-42e9-b1ba-8c05f873994d\\2018-01-01 09.00.55.zip" + } + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeApplicationBackup.json new file mode 100644 index 000000000000..cd8e1eb99288 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeApplicationBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumeApplicationBackup", + "description": "This example shows how to resume periodic backup for a stateful application which was previously suspended.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumePartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumePartitionBackup.json new file mode 100644 index 000000000000..d8a0b8ad5dcf --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumePartitionBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumePartitionBackup", + "description": "This example shows how to resume periodic backup for a stateful partition which was previously suspended.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeServiceBackup.json new file mode 100644 index 000000000000..f611677411e1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/ResumeServiceBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "ResumeServiceBackup", + "description": "This example shows how to resume periodic backup for a stateful service which was previously suspended.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/StartClusterConfigurationUpgrade-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/StartClusterConfigurationUpgrade-1.json new file mode 100644 index 000000000000..6bd0e2ab12ed --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/StartClusterConfigurationUpgrade-1.json @@ -0,0 +1,42 @@ +{ + "operationId": "StartClusterConfigurationUpgrade", + "description": "This example shows how to start upgrading the configuration of a Service Fabric standalone cluster.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps/CalculatorApp", + "ClusterConfigurationUpgradeDescription": { + "ClusterConfig": "", + "ApplicationHealthPolicies": { + "ApplicationHealthPolicyMap": [ + { + "Key": "fabric:/samples/CalculatorApp", + "Value": { + "ConsiderWarningAsError": true, + "MaxPercentUnhealthyDeployedApplications": 10, + "DefaultServiceTypeHealthPolicy": { + "MaxPercentUnhealthyPartitionsPerService": 0, + "MaxPercentUnhealthyReplicasPerPartition": 0, + "MaxPercentUnhealthyServices": 0 + }, + "ServiceTypeHealthPolicyMap": [ + { + "Key": "Svc1Type", + "Value": { + "MaxPercentUnhealthyPartitionsPerService": 0, + "MaxPercentUnhealthyReplicasPerPartition": 0, + "MaxPercentUnhealthyServices": 10 + } + } + ] + } + } + ] + } + + } + }, + "responses": { + "202": { + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SubmitPropertyBatch-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SubmitPropertyBatch-1.json new file mode 100644 index 000000000000..3b8279165b6a --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SubmitPropertyBatch-1.json @@ -0,0 +1,67 @@ +{ + "operationId": "SubmitPropertyBatch", + "description": "This example shows how to submit a property batch. This batch ensures that a property exists, checks that the property has the expected sequence number, and edits the property only if the previous conditions succeed. It then performs a get operation to get the property's current info. \r\n If all of the operations succeed, the batch is committed in a transactional manner and a success response is returned with 200 status code. \r\n If the batch fails then a failed response is returned with 409 status code. The failed response below shows batch failure because the property does not have expected sequence number.", + "parameters": { + "api-version": "6.0", + "nameId": "samples/apps", + "PropertyBatchDescriptionList": { + "Operations": [ + { + "Kind": "CheckExists", + "PropertyName": "PersistentQueueAppData", + "Exits": true + }, + { + "Kind": "CheckSequence", + "PropertyName": "PersistentQueueAppData", + "SequenceNumber": "12" + }, + { + "Kind": "Put", + "PropertyName": "PersistentQueueAppData", + "Value": { + "Kind": "Binary", + "Data": [1, 2, 3, 4, 5] + }, + "CustomTypeId": "InitializationData" + }, + { + "Kind": "Get", + "PropertyName": "PersistentQueueAppData", + "IncludeValue": false + } + ] + } + }, + "responses": { + "200": { + "headers": { + }, + "body": { + "Kind": "Successful", + "Properties": { + "3": { + "Name": "PersistentQueueAppData", + "Metadata": { + "TypeId": "Binary", + "CustomTypeId": "InitializationData", + "Parent": "fabric:/samples/apps", + "SizeInBytes": 5, + "LastModifiedUtcTimestamp": "2017-07-17T05:01:19.049Z", + "SequenceNumber": "13" + } + } + } + } + }, + "409": { + "headers": { + }, + "body": { + "Kind": "Failed", + "ErrorMessage": "FABRIC_E_PROPERTY_CHECK_FAILED", + "OperationIndex": 1 + } + } + } +} diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendApplicationBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendApplicationBackup.json new file mode 100644 index 000000000000..c2af9d9786e5 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendApplicationBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendApplicationBackup", + "description": "This example shows how to suspend backup for a stateful application which is configured for periodic backup.", + "parameters": { + "api-version": "6.4", + "applicationId": "CalcApp" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendPartitionBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendPartitionBackup.json new file mode 100644 index 000000000000..8794b225e7dc --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendPartitionBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendPartitionBackup", + "description": "This example shows how to suspend backup for a stateful partition which is configured for periodic backup.", + "parameters": { + "api-version": "6.4", + "partitionId": "1daae3f5-7fd6-42e9-b1ba-8c05f873994d" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendServiceBackup.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendServiceBackup.json new file mode 100644 index 000000000000..ba017cb39152 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/SuspendServiceBackup.json @@ -0,0 +1,12 @@ +{ + "operationId": "SuspendServiceBackup", + "description": "This example shows how to suspend backup for a stateful service which is configured for periodic backup.", + "parameters": { + "api-version": "6.4", + "serviceId": "CalcApp/CalcService" + }, + "responses": { + "202": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateBackupPolicy.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateBackupPolicy.json new file mode 100644 index 000000000000..08953f880420 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateBackupPolicy.json @@ -0,0 +1,36 @@ +{ + "operationId": "UpdateBackupPolicy", + "description": "This example shows how to update the schedule of a backup policy to take backup twice everyday at 9 AM and 5 PM UTC which shall get deleted after 30 days, with Azure blob store as the backup location.", + "parameters": { + "api-version": "6.4", + "backupPolicyName": "DailyAzureBackupPolicy", + "BackupPolicyDescription": { + "Name": "DailyAzureBackupPolicy", + "AutoRestoreOnDataLoss": false, + "MaxIncrementalBackups": 3, + "Schedule": { + "ScheduleKind": "TimeBased", + "ScheduleFrequencyType": "Daily", + "RunTimes": [ + "0001-01-01T09:00:00Z", + "0001-01-01T17:00:00Z" + ] + }, + "Storage": { + "StorageKind": "AzureBlobStore", + "FriendlyName": "Azure_storagesample", + "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=storagesample;AccountKey=", + "ContainerName": "BackupContainer" + }, + "RetentionPolicy": { + "RetentionPolicyType": "Basic", + "MinimumNumberOfBackups": 60, + "RetentionDuration": "P30D" + } + } + }, + "responses": { + "200": { + } + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-1.json new file mode 100644 index 000000000000..094f2116cbaa --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-1.json @@ -0,0 +1,34 @@ +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateless Service Fabric service.", + "parameters": { + "serviceId": "test~test1", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateless", + "Flags": "1568", + "PlacementConstraints": "Color==Red", + "DefaultMoveCost": "High", + "ScalingPolicies": [ + { + "ScalingTrigger": { + "Kind": "AveragePartitionLoad", + "MetricName": "servicefabric:\/_CpuCores", + "LowerLoadThreshold": 0.500000, + "UpperLoadThreshold": 0.800000, + "ScaleIntervalInSeconds": 900 + }, + "ScalingMechanism": { + "Kind": "PartitionInstanceCount", + "MinInstanceCount": 4, + "MaxInstanceCount": 6, + "ScaleIncrement": 2 + } + } + ] + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-2.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-2.json new file mode 100644 index 000000000000..c5dca7b1cc6e --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/examples/UpdateService-2.json @@ -0,0 +1,17 @@ +{ + "operationId": "UpdateService", + "description": "This example shows how to update placement and load balancing related settings of a stateful Service Fabric service.", + "parameters": { + "serviceId": "test~test2", + "api-version": "6.0", + "ServiceUpdateDescription": { + "ServiceKind": "Stateful", + "Flags": "40", + "PlacementConstraints": "Color==Green", + "StandByReplicaKeepDurationSeconds": "1000" + } + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json new file mode 100644 index 000000000000..8917ab7afaa1 --- /dev/null +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json @@ -0,0 +1,26829 @@ +{ + "swagger": "2.0", + "info": { + "title": "Service Fabric Client APIs", + "description": "Service Fabric REST Client APIs allows management of Service Fabric clusters, applications and services.", + "version": "6.4.0.36" + }, + "host": "localhost:19080", + "schemes": [ + "http", + "https" + ], + "produces": [ + "application/json" + ], + "paths": { + "/$/GetClusterManifest": { + "get": { + "operationId": "GetClusterManifest", + "summary": "Get the Service Fabric cluster manifest.", + "description": "Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.\n\nThese properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest\nis generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal).\n\nThe contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster manifest information.", + "schema": { + "$ref": "#/definitions/ClusterManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealth": { + "get": { + "operationId": "GetClusterHealth", + "summary": "Gets the health of a Service Fabric cluster.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric cluster using the specified policy.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nSimilarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state.\nUse ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeSystemApplicationHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPoliciesOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health information.", + "schema": { + "$ref": "#/definitions/ClusterHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterHealthChunk": { + "get": { + "operationId": "GetClusterHealthChunk", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities.\nTo expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetClusterHealthChunkUsingPolicyAndAdvancedFilters", + "summary": "Gets the health of a Service Fabric cluster using health chunks.", + "description": "Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description.\nThe query description allows users to specify health policies for evaluating the cluster and its children.\nUsers can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthChunkQueryDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster health chunk information.", + "schema": { + "$ref": "#/definitions/ClusterHealthChunk" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ReportClusterHealth": { + "post": { + "operationId": "ReportClusterHealth", + "summary": "Sends a health report on the Service Fabric cluster.", + "description": "Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code when the cluster health report is accepted for processing." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedCodeVersions": { + "get": { + "operationId": "GetProvisionedFabricCodeVersionInfoList", + "summary": "Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CodeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned code versions information.", + "schema": { + "$ref": "#/definitions/FabricCodeVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetProvisionedConfigVersions": { + "get": { + "operationId": "GetProvisionedFabricConfigVersionInfoList", + "summary": "Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.", + "description": "Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested provisioned config versions information.", + "schema": { + "$ref": "#/definitions/FabricConfigVersionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeProgress": { + "get": { + "operationId": "GetClusterUpgradeProgress", + "summary": "Gets the progress of the current cluster upgrade.", + "description": "Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster upgrade progress.", + "schema": { + "$ref": "#/definitions/ClusterUpgradeProgressObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfiguration": { + "get": { + "operationId": "GetClusterConfiguration", + "summary": "Get the Service Fabric standalone cluster configuration.", + "description": "The cluster configuration contains properties of the cluster that include different node types on the cluster,\nsecurity configurations, fault, and upgrade domain topologies, etc.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ConfigurationApiVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration information.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterConfigurationUpgradeStatus": { + "get": { + "operationId": "GetClusterConfigurationUpgradeStatus", + "summary": "Get the cluster configuration upgrade status of a Service Fabric standalone cluster.", + "description": "Get the cluster configuration upgrade status details of a Service Fabric standalone cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster configuration upgrade status.", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetUpgradeOrchestrationServiceState": { + "get": { + "operationId": "GetUpgradeOrchestrationServiceState", + "summary": "Get the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/SetUpgradeOrchestrationServiceState": { + "post": { + "operationId": "SetUpgradeOrchestrationServiceState", + "summary": "Update the service state of Service Fabric Upgrade Orchestration Service.", + "description": "Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpgradeOrchestrationServiceStateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful response means that the service state of Service Fabric Upgrade Orchestration Service has been updated.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceStateSummary" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Provision": { + "post": { + "summary": "Provision the code or configuration packages of a Service Fabric cluster.", + "description": "Validate and provision the code or configuration packages of a Service Fabric cluster.", + "operationId": "ProvisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been provisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Unprovision": { + "post": { + "summary": "Unprovision the code or configuration packages of a Service Fabric cluster.", + "description": "It is supported to unprovision code and configuration separately.", + "operationId": "UnprovisionCluster", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UnprovisionFabricDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the code or configuration packages have been unprovisioned." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RollbackUpgrade": { + "post": { + "summary": "Roll back the upgrade of a Service Fabric cluster.", + "description": "Roll back the code or configuration upgrade of a Service Fabric cluster.", + "operationId": "RollbackClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the rollback of a cluster upgrade has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Make the cluster upgrade move on to the next upgrade domain.", + "description": "Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.", + "operationId": "ResumeClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ResumeClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful response means that the cluster upgrade has moved on to the next upgrade domain." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/Upgrade": { + "post": { + "summary": "Start upgrading the code or configuration version of a Service Fabric cluster.", + "description": "Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.", + "operationId": "StartClusterUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/StartClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "202": { + "description": "A successful response means that the cluster code or configuration upgrade has started. Use GetUpgradeProgress operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/StartClusterConfigurationUpgrade": { + "post": { + "summary": "Start upgrading the configuration of a Service Fabric standalone cluster.", + "description": "Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.", + "operationId": "StartClusterConfigurationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ClusterConfigurationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "x-ms-examples": { + "Start upgrading the configuration of a Service Fabric standalone cluster": { + "$ref": "./examples/StartClusterConfigurationUpgrade-1.json" + } + }, + "responses": { + "202": { + "description": "A successful response means that the cluster configuration upgrade has started. Use GetClusterConfigurationUpgradeStatus operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateUpgrade": { + "post": { + "operationId": "UpdateClusterUpgrade", + "summary": "Update the upgrade parameters of a Service Fabric cluster upgrade.", + "description": "Update the upgrade parameters used during a Service Fabric cluster upgrade.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UpdateClusterUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetAadMetadata": { + "get": { + "operationId": "GetAadMetadata", + "summary": "Gets the Azure Active Directory metadata used for secured connection to cluster.", + "description": "Gets the Azure Active Directory metadata used for secured connection to cluster.\nThis API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "schemes": [ + "https" + ], + "tags": [ + "Cluster" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the Azure Active Directory metadata.", + "schema": { + "$ref": "#/definitions/AadMetadataObject" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetClusterVersion": { + "get": { + "operationId": "GetClusterVersion", + "summary": "Get the current Service Fabric cluster version.", + "description": "If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions.", + "tags": [ + "Cluster" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/GetClusterVersion-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested cluster version information.", + "schema": { + "$ref": "#/definitions/ClusterVersion" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes": { + "get": { + "summary": "Gets the list of nodes in the Service Fabric cluster.", + "description": "The response includes the name, status, ID, health, uptime, and other details about the nodes.", + "operationId": "GetNodeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-3_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/NodeStatusFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get information about all nodes": { + "$ref": "./examples/GetNodeInfoList.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetNodeInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetNodeInfoList-2.json" + } + }, + "responses": { + "200": { + "description": "List of nodes in the cluster.", + "schema": { + "$ref": "#/definitions/PagedNodeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}": { + "get": { + "summary": "Gets the information about a specific node in the Service Fabric cluster.", + "description": "The response includes the name, status, ID, health, uptime, and other details about the node.", + "operationId": "GetNodeInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Node" + ], + "x-ms-examples": { + "Get a specific node by node name": { + "$ref": "./examples/GetNodeInfo-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return information about the node with the specified nodeName.", + "schema": { + "$ref": "#/definitions/NodeInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified nodeName is not found." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetHealth": { + "get": { + "operationId": "GetNodeHealth", + "summary": "Gets the health of a Service Fabric node.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetNodeHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric node, by using the specified health policy.", + "description": "Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ClusterHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/NodeHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/ReportHealth": { + "post": { + "operationId": "ReportNodeHealth", + "summary": "Sends a health report on the Service Fabric node.", + "description": "Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway node, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetLoadInformation": { + "get": { + "operationId": "GetNodeLoadInfo", + "summary": "Gets the load information of a Service Fabric node.", + "description": "Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node load information.", + "schema": { + "$ref": "#/definitions/NodeLoadInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Deactivate": { + "post": { + "operationId": "DisableNode", + "summary": "Deactivate a Service Fabric cluster node with the specified deactivation intent.", + "description": "Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeactivationIntentDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Activate": { + "post": { + "operationId": "EnableNode", + "summary": "Activate a Service Fabric cluster node that is currently deactivated.", + "description": "Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/RemoveNodeState": { + "post": { + "operationId": "RemoveNodeState", + "summary": "Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.", + "description": "This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/Restart": { + "post": { + "operationId": "RestartNode", + "summary": "Restarts a Service Fabric cluster node.", + "description": "Restarts a Service Fabric cluster node that is already started.", + "tags": [ + "Node" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartNodeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the node and it is in the process of restarting. Check the status of the node by calling GetNode operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationTypeInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationTypeInfoList-2.json" + }, + "Exclude application parameters from the result": { + "$ref": "./examples/GetApplicationTypeInfoList-3.json" + } + }, + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}": { + "get": { + "summary": "Gets the list of application types in the Service Fabric cluster matching exactly the specified name.", + "description": "Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. These results are of application types whose name match exactly the one specified as the parameter, and which comply with the given query parameters. All versions of the application type matching the application type name are returned, with each version returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.", + "operationId": "GetApplicationTypeInfoListByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "List of application types in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/$/Provision": { + "post": { + "operationId": "ProvisionApplicationType", + "summary": "Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.", + "description": "Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated.\nThe provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ProvisionApplicationTypeDescriptionBaseRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted and the provision operation has been initiated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/Unprovision": { + "post": { + "operationId": "UnprovisionApplicationType", + "summary": "Removes or unregisters a Service Fabric application type from the cluster.", + "description": "This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.", + "tags": [ + "ApplicationType" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/UnprovisionApplicationTypeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful provision will return 200 status code." + }, + "202": { + "description": "A 202 status code indicates the operation was accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.", + "operationId": "GetServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoList-1.json" + } + }, + "responses": { + "200": { + "description": "List of service types that are supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster.", + "description": "Gets the information about a specific service type that is supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned. A 204 response is returned if the specified service type is not found in the cluster.", + "operationId": "GetServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "x-ms-examples": { + "Get information about all nodes.": { + "$ref": "./examples/GetServiceTypeInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A specific service type which supported by a provisioned application type.", + "schema": { + "$ref": "#/definitions/ServiceTypeInfo" + } + }, + "204": { + "description": "A 204 response is returned if the specified service type is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetServiceManifest": { + "get": { + "summary": "Gets the manifest describing a service type.", + "description": "Gets the manifest describing a service type. The response contains the service manifest XML as a string.", + "operationId": "GetServiceManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about the service type.", + "schema": { + "$ref": "#/definitions/ServiceTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes": { + "get": { + "summary": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.", + "operationId": "GetDeployedServiceTypeInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "List of information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServiceTypes/{serviceTypeName}": { + "get": { + "summary": "Gets the information about a specified service type of the application deployed on a node in a Service Fabric cluster.", + "description": "Gets the list containing the information about a specific service type from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package. Each entry represents one activation of a service type, differentiated by the activation ID.", + "operationId": "GetDeployedServiceTypeInfoByName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployedServiceType_ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ServiceType" + ], + "responses": { + "200": { + "description": "Information about service types of an application deployed on a node.", + "schema": { + "$ref": "#/definitions/DeployedServiceTypeInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified service type of the application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/$/Create": { + "post": { + "summary": "Creates a Service Fabric application.", + "description": "Creates a Service Fabric application using the specified description.", + "operationId": "CreateApplication", + "x-ms-examples": { + "Create application.": { + "$ref": "./examples/CreateApplication-1.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "201": { + "description": "A successful response means that the application creation has been started. Use GetApplication operation to get the status of the application. Once GetApplicationInfo successfully returns application information, the application is created. If the application has default services those may be in the process of being created. Use GetServiceInfo operation to get the status of the service within the application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric application.", + "description": "An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.", + "operationId": "DeleteApplication", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetLoadInformation": { + "get": { + "summary": "Gets load information about a Service Fabric application.", + "description": "Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.", + "operationId": "GetApplicationLoadInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "Information about the application load.", + "schema": { + "$ref": "#/definitions/ApplicationLoadInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications": { + "get": { + "summary": "Gets the list of applications created in the Service Fabric cluster that match the specified filters.", + "description": "Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.", + "operationId": "GetApplicationInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationDefinitionKindFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationInfoList-2.json" + } + }, + "responses": { + "200": { + "description": "List of applications created in the cluster.", + "schema": { + "$ref": "#/definitions/PagedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}": { + "get": { + "summary": "Gets information about a Service Fabric application.", + "description": "Returns the information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, type, status, parameters, and other details about the application.", + "operationId": "GetApplicationInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ExcludeApplicationParametersOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "x-ms-examples": { + "Get a specific application by application id": { + "$ref": "./examples/GetApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "Information about the application.", + "schema": { + "$ref": "#/definitions/ApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the service fabric application.", + "description": "Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.", + "operationId": "GetApplicationHealth", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested application health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetApplicationHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric application using the specified policy.", + "description": "Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedApplicationsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServicesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested node health information.", + "schema": { + "$ref": "#/definitions/ApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportApplicationHealth", + "summary": "Sends a health report on the Service Fabric application.", + "description": "Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Application, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/Upgrade": { + "post": { + "summary": "Starts upgrading an application in the Service Fabric cluster.", + "description": "Validates the supplied application upgrade parameters and starts upgrading the application if the parameters are valid.", + "operationId": "StartApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has started. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this application.", + "description": "Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.", + "operationId": "GetApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "The application upgrade details.", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/UpdateUpgrade": { + "post": { + "summary": "Updates an ongoing application upgrade in the Service Fabric cluster.", + "description": "Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.", + "operationId": "UpdateApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationUpgradeUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has updated with the specified parameters. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/MoveToNextUpgradeDomain": { + "post": { + "summary": "Resumes upgrading an application in the Service Fabric cluster.", + "description": "Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.", + "operationId": "ResumeApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ResumeApplicationUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application upgrade has been resumed in the specified upgrade domain. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/RollbackUpgrade": { + "post": { + "summary": "Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.", + "description": "Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.", + "operationId": "RollbackApplicationUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful response means that the application has started to roll back. Use GetApplicationUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications": { + "get": { + "operationId": "GetDeployedApplicationInfoList", + "summary": "Gets the list of applications deployed on a Service Fabric node.", + "description": "Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetDeployedApplicationInfoList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetDeployedApplicationInfoList-2.json" + }, + "Include health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoList-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed application information.", + "schema": { + "$ref": "#/definitions/PagedDeployedApplicationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}": { + "get": { + "operationId": "GetDeployedApplicationInfo", + "summary": "Gets the information about an application deployed on a Service Fabric node.", + "description": "This query returns system application information if the application ID provided is for system application. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-1_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/IncludeHealthStateOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get a specific deployed application by application ID and include the health state in the result": { + "$ref": "./examples/GetDeployedApplicationInfoByName-1.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the information about the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetHealth": { + "get": { + "operationId": "GetDeployedApplicationHealth", + "summary": "Gets the information about health of an application deployed on a Service Fabric node.", + "description": "Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedApplicationHealthUsingPolicy", + "summary": "Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.", + "description": "Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/DeployedServicePackagesHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Application" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed application.", + "schema": { + "$ref": "#/definitions/DeployedApplicationHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedApplicationHealth", + "summary": "Sends a health report on the Service Fabric application deployed on a Service Fabric node.", + "description": "Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section.", + "tags": [ + "Application" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ApplicationTypes/{applicationTypeName}/$/GetApplicationManifest": { + "get": { + "summary": "Gets the manifest describing an application type.", + "description": "The response contains the application manifest XML as a string.", + "operationId": "GetApplicationManifest", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationTypeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationTypeVersionRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ApplicationType" + ], + "responses": { + "200": { + "description": "Information about the node.", + "schema": { + "$ref": "#/definitions/ApplicationTypeManifest" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices": { + "get": { + "summary": "Gets the information about all services belonging to the application specified by the application ID.", + "description": "Returns the information about all services belonging to the application specified by the application ID.", + "operationId": "GetServiceInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceTypeNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "List of services in the cluster for the specified application.", + "schema": { + "$ref": "#/definitions/PagedServiceInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/{serviceId}": { + "get": { + "summary": "Gets the information about the specific service belonging to the Service Fabric application.", + "description": "Returns the information about the specified service belonging to the specified Service Fabric application.", + "operationId": "GetServiceInfo", + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the specified service.", + "schema": { + "$ref": "#/definitions/ServiceInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified service is not part of the specified application." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetApplicationName": { + "get": { + "summary": "Gets the name of the Service Fabric application for a service.", + "description": "Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.", + "operationId": "GetApplicationNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "Information about the name of the application for the specified service.", + "schema": { + "$ref": "#/definitions/ApplicationNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/Create": { + "post": { + "operationId": "CreateService", + "summary": "Creates the specified Service Fabric service.", + "description": "This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.", + "x-ms-examples": { + "Basic stateless service": { + "$ref": "./examples/CreateService-1.json" + }, + "Basic stateful service": { + "$ref": "./examples/CreateService-2.json" + }, + "Stateless service with dns name and auto scaling": { + "$ref": "./examples/CreateService-3.json" + }, + "Stateful service with named partitions and auto scaling": { + "$ref": "./examples/CreateService-4.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetServices/$/CreateFromTemplate": { + "post": { + "summary": "Creates a Service Fabric service from the service template.", + "description": "Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.", + "operationId": "CreateServiceFromTemplate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/CreateServiceFromTemplateRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric service.", + "description": "A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.", + "operationId": "DeleteService", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/Update": { + "post": { + "operationId": "UpdateService", + "summary": "Updates a Service Fabric service using the specified update description.", + "description": "This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.", + "x-ms-examples": { + "Stateless service": { + "$ref": "./examples/UpdateService-1.json" + }, + "Stateful service": { + "$ref": "./examples/UpdateService-2.json" + } + }, + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceUpdateDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetDescription": { + "get": { + "summary": "Gets the description of an existing Service Fabric service.", + "description": "Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.", + "operationId": "GetServiceDescription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric service.", + "description": "Gets the health information of the specified service.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric service, by using the specified health policy.", + "description": "Gets the health information of the specified service.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse PartitionsHealthStateFilter to filter the collection of partitions returned.\nIf you specify a service that does not exist in the health store, this request returns an error.", + "operationId": "GetServiceHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the specified service.", + "schema": { + "$ref": "#/definitions/ServiceHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ReportHealth": { + "post": { + "operationId": "ReportServiceHealth", + "summary": "Sends a health report on the Service Fabric service.", + "description": "Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResolvePartition": { + "get": { + "operationId": "ResolveService", + "summary": "Resolve a Service Fabric partition.", + "description": "Resolve a Service Fabric service partition to get the endpoints of the service replicas.", + "tags": [ + "Service" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionKeyTypeOptionalQueryParam" + }, + { + "$ref": "#/parameters/PartitionKeyValueOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousRspVersionOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/ResolvedServicePartition" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetPartitions": { + "get": { + "summary": "Gets the list of partitions of a Service Fabric service.", + "description": "The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "List of partitions of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/PagedServicePartitionInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}": { + "get": { + "summary": "Gets the information about a Service Fabric partition.", + "description": "Gets the information about the specified partition. The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.", + "operationId": "GetPartitionInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition.", + "schema": { + "$ref": "#/definitions/ServicePartitionInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified partitionId is not found in the cluster." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetServiceName": { + "get": { + "summary": "Gets the name of the Service Fabric service for a partition.", + "description": "Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.", + "operationId": "GetServiceNameInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the name of the service for the specified partition.", + "schema": { + "$ref": "#/definitions/ServiceNameInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetHealth": { + "get": { + "summary": "Gets the health of the specified Service Fabric partition.", + "description": "Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealth", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "summary": "Gets the health of the specified Service Fabric partition, by using the specified health policy.", + "description": "Gets the health information of the specified partition.\nIf the application health policy is specified, the health evaluation uses it to get the aggregated health state.\nIf the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest.\nUse EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state.\nUse ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health.\nIf you specify a partition that does not exist in the health store, this request returns an error.", + "operationId": "GetPartitionHealthUsingPolicy", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ReplicasHealthStateFilerOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/ExcludeHealthStatisticsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information about the specified partition.", + "schema": { + "$ref": "#/definitions/PartitionHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ReportHealth": { + "post": { + "operationId": "ReportPartitionHealth", + "summary": "Sends a health report on the Service Fabric partition.", + "description": "Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Partition, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetLoadInformation": { + "get": { + "summary": "Gets the load information of the specified Service Fabric partition.", + "description": "Returns information about the load of a specified partition.\nThe response includes a list of load reports for a Service Fabric partition.\nEach report includes the load metric name, value, and last reported time in UTC.", + "operationId": "GetPartitionLoadInformation", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Partition" + ], + "responses": { + "200": { + "description": "Information about the specified partition's last reported load metrics.", + "schema": { + "$ref": "#/definitions/PartitionLoadInformation" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResetLoad": { + "post": { + "operationId": "ResetPartitionLoad", + "summary": "Resets the current load of a Service Fabric partition.", + "description": "Resets the current load of a Service Fabric partition to the default load for the service.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Recover": { + "post": { + "operationId": "RecoverPartition", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.", + "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/$/{serviceId}/$/GetPartitions/$/Recover": { + "post": { + "operationId": "RecoverServicePartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverSystemPartitions": { + "post": { + "operationId": "RecoverSystemPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.", + "description": "Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/RecoverAllPartitions": { + "post": { + "operationId": "RecoverAllPartitions", + "summary": "Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.", + "description": "This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.", + "tags": [ + "Partition" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation request will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CreateRepairTask": { + "post": { + "operationId": "CreateRepairTask", + "summary": "Creates a new repair task.", + "description": "For clusters that have the Repair Manager Service configured,\nthis API provides a way to create repair tasks that run automatically or manually.\nFor repair tasks that run automatically, an appropriate repair executor\nmust be running for each repair action to run automatically.\nThese are currently only available in specially-configured Azure Cloud Services.\n\nTo create a manual repair task, provide the set of impacted node names and the\nexpected impact. When the state of the created repair task changes to approved,\nyou can safely perform repair actions on those nodes.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the created repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/CancelRepairTask": { + "post": { + "operationId": "CancelRepairTask", + "summary": "Requests the cancellation of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskCancelDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.\nSuccess indicates that the cancellation request was recorded, but does not guarantee that the repair task will be cancelled.\nClients may use the State property of the repair task to determine the current state of the repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/DeleteRepairTask": { + "post": { + "operationId": "DeleteRepairTask", + "summary": "Deletes a completed repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskDeleteDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/GetRepairTaskList": { + "get": { + "operationId": "GetRepairTaskList", + "summary": "Gets a list of repair tasks matching the given filters.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskIdFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskExecutorFilterOptionalQueryParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides a list of repair tasks matching all of the given filters.", + "schema": { + "$ref": "#/definitions/RepairTaskList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/ForceApproveRepairTask": { + "post": { + "operationId": "ForceApproveRepairTask", + "summary": "Forces the approval of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskApproveDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairTaskHealthPolicy": { + "post": { + "operationId": "UpdateRepairTaskHealthPolicy", + "summary": "Updates the health policy of the given repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/UpdateRepairExecutionState": { + "post": { + "operationId": "UpdateRepairExecutionState", + "summary": "Updates the execution state of a repair task.", + "description": "This API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/RepairTaskRequiredBodyParam" + } + ], + "tags": [ + "RepairManagement" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.\nThe response body provides information about the updated repair task.", + "schema": { + "$ref": "#/definitions/RepairTaskUpdateInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas": { + "get": { + "summary": "Gets the information about replicas of a Service Fabric service partition.", + "description": "The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the replicas of the specified partition.", + "schema": { + "$ref": "#/definitions/PagedReplicaInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}": { + "get": { + "summary": "Gets the information about a replica of a Service Fabric partition.", + "description": "The response includes the ID, role, status, health, node name, uptime, and other details about the replica.", + "operationId": "GetReplicaInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "Information about the specified replicas of the specified partition of a Service Fabric service.", + "schema": { + "$ref": "#/definitions/ReplicaInfo" + } + }, + "204": { + "description": "An empty response is returned if the specified replicaId is not a replica of the specified partition." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetHealth": { + "get": { + "operationId": "GetReplicaHealth", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance.", + "description": "Gets the health of a Service Fabric replica.\nUse EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetReplicaHealthUsingPolicy", + "summary": "Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.", + "description": "Gets the health of a Service Fabric stateful service replica or stateless service instance.\nUse EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state.\nUse ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Replica" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested replica health information.", + "schema": { + "$ref": "#/definitions/ReplicaHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetReplicas/{replicaId}/$/ReportHealth": { + "post": { + "operationId": "ReportReplicaHealth", + "summary": "Sends a health report on the Service Fabric replica.", + "description": "Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Replica, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaHealthReportServiceKindRequiredQueryParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaInfoList", + "summary": "Gets the list of replicas deployed on a Service Fabric node.", + "description": "Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified applicationId is not found on the specified node. An empty response is also returned if there are no replicas matching the specified filter values for PartitionId or ServiceManifestName query parameters." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/GetDetail": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfo", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas": { + "get": { + "operationId": "GetDeployedServiceReplicaDetailInfoByPartitionId", + "summary": "Gets the details of replica deployed on a Service Fabric node.", + "description": "Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service replica information.", + "schema": { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Restart": { + "post": { + "operationId": "RestartReplica", + "summary": "Restarts a service replica of a persisted service running on a node.", + "description": "Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetPartitions/{partitionId}/$/GetReplicas/{replicaId}/$/Delete": { + "post": { + "operationId": "RemoveReplica", + "summary": "Removes a service replica running on a node.", + "description": "This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.", + "tags": [ + "Replica" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ForceRemoveReplicaOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code. A successful operation means that the restart command was received by the replica on the node and it is in the process of restarting." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages": { + "get": { + "operationId": "GetDeployedServicePackageInfoList", + "summary": "Gets the list of service packages deployed on a Service Fabric node.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}": { + "get": { + "operationId": "GetDeployedServicePackageInfoListByName", + "summary": "Gets the list of service packages deployed on a Service Fabric node matching exactly the specified name.", + "description": "Returns the information about the service packages deployed on a Service Fabric node for the given application. These results are of service packages whose name match exactly the service package name specified as the parameter.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed service packages information.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageInfoList" + } + }, + "204": { + "description": "An empty response is returned if the specified service package from the application is not deployed on the node." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/GetHealth": { + "get": { + "operationId": "GetDeployedServicePackageHealth", + "summary": "Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.", + "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "GetDeployedServicePackageHealthUsingPolicy", + "summary": "Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.", + "description": "Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/EventsHealthStateFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApplicationHealthPolicyOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Service Package" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the health information of the deployed service package for a specific node and application.", + "schema": { + "$ref": "#/definitions/DeployedServicePackageHealth" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetServicePackages/{servicePackageName}/$/ReportHealth": { + "post": { + "operationId": "ReportDeployedServicePackageHealth", + "summary": "Sends a health report on the Service Fabric deployed service package.", + "description": "Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported.\nThe report is sent to a Service Fabric gateway Service, which forwards to the health store.\nThe report may be accepted by the gateway, but rejected by the health store after extra validation.\nFor example, the health store may reject the report because of an invalid parameter, like a stale sequence number.\nTo see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServicePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/HealthInformationRequiredBodyParam" + }, + { + "$ref": "#/parameters/ImmediateOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/DeployServicePackage": { + "post": { + "operationId": "DeployServicePackageToNode", + "summary": "Downloads all of the code packages associated with specified service manifest on the specified node.", + "description": "This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade.", + "tags": [ + "Service Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/DeployServicePackageToNodeRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages": { + "get": { + "operationId": "GetDeployedCodePackageInfoList", + "summary": "Gets the list of code packages deployed on a Service Fabric node.", + "description": "Gets the list of code packages deployed on a Service Fabric node for the given application.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the list of deployed code packages information.", + "schema": { + "$ref": "#/definitions/DeployedCodePackageInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/Restart": { + "post": { + "operationId": "RestartDeployedCodePackage", + "summary": "Restarts a code package deployed on a Service Fabric node in a cluster.", + "description": "Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestartDeployedCodePackageRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerLogs": { + "get": { + "operationId": "GetContainerLogsDeployedOnNode", + "summary": "Gets the container logs for container deployed on a Service Fabric node.", + "description": "Gets the container logs for container deployed on a Service Fabric node for the given code package.", + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + }, + { + "$ref": "#/parameters/PreviousOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get container logs for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-1.json" + }, + "Get last 10 lines of container logs": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-2.json" + }, + "Get container logs of previous dead container for given code package": { + "$ref": "./examples/GetContainerLogsDeployedOnNode-3.json" + } + }, + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the container logs for container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Nodes/{nodeName}/$/GetApplications/{applicationId}/$/GetCodePackages/$/ContainerApi": { + "post": { + "operationId": "InvokeContainerApi", + "summary": "Invoke container API on a container deployed on a Service Fabric node.", + "description": "Invoke container API on a container deployed on a Service Fabric node for the given code package.", + "x-ms-examples": { + "Get container logs": { + "$ref": "./examples/InvokeContainerApi.json" + }, + "Update container": { + "$ref": "./examples/InvokeContainerApi_Post.json" + } + }, + "tags": [ + "Code Package" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceManifestNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/CodePackageInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContainerApiRequiredBodyParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and container API response for a container deployed on a Service Fabric node for the given code package.", + "schema": { + "$ref": "#/definitions/ContainerApiResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/$/Create": { + "put": { + "summary": "Creates a Service Fabric compose deployment.", + "description": "Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.", + "operationId": "CreateComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/CreateComposeDeploymentRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}": { + "get": { + "summary": "Gets information about a Service Fabric compose deployment.", + "description": "Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.", + "operationId": "GetComposeDeploymentStatus", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Information about the compose deployment.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments": { + "get": { + "summary": "Gets the list of compose deployments created in the Service Fabric cluster.", + "description": "Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.", + "operationId": "GetComposeDeploymentStatusList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "List of status of compose deployments in the cluster.", + "schema": { + "$ref": "#/definitions/PagedComposeDeploymentStatusInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/GetUpgradeProgress": { + "get": { + "summary": "Gets details for the latest upgrade performed on this Service Fabric compose deployment.", + "description": "Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.", + "operationId": "GetComposeDeploymentUpgradeProgress", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "Details about the compose deployment upgrade.", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Delete": { + "post": { + "summary": "Deletes an existing Service Fabric compose deployment from cluster.", + "description": "Deletes an existing Service Fabric compose deployment.", + "operationId": "RemoveComposeDeployment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful operation will return 202 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/Upgrade": { + "post": { + "summary": "Starts upgrading a compose deployment in the Service Fabric cluster.", + "description": "Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.", + "operationId": "StartComposeDeploymentUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ComposeDeploymentUpgradeDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "202": { + "description": "A successful response means that the upgrade has started. Use GetComposeDeploymentUpgrade operation to get the status of the upgrade." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ComposeDeployments/{deploymentName}/$/RollbackUpgrade": { + "post": { + "summary": "Starts rolling back a compose deployment upgrade in the Service Fabric cluster.", + "description": "Rollback a service fabric compose deployment upgrade.", + "operationId": "StartRollbackComposeDeploymentUpgrade", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DeploymentNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Compose Deployment" + ], + "responses": { + "200": { + "description": "A successful response means that the rollback has started. Use GetComposeDeploymentUpgrade operation to get the status of the rollback." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos": { + "get": { + "operationId": "GetChaos", + "summary": "Get the status of Chaos.", + "description": "Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the status of Chaos.", + "schema": { + "$ref": "#/definitions/Chaos" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Start": { + "post": { + "operationId": "StartChaos", + "summary": "Starts Chaos in the cluster.", + "description": "If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters.\nIf Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING.\nRefer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ChaosParametersRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/$/Stop": { + "post": { + "operationId": "StopChaos", + "summary": "Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.", + "description": "Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state.\nOnce a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling.", + "tags": [ + "Chaos" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Events": { + "get": { + "operationId": "GetChaosEvents", + "summary": "Gets the next segment of the Chaos events based on the continuation token or the time range.", + "description": "To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range\nthrough StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call.\nWhen there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token.", + "x-ms-examples": { + "Get Chaos events given a time range": { + "$ref": "./examples/GetChaosEvents.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "Next segment of Chaos events.", + "schema": { + "$ref": "#/definitions/ChaosEventsSegment" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Tools/Chaos/Schedule": { + "get": { + "operationId": "GetChaosSchedule", + "summary": "Get the Chaos Schedule defining when and how to run Chaos.", + "description": "Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the schedule description including a Chaos Schedule used by Chaos and the version the Chaos Schedule is on.", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "post": { + "operationId": "PostChaosSchedule", + "summary": "Set the schedule used by Chaos.", + "description": "Chaos will automatically schedule runs based on the Chaos Schedule.\nThe Chaos Schedule will be updated if the provided version matches the version on the server.\nWhen updating the Chaos Schedule, the version on the server is incremented by 1.\nThe version on the server will wrap back to 0 after reaching a large number.\nIf Chaos is running when this call is made, the call will fail.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ChaosScheduleRequiredBodyParam" + } + ], + "tags": [ + "Chaos" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}": { + "put": { + "summary": "Uploads contents of the file to the image store.", + "description": "Uploads contents of the file to the image store. Use this API if the file is small enough to upload again if the connection fails. The file's data needs to be added to the request body. The contents will be uploaded to the specified path. Image store service uses a mark file to indicate the availability of the folder. The mark file is an empty file named \"_.dir\". The mark file is generated by the image store service when all files in a folder are uploaded. When using File-by-File approach to upload application package in REST, the image store service isn't aware of the file hierarchy of the application package; you need to create a mark file per folder and upload it last, to let the image store service know that the folder is complete.", + "operationId": "UploadFile", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the upload request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the image store content information.", + "description": "Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.", + "operationId": "GetImageStoreContent", + "x-ms-examples": { + "Get information about image store content under a given relative path": { + "$ref": "./examples/GetImageStoreContent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes existing image store content.", + "description": "Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages once they are provisioned.", + "operationId": "DeleteImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore": { + "get": { + "summary": "Gets the content information at the root of the image store.", + "description": "Returns the information about the image store content at the root of the image store.", + "operationId": "GetImageStoreRootContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store content information.", + "schema": { + "$ref": "#/definitions/ImageStoreContent" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/Copy": { + "post": { + "summary": "Copies image store content internally", + "description": "Copies the image store content from the source image store relative path to the destination image store relative path.", + "operationId": "CopyImageStoreContent", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreCopyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/DeleteUploadSession": { + "delete": { + "summary": "Cancels an image store upload session.", + "description": "The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks.", + "operationId": "DeleteImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/CommitUploadSession": { + "post": { + "summary": "Commit an image store upload session.", + "description": "When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. ", + "operationId": "CommitImageStoreUploadSession", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "If the commit request succeeds, the server returns the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by ID.", + "description": "Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionById", + "x-ms-examples": { + "Get information about image store upload session by a given ID": { + "$ref": "./examples/GetUploadSessionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/GetUploadSession": { + "get": { + "summary": "Get the image store upload session by relative path.", + "description": "Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. ", + "operationId": "GetImageStoreUploadSessionByPath", + "x-ms-examples": { + "Get information about image store upload session by a given relative path": { + "$ref": "./examples/GetUploadSessionByPath.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the requested image store upload session information.", + "schema": { + "$ref": "#/definitions/UploadSession" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/ImageStore/{contentPath}/$/UploadChunk": { + "put": { + "summary": "Uploads a file chunk to the image store relative path.", + "description": "Uploads a file chunk to the image store with the specified upload session ID and image store relative path. This API allows user to resume the file upload operation. user doesn't have to restart the file upload from scratch whenever there is a network interruption. Use this option if the file size is large.\n\nTo perform a resumable file upload, user need to break the file into multiple chunks and upload these chunks to the image store one-by-one. Chunks don't have to be uploaded in order. If the file represented by the image store relative path already exists, it will be overwritten when the upload session commits.", + "operationId": "UploadFileChunk", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ImageStoreContentPathRequiredPathParam" + }, + { + "$ref": "#/parameters/UploadSessionIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/UploadFileChunkContentRangeHeaderParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "ImageStore" + ], + "responses": { + "200": { + "description": "A successful operation will return the HTTP 200 OK status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureCommand": { + "post": { + "operationId": "InvokeInfrastructureCommand", + "summary": "Invokes an administrative command on the given Infrastructure Service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific commands to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/$/InvokeInfrastructureQuery": { + "get": { + "operationId": "InvokeInfrastructureQuery", + "summary": "Invokes a read-only query on the given infrastructure service instance.", + "description": "For clusters that have one or more instances of the Infrastructure Service configured,\nthis API provides a way to send infrastructure-specific queries to a particular\ninstance of the Infrastructure Service.\n\nAvailable commands and their corresponding response formats vary depending upon\nthe infrastructure on which the cluster is running.\n\nThis API supports the Service Fabric platform; it is not meant to be used directly from your code.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureCommandRequiredQueryParam" + }, + { + "$ref": "#/parameters/InfrastructureServiceIdOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Infrastructure" + ], + "responses": { + "200": { + "description": "The response from the infrastructure service. The response format is a JSON stream.\nThe contents of the response depend on which command was issued.", + "schema": { + "$ref": "#/definitions/InfrastructureServiceResponse" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartDataLoss": { + "post": { + "operationId": "StartDataLoss", + "summary": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.", + "description": "This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition.\nActual data loss will depend on the specified DataLossMode.\n\n- PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication.\n- FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered.\n\nThis API should only be called with a stateful service as the target.\n\nCalling this API with a system service as the target is not advised.\n\nNote: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state.\nIt will not restore data if the command has progressed far enough to cause data loss.\n\nCall the GetDataLossProgress API with the same OperationId to return information on the operation started with this API.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/DataLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetDataLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetDataLossProgress": { + "get": { + "summary": "Gets the progress of a partition data loss operation started using the StartDataLoss API.", + "description": "Gets the progress of a data loss operation started with StartDataLoss, using the OperationId.", + "operationId": "GetDataLossProgress", + "x-ms-examples": { + "Gets information about a partition data loss operation. In this case the operation has a State of Completed": { + "$ref": "./examples/GetDataLossProgress.json" + }, + "Get information about a partition data loss operation. In this case the operation is a State of Running": { + "$ref": "./examples/GetDataLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of the partition data loss operation.", + "schema": { + "$ref": "#/definitions/PartitionDataLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartQuorumLoss": { + "post": { + "operationId": "StartQuorumLoss", + "summary": "Induces quorum loss for a given stateful service partition.", + "description": "This API is useful for a temporary quorum loss situation on your service.\n\nCall the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API.\n\nThis can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/QuorumLossDurationRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetQuorumLossProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetQuorumLossProgress": { + "get": { + "summary": "Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.", + "description": "Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId.", + "operationId": "GetQuorumLossProgress", + "x-ms-examples": { + "Gets information about a completed quorum loss operation": { + "$ref": "./examples/GetQuorumLossProgress.json" + }, + "Gets information about a running quorum operation operation": { + "$ref": "./examples/GetQuorumLossProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition quorum loss operation.", + "schema": { + "$ref": "#/definitions/PartitionQuorumLossProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/StartRestart": { + "post": { + "operationId": "StartPartitionRestart", + "summary": "This API will restart some or all replicas or instances of the specified partition.", + "description": "This API is useful for testing failover.\n\nIf used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances.\n\nCall the GetPartitionRestartProgress API using the same OperationId to get the progress.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/RestartPartitionModeRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetPartitionRestartProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Services/{serviceId}/$/GetPartitions/{partitionId}/$/GetRestartProgress": { + "get": { + "summary": "Gets the progress of a PartitionRestart operation started using StartPartitionRestart.", + "description": "Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId.", + "operationId": "GetPartitionRestartProgress", + "x-ms-examples": { + "Get information a completed PartitionRestart operation": { + "$ref": "./examples/GetPartitionRestartProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a partition restart operation.", + "schema": { + "$ref": "#/definitions/PartitionRestartProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/StartTransition/": { + "post": { + "operationId": "StartNodeTransition", + "summary": "Starts or stops a cluster node.", + "description": "Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in \"Start\" for the NodeTransitionType parameter.\nTo stop a node, pass in \"Stop\" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet.\nCall GetNodeTransitionProgress with the same OperationId to get the progress of the operation.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeTransitionTypeRequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeInstanceIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/StopDurationInSecondsRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation was accepted. Call the GetNodeTransitionProgress API to get the progress." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/Nodes/{nodeName}/$/GetTransitionProgress": { + "get": { + "summary": "Gets the progress of an operation started using StartNodeTransition.", + "description": "Gets the progress of an operation started with StartNodeTransition using the provided OperationId.", + "operationId": "GetNodeTransitionProgress", + "x-ms-examples": { + "Gets information about a completed NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress.json" + }, + "Gets information about a running NodeTransition operation": { + "$ref": "./examples/GetNodeTransitionProgress-Running.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Faults" + ], + "responses": { + "200": { + "description": "Information about the progress of a node transition operation.", + "schema": { + "$ref": "#/definitions/NodeTransitionProgress" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/": { + "get": { + "operationId": "GetFaultOperationList", + "summary": "Gets a list of user-induced fault operations filtered by provided input.", + "description": "Gets the list of user-induced fault operations filtered by provided input.", + "x-ms-examples": { + "Gets information on fault operations": { + "$ref": "./examples/GetFaultOperationList.json" + } + }, + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TypeFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/StateFilterRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code.", + "schema": { + "$ref": "#/definitions/OperationStatusList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Faults/$/Cancel": { + "post": { + "operationId": "CancelOperation", + "summary": "Cancels a user-induced fault operation.", + "description": "The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition.\n\nIf force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state\nmay be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already\nbeen called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack.\nClarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the\ntest command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command.\nIt will not restore the target partition's data, if the command progressed far enough to cause data loss.\n\nImportant note: if this API is invoked with force==true, internal state may be left behind.", + "tags": [ + "Faults" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/FaultOperationIdRequiredQueryParam" + }, + { + "$ref": "#/parameters/ForceRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/$/Create": { + "post": { + "operationId": "CreateBackupPolicy", + "summary": "Creates a backup policy.", + "description": "Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup.", + "x-ms-examples": { + "Create a time based backup policy with Azure as backup location": { + "$ref": "./examples/CreateBackupPolicy-1.json" + }, + "Create a frequency based backup policy with file share as backup location": { + "$ref": "./examples/CreateBackupPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "201": { + "description": "A successful operation returns 201 status code and creates a new backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Delete": { + "post": { + "operationId": "DeleteBackupPolicy", + "summary": "Deletes the backup policy.", + "description": "Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping.", + "x-ms-examples": { + "Delete backup policy": { + "$ref": "./examples/DeleteBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and deletes the backup policy." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies": { + "get": { + "operationId": "GetBackupPolicyList", + "summary": "Gets all the backup policies configured.", + "description": "Get a list of all the backup policies configured.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupPolicyList-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupPolicyList-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and paged list of backup policies.", + "schema": { + "$ref": "#/definitions/PagedBackupPolicyDescriptionList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}": { + "get": { + "operationId": "GetBackupPolicyByName", + "summary": "Gets a particular backup policy by name.", + "description": "Gets a particular backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Get backup policy by name": { + "$ref": "./examples/GetBackupPolicyByName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and the backup policy description.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/GetBackupEnabledEntities": { + "get": { + "operationId": "GetAllEntitiesBackedUpByPolicy", + "summary": "Gets the list of backup entities that are associated with this policy.", + "description": "Returns a list of Service Fabric application, service or partition which are associated with this backup policy.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetAllEntitiesBackedUpByPolicy-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of Service Fabric entities that are associated with this policy.", + "schema": { + "$ref": "#/definitions/PagedBackupEntityList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/BackupPolicies/{backupPolicyName}/$/Update": { + "post": { + "operationId": "UpdateBackupPolicy", + "summary": "Updates the backup policy.", + "description": "Updates the backup policy identified by {backupPolicyName}", + "x-ms-examples": { + "Update backup policy": { + "$ref": "./examples/UpdateBackupPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/BackupPolicyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/BackupPolicyNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and updates the backup policy description." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/EnableBackup": { + "post": { + "operationId": "EnableApplicationBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric application.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. \nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable application backup": { + "$ref": "./examples/EnableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/DisableBackup": { + "post": { + "operationId": "DisableApplicationBackup", + "summary": "Disables periodic backup of Service Fabric application.", + "description": "Disables periodic backup of Service Fabric application which was previously enabled.", + "x-ms-examples": { + "Disable application backup": { + "$ref": "./examples/DisableApplicationBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable application backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetApplicationBackupConfigurationInfo", + "summary": "Gets the Service Fabric application backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the application and the services and partitions under this application.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the application, and the services and partitions under this application, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/GetBackups": { + "get": { + "operationId": "GetApplicationBackupList", + "summary": "Gets the list of backups available for every partition in this application.", + "description": "Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetApplicationBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetApplicationBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetApplicationBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetApplicationBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendApplicationBackup", + "summary": "Suspends periodic backup for the specified Service Fabric application.", + "description": "The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.", + "x-ms-examples": { + "Suspend application backup": { + "$ref": "./examples/SuspendApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Applications/{applicationId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeApplicationBackup", + "summary": "Resumes periodic backup of a Service Fabric application which was previously suspended.", + "description": "The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume application backup": { + "$ref": "./examples/ResumeApplicationBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and application backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/EnableBackup": { + "post": { + "operationId": "EnableServiceBackup", + "summary": "Enables periodic backup of stateful partitions under this Service Fabric service.", + "description": "Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level).\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable service backup": { + "$ref": "./examples/EnableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/DisableBackup": { + "post": { + "operationId": "DisableServiceBackup", + "summary": "Disables periodic backup of Service Fabric service which was previously enabled.", + "description": "Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled.\nIn case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level.", + "x-ms-examples": { + "Disable service backup": { + "$ref": "./examples/DisableServiceBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable service backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetServiceBackupConfigurationInfo", + "summary": "Gets the Service Fabric service backup configuration information.", + "description": "Gets the Service Fabric backup configuration information for the service and the partitions under this service.", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupConfigurationInfo-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup configuration information for the service, and the partitions under this service, for which backup configuration has been overridden.", + "schema": { + "$ref": "#/definitions/PagedBackupConfigurationInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/GetBackups": { + "get": { + "operationId": "GetServiceBackupList", + "summary": "Gets the list of backups available for every partition in this service.", + "description": "Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetServiceBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetServiceBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetServiceBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetServiceBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendServiceBackup", + "summary": "Suspends periodic backup for the specified Service Fabric service.", + "description": "The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.", + "x-ms-examples": { + "Suspend service backup": { + "$ref": "./examples/SuspendServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Services/{serviceId}/$/ResumeBackup": { + "post": { + "operationId": "ResumeServiceBackup", + "summary": "Resumes periodic backup of a Service Fabric service which was previously suspended.", + "description": "The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume service backup": { + "$ref": "./examples/ResumeServiceBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and service backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/EnableBackup": { + "post": { + "operationId": "EnablePartitionBackup", + "summary": "Enables periodic backup of the stateful persisted partition.", + "description": "Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition.\nNote only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup.", + "x-ms-examples": { + "Enable partition backup": { + "$ref": "./examples/EnablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/EnableBackupDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to enable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/DisableBackup": { + "post": { + "operationId": "DisablePartitionBackup", + "summary": "Disables periodic backup of Service Fabric partition which was previously enabled.", + "description": "Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. \nIn case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity.", + "x-ms-examples": { + "Disable partition backup": { + "$ref": "./examples/DisablePartitionBackup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/DisableBackupDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the request to disable partition backup has been accepted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupConfigurationInfo": { + "get": { + "operationId": "GetPartitionBackupConfigurationInfo", + "summary": "Gets the partition backup configuration information", + "description": "Gets the Service Fabric Backup configuration information for the specified partition.", + "x-ms-examples": { + "Get partition backup configuration information": { + "$ref": "./examples/GetPartitionBackupConfigurationInfo.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and gets the partition's backup configuration information.", + "schema": { + "$ref": "#/definitions/PartitionBackupConfigurationInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackups": { + "get": { + "operationId": "GetPartitionBackupList", + "summary": "Gets the list of backups available for the specified partition.", + "description": "Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition.", + "x-ms-examples": { + "Get application backups within a time range": { + "$ref": "./examples/GetPartitionBackupList-1.json" + }, + "Get latest backup": { + "$ref": "./examples/GetPartitionBackupList-2.json" + }, + "Limit maximum results": { + "$ref": "./examples/GetPartitionBackupList-3.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetPartitionBackupList-4.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/LatestOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartDateTimeFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/EndDateTimeFilterOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/SuspendBackup": { + "post": { + "operationId": "SuspendPartitionBackup", + "summary": "Suspends periodic backup for the specified partition.", + "description": "The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.", + "x-ms-examples": { + "Suspend partition backup": { + "$ref": "./examples/SuspendPartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be suspended." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/ResumeBackup": { + "post": { + "operationId": "ResumePartitionBackup", + "summary": "Resumes periodic backup of partition which was previously suspended.", + "description": "The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.", + "x-ms-examples": { + "Resume partition backup": { + "$ref": "./examples/ResumePartitionBackup.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and partition backup will be resumed." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Backup": { + "post": { + "operationId": "BackupPartition", + "summary": "Triggers backup of the partition's state.", + "description": "Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. \nIn case, the operation times out, specify a greater backup timeout value in the query parameter.", + "x-ms-examples": { + "Backup partition": { + "$ref": "./examples/BackupPartition-1.json" + }, + "Backup partition to a specific Azure storage account": { + "$ref": "./examples/BackupPartition-2.json" + }, + "Backup partition to a specific on-premise file share": { + "$ref": "./examples/BackupPartition-3.json" + } + }, + "tags": [ + "BackupRestore" + ], + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/BackupPartitionDescriptionOptionalBodyParam" + }, + { + "$ref": "#/parameters/BackupTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and backup will be initiated. Use GetPartitionBackupProgress operation to get the status of the backup operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetBackupProgress": { + "get": { + "operationId": "GetPartitionBackupProgress", + "summary": "Gets details for the latest backup triggered for this partition.", + "description": "Returns information about the state of the latest backup along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get backup operation progress": { + "$ref": "./examples/GetPartitionBackupProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and backup progress details.", + "schema": { + "$ref": "#/definitions/BackupProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/Restore": { + "post": { + "operationId": "RestorePartition", + "summary": "Triggers restore of the state of the partition using the specified restore partition description.", + "description": "Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. \nIn case, the operation times out, specify a greater restore timeout value in the query parameter.", + "x-ms-examples": { + "Trigger partition restore": { + "$ref": "./examples/RestorePartition.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RestorePartitionDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/RestoreTimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "202": { + "description": "A 202 status code indicates the operation request was accepted and restore will be initiated. Use GetPartitionRestoreProgress operation to get the status of the restore operation." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Partitions/{partitionId}/$/GetRestoreProgress": { + "get": { + "operationId": "GetPartitionRestoreProgress", + "summary": "Gets details for the latest restore operation triggered for this partition.", + "description": "Returns information about the state of the latest restore operation along with details or failure reason in case of completion.", + "x-ms-examples": { + "Get restore operation progress": { + "$ref": "./examples/GetPartitionRestoreProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation returns 200 status code and restore progress details.", + "schema": { + "$ref": "#/definitions/RestoreProgressInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/BackupRestore/$/GetBackups": { + "post": { + "operationId": "GetBackupsFromBackupLocation", + "summary": "Gets the list of backups available for the specified backed up entity at the specified backup location.", + "description": "Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).", + "x-ms-examples": { + "Limit maximum results": { + "$ref": "./examples/GetBackupsFromBackupLocation-1.json" + }, + "Page using continuation token": { + "$ref": "./examples/GetBackupsFromBackupLocation-2.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/MaxResultsOptionalQueryParam" + }, + { + "$ref": "#/parameters/GetBackupByStorageQueryDescriptionRequiredBodyParam" + } + ], + "tags": [ + "BackupRestore" + ], + "responses": { + "200": { + "description": "A successful operation will return 200 status code and a paged list of backup information.", + "schema": { + "$ref": "#/definitions/PagedBackupInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/$/Create": { + "post": { + "summary": "Creates a Service Fabric name.", + "description": "Creates the specified Service Fabric name.", + "operationId": "CreateName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Create new name": { + "$ref": "examples/CreateName-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "201": { + "description": "A successful response means that the name has been created." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}": { + "get": { + "summary": "Returns whether the Service Fabric name exists.", + "description": "Returns whether the specified Service Fabric name exists.", + "operationId": "GetNameExistsInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name exists." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes a Service Fabric name.", + "description": "Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.", + "operationId": "DeleteName", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the Service Fabric name has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetSubNames": { + "get": { + "summary": "Enumerates all the Service Fabric names under a given name.", + "description": "Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.", + "operationId": "GetSubNameInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/RecursiveOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get sub names": { + "$ref": "examples/GetSubNameInfoList-1.json" + }, + "Recursively search sub names": { + "$ref": "examples/GetSubNameInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetSubNameInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric names.", + "schema": { + "$ref": "#/definitions/PagedSubNameInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties": { + "get": { + "summary": "Gets information on all Service Fabric properties under a given name.", + "description": "A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.", + "operationId": "GetPropertyInfoList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/IncludeValuesOptionalQueryParam" + }, + { + "$ref": "#/parameters/ContinuationTokenOptionalQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info list": { + "$ref": "examples/GetPropertyInfoList-1.json" + }, + "Get property info list with values": { + "$ref": "examples/GetPropertyInfoList-2.json" + }, + "Page using continuation token": { + "$ref": "examples/GetPropertyInfoList-3.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A paged list of Service Fabric properties.", + "schema": { + "$ref": "#/definitions/PagedPropertyInfoList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperty": { + "put": { + "summary": "Creates or updates a Service Fabric property.", + "description": "Creates or updates the specified Service Fabric property under a given name.", + "operationId": "PutProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyDescriptionRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Put property": { + "$ref": "examples/PutProperty-1.json" + }, + "Put custom property": { + "$ref": "examples/PutProperty-2.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been created or updated." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "summary": "Gets the specified Service Fabric property.", + "description": "Gets the specified Service Fabric property under a given name. This will always return both value and metadata.", + "operationId": "GetPropertyInfo", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Get property info": { + "$ref": "examples/GetPropertyInfo-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "Details on the Service Fabric property.", + "schema": { + "$ref": "#/definitions/PropertyInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "summary": "Deletes the specified Service Fabric property.", + "description": "Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.", + "operationId": "DeleteProperty", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyNameRequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property has been deleted." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Names/{nameId}/$/GetProperties/$/SubmitBatch": { + "post": { + "summary": "Submits a property batch.", + "description": "Submits a batch of property operations. Either all or none of the operations will be committed.", + "operationId": "SubmitPropertyBatch", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-0_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NameIdRequiredPathParam" + }, + { + "$ref": "#/parameters/PropertyBatchDescriptionListRequiredBodyParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "x-ms-examples": { + "Property batch operation": { + "$ref": "examples/SubmitPropertyBatch-1.json" + } + }, + "tags": [ + "Property Management" + ], + "responses": { + "200": { + "description": "A successful response means that the property batch succeeded.", + "schema": { + "$ref": "#/definitions/SuccessfulPropertyBatchInfo" + } + }, + "409": { + "description": "A 409 response means that one of the property batch operations failed, and contains more information about the failure. None of the operations were committed.", + "schema": { + "$ref": "#/definitions/FailedPropertyBatchInfo" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Cluster/Events": { + "get": { + "summary": "Gets all Cluster-related events.", + "description": "The response is list of ClusterEvent objects.", + "operationId": "GetClusterEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Cluster-related events": { + "$ref": "./examples/GetClusterEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ClusterEvent.", + "schema": { + "$ref": "#/definitions/ClusterEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Containers/Events": { + "get": { + "summary": "Gets all Containers-related events.", + "description": "The response is list of ContainerInstanceEvent objects.", + "operationId": "GetContainersEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-2-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "responses": { + "200": { + "description": "List of events objects with base type ContainerInstanceEvent.", + "schema": { + "$ref": "#/definitions/ContainerInstanceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/{nodeName}/$/Events": { + "get": { + "summary": "Gets a Node-related events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodeEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NodeNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Node-related events": { + "$ref": "./examples/GetNodeEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Nodes/Events": { + "get": { + "summary": "Gets all Nodes-related Events.", + "description": "The response is list of NodeEvent objects.", + "operationId": "GetNodesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Nodes-related events": { + "$ref": "./examples/GetNodesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type NodeEvent.", + "schema": { + "$ref": "#/definitions/NodeEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/{applicationId}/$/Events": { + "get": { + "summary": "Gets an Application-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Application-related events": { + "$ref": "./examples/GetApplicationEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Applications/Events": { + "get": { + "summary": "Gets all Applications-related events.", + "description": "The response is list of ApplicationEvent objects.", + "operationId": "GetApplicationsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Applications-related events": { + "$ref": "./examples/GetApplicationsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ApplicationEvent.", + "schema": { + "$ref": "#/definitions/ApplicationEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/{serviceId}/$/Events": { + "get": { + "summary": "Gets a Service-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServiceEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ServiceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Service-related events": { + "$ref": "./examples/GetServiceEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Services/Events": { + "get": { + "summary": "Gets all Services-related events.", + "description": "The response is list of ServiceEvent objects.", + "operationId": "GetServicesEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Services-related events": { + "$ref": "./examples/GetServicesEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ServiceEvent.", + "schema": { + "$ref": "#/definitions/ServiceEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Events": { + "get": { + "summary": "Gets a Partition-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition-related events": { + "$ref": "./examples/GetPartitionEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/Events": { + "get": { + "summary": "Gets all Partitions-related events.", + "description": "The response is list of PartitionEvent objects.", + "operationId": "GetPartitionsEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partitions-related events": { + "$ref": "./examples/GetPartitionsEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type PartitionEvent.", + "schema": { + "$ref": "#/definitions/PartitionEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/{replicaId}/$/Events": { + "get": { + "summary": "Gets a Partition Replica-related events.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicaEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replica-related events": { + "$ref": "./examples/GetReplicaEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/Partitions/{partitionId}/$/Replicas/Events": { + "get": { + "summary": "Gets all Replicas-related events for a Partition.", + "description": "The response is list of ReplicaEvent objects.", + "operationId": "GetPartitionReplicasEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/PartitionIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + }, + { + "$ref": "#/parameters/StartTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EndTimeUtcRequiredQueryParam" + }, + { + "$ref": "#/parameters/EventsTypesFilterOptionalQueryParam" + }, + { + "$ref": "#/parameters/ExcludeAnalysisEventsOptionalQueryParam" + }, + { + "$ref": "#/parameters/SkipCorrelationLookupOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Partition Replicas-related events": { + "$ref": "./examples/GetReplicasEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type ReplicaEvent.", + "schema": { + "$ref": "#/definitions/ReplicaEventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/EventsStore/CorrelatedEvents/{eventInstanceId}/$/Events": { + "get": { + "summary": "Gets all correlated events for a given event.", + "description": "The response is list of FabricEvents.", + "operationId": "GetCorrelatedEventList", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4_RequiredQueryParam" + }, + { + "$ref": "#/parameters/EventInstanceIdRequiredPathParam" + }, + { + "$ref": "#/parameters/TimeoutOptionalQueryParam" + } + ], + "tags": [ + "EventsStore" + ], + "x-ms-examples": { + "Get Correlated events": { + "$ref": "./examples/GetCorrelatedEventList.json" + } + }, + "responses": { + "200": { + "description": "List of events objects with base type FabricEvent.", + "schema": { + "$ref": "#/definitions/EventList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Secrets/{secretResourceName}": { + "put": { + "operationId": "MeshSecret_CreateOrUpdate", + "x-ms-examples": { + "CreateOrUpdateMeshSecret": { + "$ref": "./examples/Resources/Secrets/create_update.json" + } + }, + "summary": "Creates or updates a Secret resource.", + "description": "Creates a Secret resource with the specified name, description and properties. If Secret resource with the same name exists, then it is updated with the specified description and properties. Once created, the kind and contentType of a secret resource cannot be updated.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshSecrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshSecret_Get", + "x-ms-examples": { + "GetSecretResource": { + "$ref": "./examples/Resources/Secrets/get.json" + } + }, + "summary": "Gets the Secret resource with the given name.", + "description": "Gets the information about the Secret resource with the given name. The information include the description and other properties of the Secret.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshSecret_Delete", + "x-ms-examples": { + "DeleteSecretResource": { + "$ref": "./examples/Resources/Secrets/delete.json" + } + }, + "summary": "Deletes the Secret resource.", + "description": "Deletes the specified Secret resource and all of its named values.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecrets" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified secret was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Secrets": { + "get": { + "operationId": "MeshSecret_List", + "x-ms-examples": { + "ListMeshSecrets": { + "$ref": "./examples/Resources/Secrets/list.json" + } + }, + "summary": "Lists all the secret resources.", + "description": "Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + } + ], + "tags": [ + "MeshSecrets" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedSecretResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}": { + "put": { + "operationId": "MeshSecretValue_AddValue", + "x-ms-examples": { + "CreateMeshSecretValue": { + "$ref": "./examples/Resources/Secrets/values/create.json" + } + }, + "summary": "Adds the specified value as a new version of the specified secret resource.", + "description": "Creates a new value of the specified secret resource. The name of the value is typically the version identifier. Once created the value cannot be changed.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshSecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshSecretValue_Get", + "x-ms-examples": { + "GetMeshSecretValue": { + "$ref": "./examples/Resources/Secrets/values/get.json" + } + }, + "summary": "Gets the specified secret value resource.", + "description": "Get the information about the specified named secret value resources. The information does not include the actual value of the secret.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshSecretValue_Delete", + "x-ms-examples": { + "DeleteSecretValue": { + "$ref": "./examples/Resources/Secrets/values/delete.json" + } + }, + "summary": "Deletes the specified value of the named secret resource.", + "description": "Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecretValues" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified secret value was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Secrets/{secretResourceName}/values": { + "get": { + "operationId": "MeshSecretValue_List", + "x-ms-examples": { + "ListMeshSecretValues": { + "$ref": "./examples/Resources/Secrets/values/list.json" + } + }, + "summary": "List names of all values of the the specified secret resource.", + "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedSecretValueResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Secrets/{secretResourceName}/values/{secretValueResourceName}/list_value": { + "post": { + "operationId": "MeshSecretValue_Show", + "x-ms-examples": { + "ListMeshSecretValue": { + "$ref": "./examples/Resources/Secrets/values/list_value.json" + } + }, + "summary": "Lists the specified value of the secret resource.", + "description": "Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/SecretResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/SecretValueResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshSecretValues" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecretValue" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Volumes/{volumeResourceName}": { + "put": { + "operationId": "MeshVolume_CreateOrUpdate", + "x-ms-examples": { + "CreateOrUpdateMeshVolume": { + "$ref": "./examples/Resources/Volumes/create_update.json" + } + }, + "summary": "Creates or updates a Volume resource.", + "description": "Creates a Volume resource with the specified name, description and properties. If Volume resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/VolumeResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshVolumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshVolume_Get", + "x-ms-examples": { + "GetVolumeResource": { + "$ref": "./examples/Resources/Volumes/get.json" + } + }, + "summary": "Gets the Volume resource with the given name.", + "description": "Gets the information about the Volume resource with the given name. The information include the description and other properties of the Volume.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshVolumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshVolume_Delete", + "x-ms-examples": { + "DeleteVolumeResource": { + "$ref": "./examples/Resources/Volumes/delete.json" + } + }, + "summary": "Deletes the Volume resource.", + "description": "Deletes the Volume resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/VolumeResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshVolumes" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified volume was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Volumes": { + "get": { + "operationId": "MeshVolume_List", + "x-ms-examples": { + "ListMeshVolumes": { + "$ref": "./examples/Resources/Volumes/list.json" + } + }, + "summary": "Lists all the volume resources.", + "description": "Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + } + ], + "tags": [ + "MeshVolumes" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedVolumeResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Networks/{networkResourceName}": { + "put": { + "operationId": "MeshNetwork_CreateOrUpdate", + "x-ms-examples": { + "CreateOrUpdateMeshNetwork": { + "$ref": "./examples/Resources/Networks/create_update.json" + } + }, + "summary": "Creates or updates a Network resource.", + "description": "Creates a Network resource with the specified name, description and properties. If Network resource with the same name exists, then it is updated with the specified description and properties. Network resource provides connectivity between application services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/NetworkResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshNetworks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshNetwork_Get", + "x-ms-examples": { + "GetNetworkResource": { + "$ref": "./examples/Resources/Networks/get.json" + } + }, + "summary": "Gets the Network resource with the given name.", + "description": "Gets the information about the Network resource with the given name. The information include the description and other properties of the Network.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshNetworks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshNetwork_Delete", + "x-ms-examples": { + "DeleteNetworkResource": { + "$ref": "./examples/Resources/Networks/delete.json" + } + }, + "summary": "Deletes the Network resource.", + "description": "Deletes the Network resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/NetworkResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshNetworks" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified network was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Networks": { + "get": { + "operationId": "MeshNetwork_List", + "x-ms-examples": { + "ListMeshNetworks": { + "$ref": "./examples/Resources/Networks/list.json" + } + }, + "summary": "Lists all the network resources.", + "description": "Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + } + ], + "tags": [ + "MeshNetworks" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedNetworkResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}": { + "put": { + "operationId": "MeshApplication_CreateOrUpdate", + "x-ms-examples": { + "CreateOrUpdateMeshApplication": { + "$ref": "./examples/Resources/Applications/create_update.json" + }, + "CreateOrUpdateMeshApplicationWithAutoScale": { + "$ref": "./examples/Resources/Applications/create_update.autoscale.json" + } + }, + "summary": "Creates or updates a Application resource.", + "description": "Creates a Application resource with the specified name, description and properties. If Application resource with the same name exists, then it is updated with the specified description and properties.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ApplicationResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshApplications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshApplication_Get", + "x-ms-examples": { + "GetApplicationResource": { + "$ref": "./examples/Resources/Applications/get.json" + } + }, + "summary": "Gets the Application resource with the given name.", + "description": "Gets the information about the Application resource with the given name. The information include the description and other properties of the Application.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshApplications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshApplication_Delete", + "x-ms-examples": { + "DeleteApplicationResource": { + "$ref": "./examples/Resources/Applications/delete.json" + } + }, + "summary": "Deletes the Application resource.", + "description": "Deletes the Application resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshApplications" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified application was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications": { + "get": { + "operationId": "MeshApplication_List", + "x-ms-examples": { + "ListMeshApplications": { + "$ref": "./examples/Resources/Applications/list.json" + } + }, + "summary": "Lists all the application resources.", + "description": "Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + } + ], + "tags": [ + "MeshApplications" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedApplicationResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}": { + "get": { + "operationId": "MeshService_Get", + "x-ms-examples": { + "GetServiceResource": { + "$ref": "./examples/Resources/Applications/Services/get.json" + } + }, + "summary": "Gets the Service resource with the given name.", + "description": "Gets the information about the Service resource with the given name. The information include the description and other properties of the Service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshServices" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services": { + "get": { + "operationId": "MeshService_List", + "x-ms-examples": { + "ListMeshServices": { + "$ref": "./examples/Resources/Applications/Services/list.json" + } + }, + "summary": "Lists all the service resources.", + "description": "Gets the information about all services of an application resource. The information include the description and other properties of the Service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshServices" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedServiceResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}/CodePackages/{codePackageName}/Logs": { + "get": { + "operationId": "MeshCodePackage_GetContainerLogs", + "x-ms-examples": { + "GetContainerLogs": { + "$ref": "./examples/Resources/Applications/Services/Replicas/CodePackages/get_logs.json" + } + }, + "summary": "Gets the logs from the container.", + "description": "Gets the logs for the container of the specified code package of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + }, + { + "$ref": "#/parameters/CodePackageNameRequiredPathParam" + }, + { + "$ref": "#/parameters/TailOptionalQueryParam" + } + ], + "tags": [ + "MeshCodePackages" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerLogs" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas/{replicaName}": { + "get": { + "operationId": "MeshServiceReplica_Get", + "x-ms-examples": { + "GetServiceReplica": { + "$ref": "./examples/Resources/Applications/Services/Replicas/get.json" + } + }, + "summary": "Gets the given replica of the service of an application.", + "description": "Gets the information about the service replica with the given name. The information include the description and other properties of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ReplicaNameRequiredPathParam" + } + ], + "tags": [ + "MeshServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Applications/{applicationResourceName}/Services/{serviceResourceName}/Replicas": { + "get": { + "operationId": "MeshServiceReplica_List", + "x-ms-examples": { + "ListMeshServiceReplicas": { + "$ref": "./examples/Resources/Applications/Services/Replicas/list.json" + } + }, + "summary": "Lists all the replicas of a service.", + "description": "Gets the information about all replicas of a service. The information include the description and other properties of the service replica.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/ApplicationResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/ServiceResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshServiceReplicas" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedServiceReplicaDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Gateways/{gatewayResourceName}": { + "put": { + "operationId": "MeshGateway_CreateOrUpdate", + "x-ms-examples": { + "CreateOrUpdateMeshGateway": { + "$ref": "./examples/Resources/Gateways/create_update.json" + } + }, + "summary": "Creates or updates a Gateway resource.", + "description": "Creates a Gateway resource with the specified name, description and properties. If Gateway resource with the same name exists, then it is updated with the specified description and properties. Use Gateway resource to provide public connectivity to application services.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + }, + { + "$ref": "#/parameters/GatewayResourceDescriptionRequiredBodyParam" + } + ], + "tags": [ + "MeshGateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "get": { + "operationId": "MeshGateway_Get", + "x-ms-examples": { + "GetGatewayResource": { + "$ref": "./examples/Resources/Gateways/get.json" + } + }, + "summary": "Gets the Gateway resource with the given name.", + "description": "Gets the information about the Gateway resource with the given name. The information include the description and other properties of the Gateway.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshGateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + }, + "delete": { + "operationId": "MeshGateway_Delete", + "x-ms-examples": { + "DeleteGatewayResource": { + "$ref": "./examples/Resources/Gateways/delete.json" + } + }, + "summary": "Deletes the Gateway resource.", + "description": "Deletes the Gateway resource identified by the name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + }, + { + "$ref": "#/parameters/GatewayResourceNameRequiredPathParam" + } + ], + "tags": [ + "MeshGateways" + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content - the specified gateway was not found." + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + }, + "/Resources/Gateways": { + "get": { + "operationId": "MeshGateway_List", + "x-ms-examples": { + "ListMeshGateways": { + "$ref": "./examples/Resources/Gateways/list.json" + } + }, + "summary": "Lists all the gateway resources.", + "description": "Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion_6-4-Preview_RequiredQueryParam" + } + ], + "tags": [ + "MeshGateways" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PagedGatewayResourceDescriptionList" + } + }, + "default": { + "description": "Error", + "schema": { + "$ref": "#/definitions/FabricError" + } + } + } + } + } + }, + "definitions": { + "HealthState": { + "type": "string", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Ok", + "Warning", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "HealthState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid health state. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ok", + "description": "Indicates the health state is okay. The value is 1." + }, + { + "value": "Warning", + "description": "Indicates the health state is at a warning level. The value is 2." + }, + { + "value": "Error", + "description": "Indicates the health state is at an error level. Error health state should be investigated, as they can impact the correct functionality of the cluster. The value is 3." + }, + { + "value": "Unknown", + "description": "Indicates an unknown health status. The value is 65535." + } + ] + } + }, + "FabricErrorCodes": { + "type": "string", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", + "enum": [ + "FABRIC_E_INVALID_PARTITION_KEY", + "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", + "FABRIC_E_INVALID_ADDRESS", + "FABRIC_E_APPLICATION_NOT_UPGRADING", + "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_FABRIC_NOT_UPGRADING", + "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR", + "FABRIC_E_INVALID_CONFIGURATION", + "FABRIC_E_INVALID_NAME_URI", + "FABRIC_E_PATH_TOO_LONG", + "FABRIC_E_KEY_TOO_LARGE", + "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED", + "FABRIC_E_INVALID_ATOMIC_GROUP", + "FABRIC_E_VALUE_EMPTY", + "FABRIC_E_NODE_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_NOT_FOUND", + "FABRIC_E_APPLICATION_NOT_FOUND", + "FABRIC_E_SERVICE_TYPE_NOT_FOUND", + "FABRIC_E_SERVICE_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND", + "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND", + "FABRIC_E_PARTITION_NOT_FOUND", + "FABRIC_E_REPLICA_DOES_NOT_EXIST", + "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST", + "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND", + "FABRIC_E_DIRECTORY_NOT_FOUND", + "FABRIC_E_FABRIC_VERSION_NOT_FOUND", + "FABRIC_E_FILE_NOT_FOUND", + "FABRIC_E_NAME_DOES_NOT_EXIST", + "FABRIC_E_PROPERTY_DOES_NOT_EXIST", + "FABRIC_E_ENUMERATION_COMPLETED", + "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND", + "FABRIC_E_KEY_NOT_FOUND", + "FABRIC_E_HEALTH_ENTITY_NOT_FOUND", + "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS", + "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS", + "FABRIC_E_SERVICE_ALREADY_EXISTS", + "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS", + "FABRIC_E_APPLICATION_TYPE_IN_USE", + "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION", + "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS", + "FABRIC_E_FABRIC_VERSION_IN_USE", + "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS", + "FABRIC_E_NAME_ALREADY_EXISTS", + "FABRIC_E_NAME_NOT_EMPTY", + "FABRIC_E_PROPERTY_CHECK_FAILED", + "FABRIC_E_SERVICE_METADATA_MISMATCH", + "FABRIC_E_SERVICE_TYPE_MISMATCH", + "FABRIC_E_HEALTH_STALE_REPORT", + "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED", + "FABRIC_E_NODE_HAS_NOT_STOPPED_YET", + "FABRIC_E_INSTANCE_ID_MISMATCH", + "FABRIC_E_VALUE_TOO_LARGE", + "FABRIC_E_NO_WRITE_QUORUM", + "FABRIC_E_NOT_PRIMARY", + "FABRIC_E_NOT_READY", + "FABRIC_E_RECONFIGURATION_PENDING", + "FABRIC_E_SERVICE_OFFLINE", + "E_ABORT", + "FABRIC_E_COMMUNICATION_ERROR", + "FABRIC_E_OPERATION_NOT_COMPLETE", + "FABRIC_E_TIMEOUT", + "FABRIC_E_NODE_IS_UP", + "E_FAIL", + "FABRIC_E_BACKUP_IS_ENABLED", + "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH", + "FABRIC_E_INVALID_FOR_STATELESS_SERVICES", + "FABRIC_E_BACKUP_NOT_ENABLED", + "FABRIC_E_BACKUP_POLICY_NOT_EXISTING", + "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING", + "FABRIC_E_BACKUP_IN_PROGRESS", + "FABRIC_E_RESTORE_IN_PROGRESS", + "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING", + "FABRIC_E_INVALID_SERVICE_SCALING_POLICY", + "E_INVALIDARG", + "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS", + "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND", + "FABRIC_E_VOLUME_ALREADY_EXISTS", + "FABRIC_E_VOLUME_NOT_FOUND", + "SerializationError", + "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR" + ], + "x-ms-enum": { + "name": "FabricErrorCodes", + "modelAsString": true, + "values": [ + { + "value": "FABRIC_E_INVALID_PARTITION_KEY" + }, + { + "value": "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_ADDRESS" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_FABRIC_NOT_UPGRADING" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR" + }, + { + "value": "FABRIC_E_INVALID_CONFIGURATION" + }, + { + "value": "FABRIC_E_INVALID_NAME_URI" + }, + { + "value": "FABRIC_E_PATH_TOO_LONG" + }, + { + "value": "FABRIC_E_KEY_TOO_LARGE" + }, + { + "value": "FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED" + }, + { + "value": "FABRIC_E_INVALID_ATOMIC_GROUP" + }, + { + "value": "FABRIC_E_VALUE_EMPTY" + }, + { + "value": "FABRIC_E_NODE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_NOT_FOUND" + }, + { + "value": "FABRIC_E_SERVICE_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND" + }, + { + "value": "FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND" + }, + { + "value": "FABRIC_E_PARTITION_NOT_FOUND" + }, + { + "value": "FABRIC_E_REPLICA_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND" + }, + { + "value": "FABRIC_E_DIRECTORY_NOT_FOUND" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_NOT_FOUND" + }, + { + "value": "FABRIC_E_FILE_NOT_FOUND" + }, + { + "value": "FABRIC_E_NAME_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_PROPERTY_DOES_NOT_EXIST" + }, + { + "value": "FABRIC_E_ENUMERATION_COMPLETED" + }, + { + "value": "FABRIC_E_SERVICE_MANIFEST_NOT_FOUND" + }, + { + "value": "FABRIC_E_KEY_NOT_FOUND" + }, + { + "value": "FABRIC_E_HEALTH_ENTITY_NOT_FOUND" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS" + }, + { + "value": "FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_SERVICE_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_APPLICATION_TYPE_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_FABRIC_VERSION_IN_USE" + }, + { + "value": "FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_NAME_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_NAME_NOT_EMPTY" + }, + { + "value": "FABRIC_E_PROPERTY_CHECK_FAILED" + }, + { + "value": "FABRIC_E_SERVICE_METADATA_MISMATCH" + }, + { + "value": "FABRIC_E_SERVICE_TYPE_MISMATCH" + }, + { + "value": "FABRIC_E_HEALTH_STALE_REPORT" + }, + { + "value": "FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED" + }, + { + "value": "FABRIC_E_NODE_HAS_NOT_STOPPED_YET" + }, + { + "value": "FABRIC_E_INSTANCE_ID_MISMATCH" + }, + { + "value": "FABRIC_E_VALUE_TOO_LARGE" + }, + { + "value": "FABRIC_E_NO_WRITE_QUORUM" + }, + { + "value": "FABRIC_E_NOT_PRIMARY" + }, + { + "value": "FABRIC_E_NOT_READY" + }, + { + "value": "FABRIC_E_RECONFIGURATION_PENDING" + }, + { + "value": "FABRIC_E_SERVICE_OFFLINE" + }, + { + "value": "E_ABORT" + }, + { + "value": "FABRIC_E_COMMUNICATION_ERROR" + }, + { + "value": "FABRIC_E_OPERATION_NOT_COMPLETE" + }, + { + "value": "FABRIC_E_TIMEOUT" + }, + { + "value": "FABRIC_E_NODE_IS_UP" + }, + { + "value": "E_FAIL" + }, + { + "value": "FABRIC_E_BACKUP_IS_ENABLED" + }, + { + "value": "FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH" + }, + { + "value": "FABRIC_E_INVALID_FOR_STATELESS_SERVICES" + }, + { + "value": "FABRIC_E_BACKUP_NOT_ENABLED" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_NOT_EXISTING" + }, + { + "value": "FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING" + }, + { + "value": "FABRIC_E_BACKUP_IN_PROGRESS" + }, + { + "value": "FABRIC_E_RESTORE_IN_PROGRESS" + }, + { + "value": "FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING" + }, + { + "value": "FABRIC_E_INVALID_SERVICE_SCALING_POLICY" + }, + { + "value": "E_INVALIDARG" + }, + { + "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND" + }, + { + "value": "FABRIC_E_VOLUME_ALREADY_EXISTS" + }, + { + "value": "FABRIC_E_VOLUME_NOT_FOUND" + }, + { + "value": "SerializationError" + }, + { + "value": "FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR" + } + ] + } + }, + "FabricError": { + "description": "The REST API operations for Service Fabric return standard HTTP status codes. This type defines the additional information returned from the Service Fabric API operations that are not successful.", + "properties": { + "Error": { + "$ref": "#/definitions/FabricErrorError", + "description": "Error object containing error code and error message." + } + }, + "required": [ + "Error" + ] + }, + "FabricErrorError": { + "description": "Error object containing error code and error message.", + "properties": { + "Code": { + "$ref": "#/definitions/FabricErrorCodes", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" + }, + "Message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "Code" + ] + }, + "ContainerLogs": { + "description": "Container logs.", + "properties": { + "Content": { + "type": "string", + "description": "Container logs." + } + } + }, + "AadMetadata": { + "description": "Azure Active Directory metadata used for secured connection to cluster.", + "properties": { + "authority": { + "type": "string", + "description": "The AAD authority url." + }, + "client": { + "type": "string", + "description": "The AAD client application Id." + }, + "cluster": { + "type": "string", + "description": "The AAD cluster application Id." + }, + "login": { + "type": "string", + "description": "The AAD login url." + }, + "redirect": { + "type": "string", + "description": "The client application redirect address." + }, + "tenant": { + "type": "string", + "description": "The AAD tenant Id." + } + } + }, + "AadMetadataObject": { + "description": "Azure Active Directory metadata object used for secured connection to cluster.", + "properties": { + "type": { + "type": "string", + "description": "The client authentication method." + }, + "metadata": { + "$ref": "#/definitions/AadMetadata", + "description": "Azure Active Directory metadata used for secured connection to cluster." + } + } + }, + "AnalysisEventMetadata": { + "description": "Metadata about an Analysis Event.", + "properties": { + "Delay": { + "type": "string", + "format": "duration", + "description": "The analysis delay." + }, + "Duration": { + "type": "string", + "format": "duration", + "description": "The duration of analysis." + } + } + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application.", + "enum": [ + "Invalid", + "ServiceFabricApplicationDescription", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 65535." + }, + { + "value": "ServiceFabricApplicationDescription", + "description": "Indicates the application is defined by a Service Fabric application description. The value is 0." + }, + { + "value": "Compose", + "description": "Indicates the application is defined by compose file(s). The value is 1." + } + ] + } + }, + "ApplicationEvent": { + "description": "Represents the base for all Application Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "properties": { + "ApplicationId": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + } + }, + "required": [ + "ApplicationId" + ], + "x-ms-discriminator-value": "ApplicationEvent" + }, + "ApplicationEventList": { + "description": "A list of ApplicationEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationEvent" + } + }, + "ApplicationHealth": { + "description": "Represents the health of the application. Contains the application aggregated health state and the service and deployed application health states.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthState" + }, + "description": "Service health states as found in the health store." + }, + "DeployedApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthState" + }, + "description": "Deployed application health states as found in the health store." + } + } + }, + "ApplicationHealthEvaluation": { + "x-ms-discriminator-value": "Application", + "description": "Represents health evaluation for an application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + }, + "ApplicationHealthPolicies": { + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster." + } + } + }, + "ApplicationHealthPolicy": { + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.", + "default": 0 + }, + "DefaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "ServiceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthPolicyMapItem" + }, + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ApplicationHealthPolicyMapItem": { + "description": "Defines an item in ApplicationHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "$ref": "#/definitions/ApplicationName", + "description": "The key of the application health policy map item. This is the name of the application." + }, + "Value": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "The value of the application health policy map item. This is the ApplicationHealthPolicy for this application." + } + } + }, + "ApplicationHealthState": { + "description": "Represents the health state of an application, which contains the application identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + }, + "ApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a application.\nThe application health state chunk contains the application name, its aggregated health state and any children services and deployed applications that respect the filters in cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ServiceHealthStateChunks": { + "$ref": "#/definitions/ServiceHealthStateChunkList", + "description": "The list of service health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "DeployedApplicationHealthStateChunks": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunkList", + "description": "The list of deployed application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + }, + "ApplicationHealthStateChunkList": { + "description": "The list of application health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + } + ], + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateChunk" + }, + "description": "The list of application health state chunks that respect the input filters in the chunk query." + } + } + }, + "ApplicationHealthStateFilter": { + "description": "Defines matching criteria to determine whether a application should be included in the cluster health chunk.\nOne filter can match zero, one or multiple applications, depending on its properties.", + "properties": { + "ApplicationNameFilter": { + "type": "string", + "description": "The name of the application that matches the filter, as a fabric uri. The filter is applied only to the specified application, if it exists.\nIf the application doesn't exist, no application is returned in the cluster health chunk based on this filter.\nIf the application exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "ApplicationTypeNameFilter": { + "type": "string", + "description": "The name of the application type that matches the filter.\nIf specified, the filter is applied only to applications of the selected application type, if any exists.\nIf no applications of the specified application type exists, no application is returned in the cluster health chunk based on this filter.\nEach application of the specified application type is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all applications are matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the applications. It allows selecting applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only applications that match the filter are returned. All applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the application name or the application type name are specified. If the filter has default value and application name is specified, the matching application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ServiceFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateFilter" + }, + "description": "Defines a list of filters that specify which services to be included in the returned cluster health chunk as children of the application. The services are returned only if the parent application matches a filter.\nIf the list is empty, no services are returned. All the services are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple service filters.\nFor example, it can specify a filter to return all services with health state Error and another filter to always include a service identified by its service name." + }, + "DeployedApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed applications to be included in the returned cluster health chunk as children of the application. The deployed applications are returned only if the parent application matches a filter.\nIf the list is empty, no deployed applications are returned. All the deployed applications are used to evaluate the parent application aggregated health state, regardless of the input filters.\nThe application filter may specify multiple deployed application filters.\nFor example, it can specify a filter to return all deployed applications with health state Error and another filter to always include a deployed application on a specified node." + } + } + }, + "ApplicationId": { + "type": "string", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationInfo": { + "description": "Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/ApplicationStatus", + "description": "The status of the application." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ApplicationDefinitionKind": { + "$ref": "#/definitions/ApplicationDefinitionKind", + "description": "The mechanism used to define a Service Fabric application." + } + } + }, + "ApplicationLoadInfo": { + "description": "Load Information about a Service Fabric application.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes for this application.\nIt is the number of nodes where Service Fabric will reserve Capacity in the cluster which equals to ReservedLoad * MinimumNodes for this Application instance.\nFor applications that do not have application capacity defined this value will be zero." + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where this application can be instantiated.\nIt is the number of nodes this application is allowed to span.\nFor applications that do not have application capacity defined this value will be zero." + }, + "NodeCount": { + "type": "integer", + "format": "int64", + "description": "The number of nodes on which this application is instantiated.\nFor applications that do not have application capacity defined this value will be zero." + }, + "ApplicationLoadMetricInformation": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationName": { + "type": "string", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ApplicationNameInfo": { + "description": "Information about the application name.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + }, + "ApplicationPackageCleanupPolicy": { + "type": "string", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision.", + "enum": [ + "Invalid", + "Default", + "Automatic", + "Manual" + ], + "x-ms-enum": { + "name": "ApplicationPackageCleanupPolicy", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the application package cleanup policy is invalid. This value is default. The value is zero." + }, + { + "value": "Default", + "description": "Indicates that the cleanup policy of application packages is based on the cluster setting \"CleanupApplicationPackageOnProvisionSuccess.\" The value is 1." + }, + { + "value": "Automatic", + "description": "Indicates that the service fabric runtime determines when to do the application package cleanup. By default, cleanup is done on successful provision. The value is 2." + }, + { + "value": "Manual", + "description": "Indicates that the user has to explicitly clean up the application package. The value is 3." + } + ] + } + }, + "ApplicationParameter": { + "description": "Describes an application parameter override to be applied when creating or upgrading an application.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The name of the parameter." + }, + "Value": { + "type": "string", + "description": "The value of the parameter." + } + } + }, + "ApplicationParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "Applications", + "description": "Represents health evaluation for applications, containing health evaluations for each unhealthy application that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation that impacted the aggregated health." + } + } + }, + "ApplicationStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Invalid", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the application status is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the application status is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the application status is creating. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the application status is deleting. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the creation or deletion of application was terminated due to persistent failures. Another create/delete request can be accepted to resume a failed application. The value is 5." + } + ] + } + }, + "ApplicationTypeApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "ApplicationTypeApplications", + "description": "Represents health evaluation for applications of a particular application type. The application type applications evaluation can be returned when cluster health evaluation returns unhealthy aggregated health state, either Error or Warning. It contains health evaluations for each unhealthy application of the included application type that impacted current aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy applications for the application type, specified as an entry in ApplicationTypeHealthPolicyMap." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of applications of the application type found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ApplicationHealthEvaluation of this application type that impacted the aggregated health." + } + } + }, + "ApplicationTypeDefinitionKind": { + "type": "string", + "description": "The mechanism used to define a Service Fabric application type.", + "enum": [ + "Invalid", + "ServiceFabricApplicationPackage", + "Compose" + ], + "x-ms-enum": { + "name": "ApplicationTypeDefinitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type definition kind is invalid. All Service Fabric enumerations have the invalid type. The value is 0." + }, + { + "value": "ServiceFabricApplicationPackage", + "description": "Indicates the application type is defined and created by a Service Fabric application package provided by the user. The value is 1." + }, + { + "value": "Compose", + "description": "Indicates the application type is defined and created implicitly as part of a compose deployment. The value is 2." + } + ] + } + }, + "ApplicationTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMapItem" + }, + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + }, + "ApplicationTypeHealthPolicyMapItem": { + "description": "Defines an item in ApplicationTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the application type health policy map item. This is the name of the application type." + }, + "Value": { + "type": "integer", + "description": "The value of the application type health policy map item.\nThe max percent unhealthy applications allowed for the application type. Must be between zero and 100." + } + } + }, + "ApplicationTypeInfo": { + "description": "Information about an application type.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Version": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "DefaultParameterList": { + "$ref": "#/definitions/ApplicationTypeParameterList", + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "Status": { + "$ref": "#/definitions/ApplicationTypeStatus", + "description": "The status of the application type." + }, + "StatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the application type." + }, + "ApplicationTypeDefinitionKind": { + "$ref": "#/definitions/ApplicationTypeDefinitionKind", + "description": "The mechanism used to define a Service Fabric application type." + } + } + }, + "PagedApplicationTypeInfoList": { + "description": "The list of application types that are provisioned or being provisioned in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application type information.", + "items": { + "$ref": "#/definitions/ApplicationTypeInfo" + } + } + } + }, + "ApplicationTypeManifest": { + "description": "Contains the manifest describing an application type registered in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "ApplicationTypeName": { + "type": "string", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeParameterList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationParameter" + }, + "description": "List of application type parameters that can be overridden when creating or updating the application." + }, + "ApplicationTypeStatus": { + "type": "string", + "description": "The status of the application type.", + "enum": [ + "Invalid", + "Provisioning", + "Available", + "Unprovisioning", + "Failed" + ], + "x-ms-enum": { + "name": "ApplicationTypeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the application type status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the application type is being provisioned in the cluster. The value is 1." + }, + { + "value": "Available", + "description": "Indicates that the application type is fully provisioned and is available for use. An application of this type and version can be created. The value is 2." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the application type is in process of being unprovisioned from the cluster. The value is 3." + }, + { + "value": "Failed", + "description": "Indicates that the application type provisioning failed and it is unavailable for use. The failure details can be obtained from the application type information query. The failed application type information remains in the cluster until it is unprovisioned or reprovisioned successfully. The value is 4." + } + ] + } + }, + "ApplicationUnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "ApplicationUpgradeDescription": { + "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "Parameters": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "Name", + "TargetApplicationTypeVersion", + "UpgradeKind", + "Parameters" + ] + }, + "ApplicationUpgradeProgressInfo": { + "description": "Describes the parameters for an application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ApplicationUpgradeDescription", + "description": "Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription." + }, + "UpgradeDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "type": "string", + "description": "The estimated total amount of time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + } + } + }, + "ByteArray": { + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255.", + "type": "array", + "items": { + "type": "integer" + } + }, + "ClusterConfiguration": { + "description": "Information about the standalone cluster configuration.", + "properties": { + "ClusterConfiguration": { + "type": "string", + "description": "The contents of the cluster configuration file." + } + } + }, + "ClusterEvent": { + "description": "Represents the base for all Cluster Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "x-ms-discriminator-value": "ClusterEvent" + }, + "ClusterEventList": { + "description": "A list of ClusterEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ClusterEvent" + } + }, + "ClusterHealth": { + "description": "Represents the health of the cluster.\nContains the cluster aggregated health state, the cluster application and node health states as well as the health events and the unhealthy evaluations.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "NodeHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthState" + }, + "description": "Cluster node health states as found in the health store." + }, + "ApplicationHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthState" + }, + "description": "Cluster application health states as found in the health store." + } + } + }, + "ClusterHealthChunk": { + "description": "Represents the health chunk of the cluster.\nContains the cluster aggregated health state, and the cluster entities that respect the input filter.", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the cluster computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired cluster health policy and the application health policies." + }, + "NodeHealthStateChunks": { + "$ref": "#/definitions/NodeHealthStateChunkList", + "description": "The list of node health state chunks in the cluster that respect the filters in the cluster health chunk query description." + }, + "ApplicationHealthStateChunks": { + "$ref": "#/definitions/ApplicationHealthStateChunkList", + "description": "The list of application health state chunks in the cluster that respect the filters in the cluster health chunk query description." + } + } + }, + "ClusterHealthChunkQueryDescription": { + "description": "The cluster health chunk query description, which can specify the health policies to evaluate cluster health and very expressive filters to select which cluster entities to include in response.", + "properties": { + "NodeFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateFilter" + }, + "description": "Defines a list of filters that specify which nodes to be included in the returned cluster health chunk.\nIf no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple node filters.\nFor example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName." + }, + "ApplicationFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationHealthStateFilter" + }, + "description": "Defines a list of filters that specify which applications to be included in the returned cluster health chunk.\nIf no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters.\nThe cluster health chunk query may specify multiple application filters.\nFor example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ApplicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "ClusterHealthPolicies": { + "description": "Health policies to evaluate cluster health.", + "properties": { + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + } + } + }, + "ClusterHealthPolicy": { + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node.", + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors.", + "default": false + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n\nIn large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that.", + "default": 0 + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10.\n\nThe percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error.\nIf the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap.\nThe computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero.", + "default": 0 + }, + "ApplicationTypeHealthPolicyMap": { + "$ref": "#/definitions/ApplicationTypeHealthPolicyMap", + "description": "Defines a map with max percentage unhealthy applications for specific application types.\nEach entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type.\n\nThe application type health policy map can be used during cluster health evaluation to describe special application types.\nThe application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy.\nThe applications of application types specified in the map are not counted against the global pool of applications.\nFor example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type\nand assign it a value of 0% (that is, do not tolerate any failures).\nAll other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances.\nThe application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation." + } + } + }, + "ClusterManifest": { + "description": "Information about the cluster manifest.", + "properties": { + "Manifest": { + "type": "string", + "description": "The contents of the cluster manifest file." + } + } + }, + "ClusterVersion": { + "description": "The cluster version.", + "properties": { + "Version": { + "type": "string", + "description": "The Service Fabric cluster runtime version." + } + } + }, + "ContainerApiRequestBody": { + "description": "parameters for making container API call.", + "properties": { + "HttpVerb": { + "type": "string", + "description": "HTTP verb of container REST API, defaults to \"GET\"" + }, + "UriPath": { + "type": "string", + "description": "URI path of container REST API" + }, + "Content-Type": { + "type": "string", + "description": "Content type of container REST API request, defaults to \"application/json\"" + }, + "Body": { + "type": "string", + "description": "HTTP request body of container REST API" + } + }, + "required": [ + "UriPath" + ] + }, + "ContainerApiResponse": { + "description": "Response body that wraps container API result.", + "properties": { + "ContainerApiResult": { + "$ref": "#/definitions/ContainerApiResult", + "description": "Container API result." + } + }, + "required": [ + "ContainerApiResult" + ] + }, + "ContainerApiResult": { + "description": "Container API result.", + "properties": { + "Status": { + "type": "integer", + "description": "HTTP status code returned by the target container API" + }, + "Content-Type": { + "type": "string", + "description": "HTTP content type" + }, + "Content-Encoding": { + "type": "string", + "description": "HTTP content encoding" + }, + "Body": { + "type": "string", + "description": "container API result body" + } + }, + "required": [ + "Status" + ] + }, + "ContainerInstanceEvent": { + "description": "Represents the base for all Container Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "x-ms-discriminator-value": "ContainerInstanceEvent" + }, + "ContainerInstanceEventList": { + "description": "A list of ContainerInstanceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerInstanceEvent" + } + }, + "ContinuationToken": { + "type": "string", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "CurrentUpgradeDomainProgressInfo": { + "description": "Information about the current in-progress upgrade domain.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "CurrentUpgradeDomainDuration": { + "type": "string", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "DeactivationIntentDescription": { + "description": "Describes the intent or reason for deactivating the node.", + "properties": { + "DeactivationIntent": { + "type": "string", + "description": "Describes the intent or reason for deactivating the node. The possible values are following.", + "enum": [ + "Pause", + "Restart", + "RemoveData" + ], + "x-ms-enum": { + "name": "DeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates the intent is for the node to remove data. The value is 3." + } + ] + } + } + } + }, + "DeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "DeltaNodesCheck", + "description": "Represents health evaluation for delta nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when the aggregated health state of the cluster is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state.\nIncludes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + }, + "DeployedApplicationHealth": { + "description": "Information about the health of an application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "Name of the application deployed on the node whose health information is described by this object." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this application is deployed." + }, + "DeployedServicePackageHealthStates": { + "$ref": "#/definitions/DeployedServicePackageHealthStateList", + "description": "Deployed service package health states for the current deployed application as found in the health store." + } + } + }, + "DeployedApplicationHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplication", + "description": "Represents health evaluation for a deployed application, containing information about the data and the algorithm used by the health store to evaluate health.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where the application is deployed to." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the deployed application.\nThe types of the unhealthy evaluations can be DeployedServicePackagesHealthEvaluation or EventHealthEvaluation." + } + } + }, + "DeployedApplicationHealthState": { + "description": "Represents the health state of a deployed application, which contains the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + } + }, + "DeployedApplicationHealthStateChunk": { + "description": "Represents the health state chunk of a deployed application, which contains the node where the application is deployed, the aggregated health state and any deployed service packages that respect the chunk query description filters.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "NodeName": { + "type": "string", + "description": "The name of node where the application is deployed." + }, + "DeployedServicePackageHealthStateChunks": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunkList", + "description": "The list of deployed service package health state chunks belonging to the deployed application that respect the filters in the cluster health chunk query description." + } + } + }, + "DeployedApplicationHealthStateChunkList": { + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationHealthStateChunk" + }, + "description": "The list of deployed application health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedApplicationHealthStateFilter": { + "description": "Defines matching criteria to determine whether a deployed application should be included as a child of an application in the cluster health chunk.\nThe deployed applications are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple deployed applications, depending on its properties.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "The name of the node where the application is deployed in order to match the filter.\nIf specified, the filter is applied only to the application deployed on the specified node.\nIf the application is not deployed on the node with the specified name, no deployed application is returned in the cluster health chunk based on this filter.\nOtherwise, the deployed application is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed applications that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed applications. It allows selecting deployed applications if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed applications that match the filter are returned. All deployed applications are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching deployed application is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed applications with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "DeployedServicePackageFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateFilter" + }, + "description": "Defines a list of filters that specify which deployed service packages to be included in the returned cluster health chunk as children of the parent deployed application. The deployed service packages are returned only if the parent deployed application matches a filter.\nIf the list is empty, no deployed service packages are returned. All the deployed service packages are used to evaluate the parent deployed application aggregated health state, regardless of the input filters.\nThe deployed application filter may specify multiple deployed service package filters.\nFor example, it can specify a filter to return all deployed service packages with health state Error and another filter to always include a deployed service package on a node." + } + } + }, + "DeployedApplicationInfo": { + "description": "Information about application deployed on the node.", + "properties": { + "Id": { + "$ref": "#/definitions/ApplicationId", + "description": "The identity of the application. This is an encoded representation of the application name. This is used in the REST APIs to identify the application resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the application name is \"fabric:/myapp/app1\",\nthe application identity would be \"myapp\\~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "Status": { + "$ref": "#/definitions/DeployedApplicationStatus", + "description": "The status of the application deployed on the node. Following are the possible values." + }, + "WorkDirectory": { + "type": "string", + "description": "The work directory of the application on the node. The work directory can be used to store application data." + }, + "LogDirectory": { + "type": "string", + "description": "The log directory of the application on the node. The log directory can be used to store application logs." + }, + "TempDirectory": { + "type": "string", + "description": "The temp directory of the application on the node. The code packages belonging to the application are forked with this directory set as their temporary directory." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "DeployedApplicationInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + }, + "description": "List of deployed application information." + }, + "DeployedApplicationsHealthEvaluation": { + "x-ms-discriminator-value": "DeployedApplications", + "description": "Represents health evaluation for deployed applications, containing health evaluations for each unhealthy deployed application that impacted current aggregated health state.\nCan be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "MaxPercentUnhealthyDeployedApplications": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy deployed applications from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed applications of the application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedApplicationHealthEvaluation that impacted the aggregated health." + } + } + }, + "DeployedApplicationStatus": { + "type": "string", + "description": "The status of the application deployed on the node. Following are the possible values.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeployedApplicationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that deployment status is not valid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Downloading", + "description": "Indicates that the package is downloading from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates that the package is activating. The value is 2." + }, + { + "value": "Active", + "description": "Indicates that the package is active. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates that the package is upgrading. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates that the package is deactivating. The value is 5." + } + ] + } + }, + "DeployedServicePackageHealth": { + "description": "Information about the health of a service package for a specific application deployed on a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the service manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node where this service package is deployed." + } + } + }, + "DeployedServicePackageHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackage", + "description": "Represents health evaluation for a deployed service package, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state. The type of the unhealthy evaluations can be EventHealthEvaluation." + } + } + }, + "DeployedServicePackageHealthState": { + "description": "Represents the health state of a deployed service package, containing the entity identifier and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node on which the service package is deployed." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "Name of the manifest describing the service package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeployedServicePackageHealthStateChunk": { + "description": "Represents the health state chunk of a deployed service package, which contains the service manifest name and the service package aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeployedServicePackageHealthStateChunkList": { + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthStateChunk" + }, + "description": "The list of deployed service package health state chunks that respect the input filters in the chunk query." + } + } + }, + "DeployedServicePackageHealthStateFilter": { + "description": "Defines matching criteria to determine whether a deployed service package should be included as a child of a deployed application in the cluster health chunk.\nThe deployed service packages are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent deployed application and its parent application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple deployed service packages, depending on its properties.", + "properties": { + "ServiceManifestNameFilter": { + "type": "string", + "description": "The name of the service manifest which identifies the deployed service packages that matches the filter.\nIf specified, the filter is applied only to the specified deployed service packages, if any.\nIf no deployed service packages with specified manifest name exist, nothing is returned in the cluster health chunk based on this filter.\nIf any deployed service package exists, they are included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all deployed service packages that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "ServicePackageActivationIdFilter": { + "type": "string", + "description": "The activation ID of a deployed service package that matches the filter.\nIf not specified, the filter applies to all deployed service packages that match the other parameters.\nIf specified, the filter matches only the deployed service package with the specified activation ID." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the deployed service packages. It allows selecting deployed service packages if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the parent deployed application aggregated health state.\nIf not specified, default value is None, unless the deployed service package ID is specified. If the filter has default value and deployed service package ID is specified, the matching deployed service package is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches deployed service packages with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "DeployedServicePackageHealthStateList": { + "description": "List of health states for a service package deployed on a Service Fabric node.", + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageHealthState" + } + }, + "DeployedServicePackagesHealthEvaluation": { + "x-ms-discriminator-value": "DeployedServicePackages", + "description": "Represents health evaluation for deployed service packages, containing health evaluations for each unhealthy deployed service package that impacted current aggregated health state. Can be returned when evaluating deployed application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of deployed service packages of the deployed application in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy DeployedServicePackageHealthEvaluation that impacted the aggregated health." + } + } + }, + "DeployedServiceReplicaInfo": { + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that hosts this replica." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "Address": { + "type": "string", + "description": "The last address returned by the replica in Open or ChangeRole." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostProcessId": { + "type": "string", + "description": "Host process ID of the process that is hosting the replica. This will be zero if the replica is down. In hyper-v containers this host process ID will be from different kernel." + } + } + }, + "DeployedServiceReplicaInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + }, + "description": "List of deployed service replica information." + }, + "DeployedStatefulServiceReplicaInfo": { + "description": "Information about a stateful service replica deployed on a node.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + } + ], + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReconfigurationInformation": { + "$ref": "#/definitions/ReconfigurationInformation", + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time." + } + } + }, + "DeployedStatelessServiceInstanceInfo": { + "description": "Information about a stateless service instance deployed on a node.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaInfo" + } + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + }, + "EntityHealth": { + "description": "Health information common to all entities in the cluster. It contains the aggregated health state, health events and unhealthy evaluation.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The HealthState representing the aggregated health state of the entity computed by Health Manager.\nThe health evaluation of the entity reflects all events reported on the entity and its children (if any).\nThe aggregation is done by applying the desired health policy." + }, + "HealthEvents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvent" + }, + "description": "The list of health events reported on the entity." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "The unhealthy evaluations that show why the current aggregated health state was returned by Health Manager." + }, + "HealthStatistics": { + "$ref": "#/definitions/HealthStatistics", + "description": "Shows the health statistics for all children types of the queried entity." + } + } + }, + "EntityHealthState": { + "description": "A base type for the health state of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunk": { + "description": "A base type for the health state chunk of various entities in the cluster. It contains the aggregated health state.", + "properties": { + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + } + } + }, + "EntityHealthStateChunkList": { + "description": "A base type for the list of health state chunks found in the cluster. It contains the total number of health states that match the input filters.", + "properties": { + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of entity health state objects that match the specified filters from the cluster health chunk query description." + } + } + }, + "Epoch": { + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica.", + "properties": { + "ConfigurationVersion": { + "type": "string", + "description": "The current configuration number of this Epoch. The configuration number is an increasing value that is updated whenever the configuration of this replica set changes." + }, + "DataLossVersion": { + "type": "string", + "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + } + } + }, + "EventHealthEvaluation": { + "x-ms-discriminator-value": "Event", + "description": "Represents health evaluation of a HealthEvent that was reported on the entity.\nThe health evaluation is returned when evaluating health of an entity results in Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ConsiderWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors. The field is specified in the health policy used to evaluate the entity." + }, + "UnhealthyEvent": { + "$ref": "#/definitions/HealthEvent", + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager." + } + } + }, + "EventList": { + "description": "A list of FabricEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/FabricEvent" + } + }, + "FabricCodeVersionInfo": { + "description": "Information about a Service Fabric code version.", + "properties": { + "CodeVersion": { + "description": "The product version of Service Fabric.", + "type": "string" + } + } + }, + "FabricCodeVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricCodeVersionInfo" + }, + "description": "List of all Service Fabric code versions." + }, + "FabricConfigVersionInfo": { + "description": "Information about a Service Fabric config version.", + "properties": { + "ConfigVersion": { + "description": "The config version of Service Fabric.", + "type": "string" + } + } + }, + "FabricConfigVersionInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/FabricConfigVersionInfo" + }, + "description": "List of all Service Fabric config versions." + }, + "FabricEvent": { + "discriminator": "Kind", + "description": "Represents the base for all Fabric Events.", + "properties": { + "Kind": { + "$ref": "#/definitions/FabricEventKind", + "description": "The kind of FabricEvent." + }, + "EventInstanceId": { + "type": "string", + "format": "uuid", + "description": "The identifier for the FabricEvent instance." + }, + "Category": { + "type": "string", + "description": "The category of event." + }, + "TimeStamp": { + "type": "string", + "format": "date-time", + "description": "The time event was logged." + }, + "HasCorrelatedEvents": { + "type": "boolean", + "description": "Shows there is existing related events available." + } + }, + "required": [ + "Kind", + "EventInstanceId", + "TimeStamp" + ] + }, + "FabricEventKind": { + "type": "string", + "description": "The kind of FabricEvent.", + "enum": [ + "ClusterEvent", + "ContainerInstanceEvent", + "NodeEvent", + "ApplicationEvent", + "ServiceEvent", + "PartitionEvent", + "ReplicaEvent", + "PartitionAnalysisEvent", + "ApplicationCreated", + "ApplicationDeleted", + "ApplicationNewHealthReport", + "ApplicationHealthReportExpired", + "ApplicationUpgradeCompleted", + "ApplicationUpgradeDomainCompleted", + "ApplicationUpgradeRollbackCompleted", + "ApplicationUpgradeRollbackStarted", + "ApplicationUpgradeStarted", + "DeployedApplicationNewHealthReport", + "DeployedApplicationHealthReportExpired", + "ApplicationProcessExited", + "ApplicationContainerInstanceExited", + "NodeAborted", + "NodeAddedToCluster", + "NodeClosed", + "NodeDeactivateCompleted", + "NodeDeactivateStarted", + "NodeDown", + "NodeNewHealthReport", + "NodeHealthReportExpired", + "NodeOpenSucceeded", + "NodeOpenFailed", + "NodeRemovedFromCluster", + "NodeUp", + "PartitionNewHealthReport", + "PartitionHealthReportExpired", + "PartitionReconfigured", + "PartitionPrimaryMoveAnalysis", + "ServiceCreated", + "ServiceDeleted", + "ServiceNewHealthReport", + "ServiceHealthReportExpired", + "DeployedServicePackageNewHealthReport", + "DeployedServicePackageHealthReportExpired", + "StatefulReplicaNewHealthReport", + "StatefulReplicaHealthReportExpired", + "StatelessReplicaNewHealthReport", + "StatelessReplicaHealthReportExpired", + "ClusterNewHealthReport", + "ClusterHealthReportExpired", + "ClusterUpgradeCompleted", + "ClusterUpgradeDomainCompleted", + "ClusterUpgradeRollbackCompleted", + "ClusterUpgradeRollbackStarted", + "ClusterUpgradeStarted", + "ChaosStopped", + "ChaosStarted", + "ChaosCodePackageRestartScheduled", + "ChaosReplicaRemovalScheduled", + "ChaosPartitionSecondaryMoveScheduled", + "ChaosPartitionPrimaryMoveScheduled", + "ChaosReplicaRestartScheduled", + "ChaosNodeRestartScheduled" + ], + "x-ms-enum": { + "name": "FabricEventKind", + "modelAsString": true, + "values": [ + { + "value": "ClusterEvent" + }, + { + "value": "ContainerInstanceEvent" + }, + { + "value": "NodeEvent" + }, + { + "value": "ApplicationEvent" + }, + { + "value": "ServiceEvent" + }, + { + "value": "PartitionEvent" + }, + { + "value": "ReplicaEvent" + }, + { + "value": "PartitionAnalysisEvent" + }, + { + "value": "ApplicationCreated" + }, + { + "value": "ApplicationDeleted" + }, + { + "value": "ApplicationNewHealthReport" + }, + { + "value": "ApplicationHealthReportExpired" + }, + { + "value": "ApplicationUpgradeCompleted" + }, + { + "value": "ApplicationUpgradeDomainCompleted" + }, + { + "value": "ApplicationUpgradeRollbackCompleted" + }, + { + "value": "ApplicationUpgradeRollbackStarted" + }, + { + "value": "ApplicationUpgradeStarted" + }, + { + "value": "DeployedApplicationNewHealthReport" + }, + { + "value": "DeployedApplicationHealthReportExpired" + }, + { + "value": "ApplicationProcessExited" + }, + { + "value": "ApplicationContainerInstanceExited" + }, + { + "value": "NodeAborted" + }, + { + "value": "NodeAddedToCluster" + }, + { + "value": "NodeClosed" + }, + { + "value": "NodeDeactivateCompleted" + }, + { + "value": "NodeDeactivateStarted" + }, + { + "value": "NodeDown" + }, + { + "value": "NodeNewHealthReport" + }, + { + "value": "NodeHealthReportExpired" + }, + { + "value": "NodeOpenSucceeded" + }, + { + "value": "NodeOpenFailed" + }, + { + "value": "NodeRemovedFromCluster" + }, + { + "value": "NodeUp" + }, + { + "value": "PartitionNewHealthReport" + }, + { + "value": "PartitionHealthReportExpired" + }, + { + "value": "PartitionReconfigured" + }, + { + "value": "PartitionPrimaryMoveAnalysis" + }, + { + "value": "ServiceCreated" + }, + { + "value": "ServiceDeleted" + }, + { + "value": "ServiceNewHealthReport" + }, + { + "value": "ServiceHealthReportExpired" + }, + { + "value": "DeployedServicePackageNewHealthReport" + }, + { + "value": "DeployedServicePackageHealthReportExpired" + }, + { + "value": "StatefulReplicaNewHealthReport" + }, + { + "value": "StatefulReplicaHealthReportExpired" + }, + { + "value": "StatelessReplicaNewHealthReport" + }, + { + "value": "StatelessReplicaHealthReportExpired" + }, + { + "value": "ClusterNewHealthReport" + }, + { + "value": "ClusterHealthReportExpired" + }, + { + "value": "ClusterUpgradeCompleted" + }, + { + "value": "ClusterUpgradeDomainCompleted" + }, + { + "value": "ClusterUpgradeRollbackCompleted" + }, + { + "value": "ClusterUpgradeRollbackStarted" + }, + { + "value": "ClusterUpgradeStarted" + }, + { + "value": "ChaosStopped" + }, + { + "value": "ChaosStarted" + }, + { + "value": "ChaosCodePackageRestartScheduled" + }, + { + "value": "ChaosReplicaRemovalScheduled" + }, + { + "value": "ChaosPartitionSecondaryMoveScheduled" + }, + { + "value": "ChaosPartitionPrimaryMoveScheduled" + }, + { + "value": "ChaosReplicaRestartScheduled" + }, + { + "value": "ChaosNodeRestartScheduled" + } + ] + } + }, + "ClusterConfigurationUpgradeStatusInfo": { + "description": "Information about a standalone cluster configuration upgrade status.", + "properties": { + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "ProgressStatus": { + "type": "integer", + "description": "The cluster manifest version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "Details": { + "type": "string", + "description": "The cluster upgrade status details." + } + } + }, + "FailureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Invalid", + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the failure action is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rollback", + "description": "The upgrade will start rolling back automatically. The value is 1" + }, + { + "value": "Manual", + "description": "The upgrade will switch to UnmonitoredManual upgrade mode. The value is 2" + } + ] + } + }, + "FailureReason": { + "type": "string", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed.", + "enum": [ + "None", + "Interrupted", + "HealthCheck", + "UpgradeDomainTimeout", + "OverallUpgradeTimeout" + ], + "x-ms-enum": { + "name": "FailureReason", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the reason is invalid or unknown. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Interrupted", + "description": "There was an external request to roll back the upgrade. The value is 1" + }, + { + "value": "HealthCheck", + "description": "The upgrade failed due to health policy violations. The value is 2" + }, + { + "value": "UpgradeDomainTimeout", + "description": "An upgrade domain took longer than the allowed upgrade domain timeout to process. The value is 3" + }, + { + "value": "OverallUpgradeTimeout", + "description": "The overall upgrade took longer than the allowed upgrade timeout to process. The value is 4" + } + ] + } + }, + "FailureUpgradeDomainProgressInfo": { + "description": "Information about the upgrade domain progress at the time of upgrade failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H10M0S" + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "0" + }, + "HealthEvaluation": { + "discriminator": "Kind", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity.", + "properties": { + "Kind": { + "$ref": "#/definitions/HealthEvaluationKind", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values." + }, + "AggregatedHealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "Description": { + "type": "string", + "description": "Description of the health evaluation, which represents a summary of the evaluation process." + } + }, + "required": [ + "Kind" + ] + }, + "HealthEvaluationKind": { + "type": "string", + "description": "The health manager in the cluster performs health evaluations in determining the aggregated health state of an entity. This enumeration provides information on the kind of evaluation that was performed. Following are the possible values.", + "enum": [ + "Invalid", + "Event", + "Replicas", + "Partitions", + "DeployedServicePackages", + "DeployedApplications", + "Services", + "Nodes", + "Applications", + "SystemApplication", + "UpgradeDomainDeployedApplications", + "UpgradeDomainNodes", + "Replica", + "Partition", + "DeployedServicePackage", + "DeployedApplication", + "Service", + "Node", + "Application", + "DeltaNodesCheck", + "UpgradeDomainDeltaNodesCheck", + "ApplicationTypeApplications" + ], + "x-ms-enum": { + "name": "HealthEvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the health evaluation is invalid. The value is zero." + }, + { + "value": "Event", + "description": "Indicates that the health evaluation is for a health event. The value is 1." + }, + { + "value": "Replicas", + "description": "Indicates that the health evaluation is for the replicas of a partition. The value is 2." + }, + { + "value": "Partitions", + "description": "Indicates that the health evaluation is for the partitions of a service. The value is 3." + }, + { + "value": "DeployedServicePackages", + "description": "Indicates that the health evaluation is for the deployed service packages of a deployed application. The value is 4." + }, + { + "value": "DeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application. The value is 5." + }, + { + "value": "Services", + "description": "Indicates that the health evaluation is for services of an application. The value is 6." + }, + { + "value": "Nodes", + "description": "Indicates that the health evaluation is for the cluster nodes. The value is 7." + }, + { + "value": "Applications", + "description": "Indicates that the health evaluation is for the cluster applications. The value is 8." + }, + { + "value": "SystemApplication", + "description": "Indicates that the health evaluation is for the system application. The value is 9." + }, + { + "value": "UpgradeDomainDeployedApplications", + "description": "Indicates that the health evaluation is for the deployed applications of an application in an upgrade domain. The value is 10." + }, + { + "value": "UpgradeDomainNodes", + "description": "Indicates that the health evaluation is for the cluster nodes in an upgrade domain. The value is 11." + }, + { + "value": "Replica", + "description": "Indicates that the health evaluation is for a replica. The value is 13." + }, + { + "value": "Partition", + "description": "Indicates that the health evaluation is for a partition. The value is 14." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates that the health evaluation is for a deployed service package. The value is 16." + }, + { + "value": "DeployedApplication", + "description": "Indicates that the health evaluation is for a deployed application. The value is 17." + }, + { + "value": "Service", + "description": "Indicates that the health evaluation is for a service. The value is 15." + }, + { + "value": "Node", + "description": "Indicates that the health evaluation is for a node. The value is 12." + }, + { + "value": "Application", + "description": "Indicates that the health evaluation is for an application. The value is 18." + }, + { + "value": "DeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy cluster nodes. The value is 19." + }, + { + "value": "UpgradeDomainDeltaNodesCheck", + "description": "Indicates that the health evaluation is for the delta of unhealthy upgrade domain cluster nodes. The value is 20." + }, + { + "value": "ApplicationTypeApplications", + "description": "– Indicates that the health evaluation is for applications of an application type. The value is 21." + } + ] + } + }, + "HealthEvaluationWrapper": { + "description": "Wrapper object for health evaluation.", + "properties": { + "HealthEvaluation": { + "$ref": "#/definitions/HealthEvaluation", + "description": "Represents a health evaluation which describes the data and the algorithm used by health manager to evaluate the health of an entity." + } + } + }, + "HealthEvent": { + "description": "Represents health information reported on a health entity, such as cluster, application or node, with additional metadata added by the Health Manager.", + "allOf": [ + { + "$ref": "#/definitions/HealthInformation" + } + ], + "properties": { + "IsExpired": { + "type": "boolean", + "description": "Returns true if the health event is expired, otherwise false." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was sent by the source." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The date and time when the health report was last modified by the health store." + }, + "LastOkTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Ok', this property returns the time at which the health report was first reported with 'Ok'.\nFor periodic reporting, many reports with the same state may have been generated.\nThis property returns the date and time when the first 'Ok' health report was received.\n\nIf the current health state is 'Error' or 'Warning', returns the date and time at which the health state was last in 'Ok', before transitioning to a different state.\n\nIf the health state was never 'Ok', the value will be zero date-time." + }, + "LastWarningTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Warning', this property returns the time at which the health report was first reported with 'Warning'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Warning' health report was received.\n\nIf the current health state is 'Ok' or 'Error', returns the date and time at which the health state was last in 'Warning', before transitioning to a different state.\n\nIf the health state was never 'Warning', the value will be zero date-time." + }, + "LastErrorTransitionAt": { + "type": "string", + "format": "date-time", + "description": "If the current health state is 'Error', this property returns the time at which the health report was first reported with 'Error'. For periodic reporting, many reports with the same state may have been generated however, this property returns only the date and time at the first 'Error' health report was received.\n\nIf the current health state is 'Ok' or 'Warning', returns the date and time at which the health state was last in 'Error', before transitioning to a different state.\n\nIf the health state was never 'Error', the value will be zero date-time." + } + } + }, + "HealthInformation": { + "description": "Represents common health report information. It is included in all health reports sent to health store and in all health events returned by health queries.", + "required": [ + "SourceId", + "Property", + "HealthState" + ], + "properties": { + "SourceId": { + "type": "string", + "description": "The source name that identifies the client/watchdog/system component that generated the health information." + }, + "Property": { + "type": "string", + "description": "The property of the health information. An entity can have health reports for different properties.\nThe property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report.\nFor example, a reporter with SourceId \"LocalWatchdog\" can monitor the state of the available disk on a node,\nso it can report \"AvailableDisk\" property on that node.\nThe same reporter can monitor the node connectivity, so it can report a property \"Connectivity\" on the same node.\nIn the health store, these reports are treated as separate health events for the specified node.\n\nTogether with the SourceId, the property uniquely identifies the health information." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "TimeToLiveInMilliSeconds": { + "type": "string", + "format": "duration", + "description": "The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration.\nWhen clients report periodically, they should send reports with higher frequency than time to live.\nIf clients report on transition, they can set the time to live to infinite.\nWhen time to live expires, the health event that contains the health information\nis either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false.\n\nIf not specified, time to live defaults to infinite value." + }, + "Description": { + "type": "string", + "description": "The description of the health information. It represents free text used to add human readable information about the report.\nThe maximum string length for the description is 4096 characters.\nIf the provided string is longer, it will be automatically truncated.\nWhen truncated, the last characters of the description contain a marker \"[Truncated]\", and total string size is 4096 characters.\nThe presence of the marker indicates to users that truncation occurred.\nNote that when truncated, the description has less than 4096 characters from the original string." + }, + "SequenceNumber": { + "type": "string", + "description": "The sequence number for this health report as a numeric string.\nThe report sequence number is used by the health store to detect stale reports.\nIf not specified, a sequence number is auto-generated by the health client when a report is added." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Value that indicates whether the report is removed from health store when it expires.\nIf set to true, the report is removed from the health store after it expires.\nIf set to false, the report is treated as an error when expired. The value of this property is false by default.\nWhen clients report periodically, they should set RemoveWhenExpired false (default).\nThis way, if the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires.\nThis flags the entity as being in Error health state." + } + } + }, + "Int64RangePartitionInformation": { + "description": "Describes the partition information for the integer range that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + } + ], + "x-ms-discriminator-value": "Int64Range", + "properties": { + "LowKey": { + "type": "string", + "description": "Specifies the minimum key value handled by this partition." + }, + "HighKey": { + "type": "string", + "description": "Specifies the maximum key value handled by this partition." + } + } + }, + "MonitoringPolicyDescription": { + "description": "Describes the parameters for monitoring an upgrade in Monitored mode.", + "properties": { + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + } + }, + "NamedPartitionInformation": { + "description": "Describes the partition information for the name as a string that is based on partition schemes.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + } + ], + "x-ms-discriminator-value": "Named", + "properties": { + "Name": { + "type": "string", + "description": "Name of the partition." + } + } + }, + "NextUpgradeDomain": { + "type": "string", + "description": "The name of the next upgrade domain to be processed." + }, + "NodeDeactivationInfo": { + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.", + "properties": { + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + }, + "NodeDeactivationStatus": { + "$ref": "#/definitions/NodeDeactivationStatus", + "description": "The status of node deactivation operation. Following are the possible values." + }, + "NodeDeactivationTask": { + "$ref": "#/definitions/NodeDeactivationTaskList", + "description": "List of tasks representing the deactivation operation on the node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeDeactivationIntent": { + "type": "string", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it.", + "enum": [ + "Invalid", + "Pause", + "Restart", + "RemoveData", + "RemoveNode" + ], + "x-ms-enum": { + "name": "NodeDeactivationIntent", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation intent is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Pause", + "description": "Indicates that the node should be paused. The value is 1." + }, + { + "value": "Restart", + "description": "Indicates that the intent is for the node to be restarted after a short period of time. Service Fabric does not restart the node, this action is done outside of Service Fabric. The value is 2." + }, + { + "value": "RemoveData", + "description": "Indicates that the intent is to reimage the node. Service Fabric does not reimage the node, this action is done outside of Service Fabric. The value is 3." + }, + { + "value": "RemoveNode", + "description": "Indicates that the node is being decommissioned and is not expected to return. Service Fabric does not decommission the node, this action is done outside of Service Fabric. The value is 4." + } + ] + } + }, + "NodeDeactivationStatus": { + "type": "string", + "description": "The status of node deactivation operation. Following are the possible values.", + "enum": [ + "None", + "SafetyCheckInProgress", + "SafetyCheckComplete", + "Completed" + ], + "x-ms-enum": { + "name": "NodeDeactivationStatus", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No status is associated with the task. The value is zero." + }, + { + "value": "SafetyCheckInProgress", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that one or more safety checks are in progress. The value is 1." + }, + { + "value": "SafetyCheckComplete", + "description": "When a node is deactivated Service Fabric performs checks to ensure that the operation is safe to proceed to ensure availability of the service and reliability of the state. This value indicates that all safety checks have been completed. The value is 2." + }, + { + "value": "Completed", + "description": "The task is completed. The value is 3." + } + ] + } + }, + "NodeDeactivationTask": { + "description": "The task representing the deactivation operation on the node.", + "properties": { + "NodeDeactivationTaskId": { + "$ref": "#/definitions/NodeDeactivationTaskId", + "description": "Identity of the task related to deactivation operation on the node." + }, + "NodeDeactivationIntent": { + "$ref": "#/definitions/NodeDeactivationIntent", + "description": "The intent or the reason for deactivating the node. Following are the possible values for it." + } + } + }, + "NodeDeactivationTaskId": { + "description": "Identity of the task related to deactivation operation on the node.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the task id." + }, + "NodeDeactivationTaskType": { + "$ref": "#/definitions/NodeDeactivationTaskType", + "description": "The type of the task that performed the node deactivation. Following are the possible values." + } + } + }, + "NodeDeactivationTaskList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeDeactivationTask" + }, + "description": "List of tasks representing the deactivation operation on the node." + }, + "NodeDeactivationTaskType": { + "type": "string", + "description": "The type of the task that performed the node deactivation. Following are the possible values.", + "enum": [ + "Invalid", + "Infrastructure", + "Repair", + "Client" + ], + "x-ms-enum": { + "name": "NodeDeactivationTaskType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node deactivation task type is invalid. All Service Fabric enumerations have the invalid type. The value is zero. This value is not used." + }, + { + "value": "Infrastructure", + "description": "Specifies the task created by Infrastructure hosting the nodes. The value is 1." + }, + { + "value": "Repair", + "description": "Specifies the task that was created by the Repair Manager service. The value is 2." + }, + { + "value": "Client", + "description": "Specifies that the task was created by using the public API. The value is 3." + } + ] + } + }, + "NodeEvent": { + "description": "Represents the base for all Node Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + }, + "required": [ + "NodeName" + ], + "x-ms-discriminator-value": "NodeEvent" + }, + "NodeEventList": { + "description": "A list of NodeEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeEvent" + } + }, + "NodeHealth": { + "description": "Information about the health of a Service Fabric node.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node whose health information is described by this object." + } + } + }, + "NodeHealthEvaluation": { + "x-ms-discriminator-value": "Node", + "description": "Represents health evaluation for a node, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the node. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + }, + "NodeHealthState": { + "description": "Represents the health state of a node, which contains the node identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + } + } + }, + "NodeHealthStateChunk": { + "description": "Represents the health state chunk of a node, which contains the node name and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + } + } + }, + "NodeHealthStateChunkList": { + "description": "The list of node health state chunks in the cluster that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunkList" + } + ], + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeHealthStateChunk" + }, + "description": "The list of node health state chunks that respect the input filters in the chunk query." + } + } + }, + "NodeHealthStateFilter": { + "description": "Defines matching criteria to determine whether a node should be included in the returned cluster health chunk.\nOne filter can match zero, one or multiple nodes, depending on its properties.\nCan be specified in the cluster health chunk query description.", + "properties": { + "NodeNameFilter": { + "type": "string", + "description": "Name of the node that matches the filter. The filter is applied only to the specified node, if it exists.\nIf the node doesn't exist, no node is returned in the cluster health chunk based on this filter.\nIf the node exists, it is included in the cluster health chunk if the health state matches the other filter properties.\nIf not specified, all nodes that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the nodes. It allows selecting nodes if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the node name is specified. If the filter has default value and node name is specified, the matching node is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches nodes with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "NodeId": { + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.", + "properties": { + "Id": { + "type": "string", + "description": "Value of the node Id. This is a 128 bit integer." + } + } + }, + "NodeIdList": { + "description": "A list of NodeIds.", + "type": "array", + "items": { + "$ref": "#/definitions/NodeId" + } + }, + "NodeInfo": { + "description": "Information about a node in Service Fabric cluster.", + "properties": { + "Name": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "The IP address or fully qualified domain name of the node." + }, + "Type": { + "type": "string", + "description": "The type of the node." + }, + "CodeVersion": { + "type": "string", + "description": "The version of Service Fabric binaries that the node is running." + }, + "ConfigVersion": { + "type": "string", + "description": "The version of Service Fabric cluster manifest that the node is using." + }, + "NodeStatus": { + "$ref": "#/definitions/NodeStatus", + "description": "The status of the node." + }, + "NodeUpTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster." + }, + "UpgradeDomain": { + "type": "string", + "description": "The upgrade domain of the node." + }, + "FaultDomain": { + "type": "string", + "description": "The fault domain of the node." + }, + "Id": { + "$ref": "#/definitions/NodeId", + "description": "An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name." + }, + "InstanceId": { + "type": "string", + "description": "The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts." + }, + "NodeDeactivationInfo": { + "$ref": "#/definitions/NodeDeactivationInfo", + "description": "Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated." + }, + "IsStopped": { + "type": "boolean", + "description": "Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false." + }, + "NodeDownTimeInSeconds": { + "type": "string", + "description": "Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down." + }, + "NodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node came up. If the node has never been up then this value will be zero date time." + }, + "NodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Date time in UTC when the node went down. If node has never been down then this value will be zero date time." + } + } + }, + "NodeLoadInfo": { + "description": "Information about load on a Service Fabric node. It holds a summary of all metrics and their load on a node.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "Name of the node for which the load information is provided by this object." + }, + "NodeLoadMetricInformation": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeLoadMetricInformation" + }, + "description": "List that contains metrics and their load information on this node." + } + } + }, + "NodeLoadMetricInformation": { + "description": "Represents data structure that contains load information for a certain metric on a node.", + "properties": { + "Name": { + "type": "string", + "description": "Name of the metric for which this load information is provided." + }, + "NodeCapacity": { + "type": "string", + "description": "Total capacity on the node for this metric." + }, + "NodeLoad": { + "type": "string", + "description": "Current load on the node for this metric." + }, + "NodeRemainingCapacity": { + "type": "string", + "description": "The remaining capacity on the node for this metric." + }, + "IsCapacityViolation": { + "type": "boolean", + "description": "Indicates if there is a capacity violation for this metric on the node." + }, + "NodeBufferedCapacity": { + "type": "string", + "description": "The value that indicates the reserved capacity for this metric on the node." + }, + "NodeRemainingBufferedCapacity": { + "type": "string", + "description": "The remaining reserved capacity for this metric on the node." + } + } + }, + "NodeName": { + "type": "string", + "description": "The name of a Service Fabric node." + }, + "NodeType": { + "type": "string", + "description": "The type name of a Service Fabric node.\nRefer to the article [The relationship between Service Fabric node types and Virtual Machine Scale Sets](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-nodetypes) for more details." + }, + "NodesHealthEvaluation": { + "x-ms-discriminator-value": "Nodes", + "description": "Represents health evaluation for nodes, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes found in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + }, + "NodeStatus": { + "type": "string", + "description": "The status of the node.", + "enum": [ + "Invalid", + "Up", + "Down", + "Enabling", + "Disabling", + "Disabled", + "Unknown", + "Removed" + ], + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the node status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Up", + "description": "Indicates the node is up. The value is 1." + }, + { + "value": "Down", + "description": "Indicates the node is down. The value is 2." + }, + { + "value": "Enabling", + "description": "Indicates the node is in process of being enabled. The value is 3." + }, + { + "value": "Disabling", + "description": "Indicates the node is in the process of being disabled. The value is 4." + }, + { + "value": "Disabled", + "description": "Indicates the node is disabled. The value is 5." + }, + { + "value": "Unknown", + "description": "Indicates the node is unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime.The value is 6." + }, + { + "value": "Removed", + "description": "Indicates the node is removed. A node would be in Removed state if NodeStateRemoved API has been called for this node. In other words, Service Fabric has been informed that the persisted state on the node has been permanently lost. The value is 7." + } + ] + } + }, + "NodeUpgradePhase": { + "type": "string", + "description": "The state of the upgrading node.", + "enum": [ + "Invalid", + "PreUpgradeSafetyCheck", + "Upgrading", + "PostUpgradeSafetyCheck" + ], + "x-ms-enum": { + "name": "NodeUpgradePhase", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PreUpgradeSafetyCheck", + "description": "The upgrade has not started yet due to pending safety checks. The value is 1" + }, + { + "value": "Upgrading", + "description": "The upgrade is in progress. The value is 2" + }, + { + "value": "PostUpgradeSafetyCheck", + "description": "The upgrade has completed and post upgrade safety checks are being performed. The value is 3" + } + ] + } + }, + "NodeUpgradeProgressInfo": { + "description": "Information about the upgrading node and its status", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "UpgradePhase": { + "$ref": "#/definitions/NodeUpgradePhase", + "description": "The state of the upgrading node." + }, + "PendingSafetyChecks": { + "$ref": "#/definitions/SafetyCheckInfoList", + "description": "List of pending safety checks" + } + } + }, + "NodeUpgradeProgressInfoList": { + "type": "array", + "description": "List of upgrading nodes and their statuses", + "items": { + "$ref": "#/definitions/NodeUpgradeProgressInfo" + } + }, + "PagedApplicationInfoList": { + "description": "The list of applications in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of application information.", + "items": { + "$ref": "#/definitions/ApplicationInfo" + } + } + } + }, + "PagedDeployedApplicationInfoList": { + "description": "The list of deployed applications in activating, downloading, or active states on a node.\nThe list is paged when all of the results cannot fit in a single message.\nThe next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of deployed application information.", + "items": { + "$ref": "#/definitions/DeployedApplicationInfo" + } + } + } + }, + "PagedNodeInfoList": { + "description": "The list of nodes in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of node information.", + "items": { + "$ref": "#/definitions/NodeInfo" + } + } + } + }, + "PagedServicePartitionInfoList": { + "description": "The list of partition in the cluster for a service. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service partition information.", + "items": { + "$ref": "#/definitions/ServicePartitionInfo" + } + } + } + }, + "PagedReplicaInfoList": { + "description": "The list of replicas in the cluster for a given partition. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of replica information.", + "items": { + "$ref": "#/definitions/ReplicaInfo" + } + } + } + }, + "PagedServiceInfoList": { + "description": "The list of services in the cluster for an application. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service information.", + "items": { + "$ref": "#/definitions/ServiceInfo" + } + } + } + }, + "PartitionAnalysisEvent": { + "description": "Represents the base for all Partition Analysis Events.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "Metadata": { + "$ref": "#/definitions/AnalysisEventMetadata", + "description": "Metadata about an Analysis Event." + } + }, + "required": [ + "Metadata" + ], + "x-ms-discriminator-value": "PartitionAnalysisEvent" + }, + "PartitionEvent": { + "description": "Represents the base for all Partition Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "PartitionId" + ], + "x-ms-discriminator-value": "PartitionEvent" + }, + "PartitionEventList": { + "description": "A list of PartitionEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/PartitionEvent" + } + }, + "PartitionHealth": { + "description": "Information about the health of a Service Fabric partition.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "ID of the partition whose health information is described by this object." + }, + "ReplicaHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthState" + }, + "description": "The list of replica health states associated with the partition." + } + } + }, + "PartitionHealthEvaluation": { + "x-ms-discriminator-value": "Partition", + "description": "Represents health evaluation for a partition, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the partition. The types of the unhealthy evaluations can be ReplicasHealthEvaluation or EventHealthEvaluation." + } + } + }, + "PartitionHealthState": { + "description": "Represents the health state of a partition, which contains the partition identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition whose health state is described by this object." + } + } + }, + "PartitionHealthStateChunk": { + "description": "Represents the health state chunk of a partition, which contains the partition ID, its aggregated health state and any replicas that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The Id of the partition." + }, + "ReplicaHealthStateChunks": { + "$ref": "#/definitions/ReplicaHealthStateChunkList", + "description": "The list of replica health state chunks belonging to the partition that respect the filters in the cluster health chunk query description." + } + } + }, + "PartitionHealthStateChunkList": { + "description": "The list of partition health state chunks that respect the input filters in the chunk query description.\nReturned by get cluster health state chunks query as part of the parent application hierarchy.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateChunk" + }, + "description": "The list of partition health state chunks that respect the input filters in the chunk query." + } + } + }, + "PartitionHealthStateFilter": { + "description": "Defines matching criteria to determine whether a partition should be included as a child of a service in the cluster health chunk.\nThe partitions are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple partitions, depending on its properties.", + "properties": { + "PartitionIdFilter": { + "type": "string", + "format": "uuid", + "description": "ID of the partition that matches the filter. The filter is applied only to the specified partition, if it exists.\nIf the partition doesn't exist, no partition is returned in the cluster health chunk based on this filter.\nIf the partition exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all partitions that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the partitions. It allows selecting partitions if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only partitions that match the filter are returned. All partitions are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the partition ID is specified. If the filter has default value and partition ID is specified, the matching partition is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches partitions with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "ReplicaFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateFilter" + }, + "description": "Defines a list of filters that specify which replicas to be included in the returned cluster health chunk as children of the parent partition. The replicas are returned only if the parent partition matches a filter.\nIf the list is empty, no replicas are returned. All the replicas are used to evaluate the parent partition aggregated health state, regardless of the input filters.\nThe partition filter may specify multiple replica filters.\nFor example, it can specify a filter to return all replicas with health state Error and another filter to always include a replica identified by its replica id." + } + } + }, + "PartitionId": { + "type": "string", + "format": "uuid", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "PartitionInformation": { + "discriminator": "ServicePartitionKind", + "description": "Information about the partition identity, partitioning scheme and keys supported by it.", + "required": [ + "ServicePartitionKind" + ], + "properties": { + "ServicePartitionKind": { + "$ref": "#/definitions/ServicePartitionKind", + "description": "The kind of partitioning scheme used to partition the service." + }, + "Id": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "ProvisionFabricDescription": { + "description": "Describes the parameters for provisioning a cluster.", + "properties": { + "CodeFilePath": { + "type": "string", + "description": "The cluster code package file path." + }, + "ClusterManifestFilePath": { + "type": "string", + "description": "The cluster manifest file path." + } + } + }, + "ProvisionApplicationTypeKind": { + "type": "string", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision.", + "enum": [ + "Invalid", + "ImageStorePath", + "ExternalStore" + ], + "x-ms-enum": { + "name": "ProvisionApplicationTypeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the provision kind is invalid. This value is default and should not be used. The value is zero." + }, + { + "value": "ImageStorePath", + "description": "Indicates that the provision is for a package that was previously uploaded to the image store. The value is 1." + }, + { + "value": "ExternalStore", + "description": "Indicates that the provision is for an application package that was previously uploaded to an external store. The application package ends with the extension *.sfpkg. The value is 2." + } + ] + } + }, + "ProvisionApplicationTypeDescriptionBase": { + "discriminator": "Kind", + "description": "Represents the type of registration or provision requested, and if the operation needs to be asynchronous or not. Supported types of provision operations are from either image store or external store.", + "properties": { + "Kind": { + "$ref": "#/definitions/ProvisionApplicationTypeKind", + "description": "The kind of application type registration or provision requested. The application package can be registered or provisioned either from the image store or from an external store. Following are the kinds of the application type provision." + }, + "Async": { + "type": "boolean", + "description": "Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true." + } + }, + "required": [ + "Kind", + "Async" + ] + }, + "ProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package uploaded to the Service Fabric image store.", + "required": [ + "ApplicationTypeBuildPath" + ], + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + } + ], + "properties": { + "ApplicationTypeBuildPath": { + "description": "The relative path for the application package in the image store specified during the prior upload operation.", + "type": "string" + }, + "ApplicationPackageCleanupPolicy": { + "$ref": "#/definitions/ApplicationPackageCleanupPolicy", + "description": "The kind of action that needs to be taken for cleaning up the application package after successful provision." + } + }, + "x-ms-discriminator-value": "ImageStorePath" + }, + "ExternalStoreProvisionApplicationTypeDescription": { + "description": "Describes the operation to register or provision an application type using an application package from an external store instead of a package uploaded to the Service Fabric image store.", + "allOf": [ + { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + } + ], + "properties": { + "ApplicationPackageDownloadUri": { + "description": "The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access.", + "type": "string" + }, + "ApplicationTypeName": { + "description": "The application type name represents the name of the application type found in the application manifest.", + "type": "string" + }, + "ApplicationTypeVersion": { + "description": "The application type version represents the version of the application type found in the application manifest.", + "type": "string" + } + }, + "x-ms-discriminator-value": "ExternalStore", + "required": [ + "ApplicationPackageDownloadUri", + "ApplicationTypeName", + "ApplicationTypeVersion" + ] + }, + "UnprovisionFabricDescription": { + "description": "Describes the parameters for unprovisioning a cluster.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code package version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster manifest version." + } + } + }, + "ResumeClusterUpgradeDescription": { + "description": "Describes the parameters for resuming a cluster upgrade.", + "properties": { + "UpgradeDomain": { + "type": "string", + "description": "The next upgrade domain for this cluster upgrade." + } + }, + "required": [ + "UpgradeDomain" + ] + }, + "StartClusterUpgradeDescription": { + "description": "Describes the parameters for starting a cluster upgrade.", + "properties": { + "CodeVersion": { + "type": "string", + "description": "The cluster code version." + }, + "ConfigVersion": { + "type": "string", + "description": "The cluster configuration version." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "UpdateClusterUpgradeDescription": { + "description": "Parameters for updating a cluster upgrade.", + "properties": { + "UpgradeKind": { + "$ref": "#/definitions/UpgradeType", + "description": "The type of upgrade out of the following possible values." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + } + }, + "SafetyCheckKind": { + "type": "string", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks.", + "enum": [ + "Invalid", + "EnsureSeedNodeQuorum", + "EnsurePartitionQuorum", + "WaitForPrimaryPlacement", + "WaitForPrimarySwap", + "WaitForReconfiguration", + "WaitForInbuildReplica", + "EnsureAvailability" + ], + "x-ms-enum": { + "name": "SafetyCheckKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the upgrade safety check kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "EnsureSeedNodeQuorum", + "description": "Indicates that if we bring down the node then this will result in global seed node quorum loss. The value is 1." + }, + { + "value": "EnsurePartitionQuorum", + "description": "Indicates that there is some partition for which if we bring down the replica on the node, it will result in quorum loss for that partition. The value is 2." + }, + { + "value": "WaitForPrimaryPlacement", + "description": "Indicates that there is some replica on the node that was moved out of this node due to upgrade. Service Fabric is now waiting for the primary to be moved back to this node. The value is 3." + }, + { + "value": "WaitForPrimarySwap", + "description": "Indicates that Service Fabric is waiting for a primary replica to be moved out of the node before starting upgrade on that node. The value is 4." + }, + { + "value": "WaitForReconfiguration", + "description": "Indicates that there is some replica on the node that is involved in a reconfiguration. Service Fabric is waiting for the reconfiguration to be complete before staring upgrade on that node. The value is 5." + }, + { + "value": "WaitForInbuildReplica", + "description": "Indicates that there is either a replica on the node that is going through copy, or there is a primary replica on the node that is copying data to some other replica. In both cases, bringing down the replica on the node due to upgrade will abort the copy. The value is 6." + }, + { + "value": "EnsureAvailability", + "description": "Indicates that there is either a stateless service partition on the node having exactly one instance, or there is a primary replica on the node for which the partition is quorum loss. In both cases, bringing down the replicas due to upgrade will result in loss of availability. The value is 7." + } + ] + } + }, + "SafetyCheck": { + "discriminator": "Kind", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "Kind": { + "$ref": "#/definitions/SafetyCheckKind", + "description": "The kind of safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state. Following are the kinds of safety checks." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionSafetyCheck": { + "description": "Represents a safety check for the service partition being performed by service fabric before continuing with operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition which is undergoing the safety check." + } + } + }, + "EnsureAvailabilitySafetyCheck": { + "description": "Safety check that waits to ensure the availability of the partition. It waits until there are replicas available such that bringing down this replica will not cause availability loss for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureAvailability" + }, + "EnsurePartitionQurumSafetyCheck": { + "description": "Safety check that ensures that a quorum of replicas are not lost for a partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsurePartitionQuorum" + }, + "SeedNodeSafetyCheck": { + "description": "Represents a safety check for the seed nodes being performed by service fabric before continuing with node level operations.", + "allOf": [ + { + "$ref": "#/definitions/SafetyCheck" + } + ], + "x-ms-discriminator-value": "EnsureSeedNodeQuorum" + }, + "PartitionsHealthEvaluation": { + "x-ms-discriminator-value": "Partitions", + "description": "Represents health evaluation for the partitions of a service, containing health evaluations for each unhealthy partition that impacts current aggregated health state. Can be returned when evaluating service health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy partitions per service from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of partitions of the service from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy PartitionHealthEvaluation that impacted the aggregated health." + } + } + }, + "ReplicaEvent": { + "description": "Represents the base for all Replica Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId_Integer", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + }, + "required": [ + "PartitionId", + "ReplicaId" + ], + "x-ms-discriminator-value": "ReplicaEvent" + }, + "ReplicaEventList": { + "description": "A list of ReplicaEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaEvent" + } + }, + "ReplicaHealth": { + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "discriminator": "ServiceKind", + "description": "Represents a base class for stateful service replica or stateless service instance health.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which this replica belongs." + } + }, + "required": [ + "ServiceKind" + ] + }, + "ReplicaHealthEvaluation": { + "x-ms-discriminator-value": "Replica", + "description": "Represents health evaluation for a replica, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition to which the replica belongs." + }, + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the replica. The types of the unhealthy evaluations can be EventHealthEvaluation." + } + } + }, + "ReplicaHealthState": { + "discriminator": "ServiceKind", + "required": [ + "ServiceKind" + ], + "description": "Represents a base class for stateful service replica or stateless service instance health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The ID of the partition to which this replica belongs." + } + } + }, + "ReplicaHealthStateChunk": { + "description": "Represents the health state chunk of a stateful service replica or a stateless service instance.\nThe replica health state contains the replica ID and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "ReplicaOrInstanceId": { + "$ref": "#/definitions/ReplicaOrInstanceId", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + } + } + }, + "ReplicaHealthStateChunkList": { + "description": "The list of replica health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ReplicaHealthStateChunk" + }, + "description": "The list of replica health state chunks that respect the input filters in the chunk query." + } + } + }, + "ReplicaHealthStateFilter": { + "description": "Defines matching criteria to determine whether a replica should be included as a child of a partition in the cluster health chunk.\nThe replicas are only returned if the parent entities match a filter specified in the cluster health chunk query description. The parent partition, service and application must be included in the cluster health chunk.\nOne filter can match zero, one or multiple replicas, depending on its properties.", + "properties": { + "ReplicaOrInstanceIdFilter": { + "type": "string", + "description": "Id of the stateful service replica or stateless service instance that matches the filter. The filter is applied only to the specified replica, if it exists.\nIf the replica doesn't exist, no replica is returned in the cluster health chunk based on this filter.\nIf the replica exists, it is included in the cluster health chunk if it respects the other filter properties.\nIf not specified, all replicas that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the replicas. It allows selecting replicas if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only replicas that match the filter are returned. All replicas are used to evaluate the parent partition aggregated health state.\nIf not specified, default value is None, unless the replica ID is specified. If the filter has default value and replica ID is specified, the matching replica is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches replicas with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + } + } + }, + "ReplicaId": { + "type": "string", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaId_Integer": { + "type": "integer", + "format": "int64", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "ReplicaOrInstanceId": { + "type": "string", + "description": "Id of a stateful service replica or a stateless service instance. This ID is used in the queries that apply to both stateful and stateless services. It is used by Service Fabric to uniquely identify a replica of a partition of a stateful service or an instance of a stateless service partition. It is unique within a partition and does not change for the lifetime of the replica or the instance. If a stateful replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the ID. If a stateless instance is failed over on the same or different node it will get a different value for the ID." + }, + "ReplicaInfo": { + "discriminator": "ServiceKind", + "description": "Information about the identity, status, health, node name, uptime, and other details about the replica.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ReplicaStatus": { + "$ref": "#/definitions/ReplicaStatus", + "description": "The status of a replica of a service." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "Address": { + "type": "string", + "description": "The address the replica is listening on." + }, + "LastInBuildDurationInSeconds": { + "type": "string", + "description": "The last in build duration of the replica in seconds." + } + } + }, + "ReplicaRole": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Primary", + "IdleSecondary", + "ActiveSecondary" + ], + "x-ms-enum": { + "name": "ReplicaRole", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the initial role that a replica is created in. The value is zero." + }, + { + "value": "None", + "description": "Specifies that the replica has no responsibility in regard to the replica set. The value is 1" + }, + { + "value": "Primary", + "description": "Refers to the replica in the set on which all read and write operations are complete in order to enforce strong consistency semantics. Read operations are handled directly by the Primary replica, while write operations must be acknowledged by a quorum of the replicas in the replica set. There can only be one Primary replica in a replica set at a time. The value is 2." + }, + { + "value": "IdleSecondary", + "description": "Refers to a replica in the set that receives a state transfer from the Primary replica to prepare for becoming an active Secondary replica. There can be multiple Idle Secondary replicas in a replica set at a time. Idle Secondary replicas do not count as a part of a write quorum. The value is 3." + }, + { + "value": "ActiveSecondary", + "description": "Refers to a replica in the set that receives state updates from the Primary replica, applies them, and sends acknowledgements back. Secondary replicas must participate in the write quorum for a replica set. There can be multiple active Secondary replicas in a replica set at a time. The number of active Secondary replicas is configurable that the reliability subsystem should maintain. The value is 4." + } + ] + } + }, + "ReplicasHealthEvaluation": { + "x-ms-discriminator-value": "Replicas", + "description": "Represents health evaluation for replicas, containing health evaluations for each unhealthy replica that impacted current aggregated health state. Can be returned when evaluating partition health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy replicas per partition from the ApplicationHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of replicas in the partition from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ReplicaHealthEvaluation that impacted the aggregated health." + } + } + }, + "ReplicaStatus": { + "type": "string", + "description": "The status of a replica of a service.", + "enum": [ + "Invalid", + "InBuild", + "Standby", + "Ready", + "Down", + "Dropped" + ], + "x-ms-enum": { + "name": "ReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the replica status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InBuild", + "description": "The replica is being built. This means that a primary replica is seeding this replica. The value is 1." + }, + { + "value": "Standby", + "description": "The replica is in standby. The value is 2." + }, + { + "value": "Ready", + "description": "The replica is ready. The value is 3." + }, + { + "value": "Down", + "description": "The replica is down. The value is 4." + }, + { + "value": "Dropped", + "description": "Replica is dropped. This means that the replica has been removed from the replica set. If it is persisted, its state has been deleted. The value is 5." + } + ] + } + }, + "RestartNodeDescription": { + "description": "Describes the parameters to restart a Service Fabric node.", + "properties": { + "NodeInstanceId": { + "type": "string", + "description": "The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of \"0\" would match any instance ID. The instance ID can be obtained using get node query.", + "default": "0" + }, + "CreateFabricDump": { + "type": "string", + "description": "Specify True to create a dump of the fabric node process. This is case-sensitive.", + "enum": [ + "False", + "True" + ], + "default": "False", + "x-ms-enum": { + "name": "CreateFabricDump", + "modelAsString": true, + "values": [ + { + "value": "False" + }, + { + "value": "True" + } + ] + } + } + }, + "required": [ + "NodeInstanceId" + ] + }, + "SafetyCheckInfoList": { + "type": "array", + "description": "List of pending safety checks", + "items": { + "$ref": "#/definitions/SafetyCheckWrapper" + } + }, + "SafetyCheckWrapper": { + "description": "A wrapper for the safety check object. Safety checks are performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state.", + "properties": { + "SafetyCheck": { + "$ref": "#/definitions/SafetyCheck", + "description": "Represents a safety check performed by service fabric before continuing with the operations. These checks ensure the availability of the service and the reliability of the state." + } + } + }, + "ServiceEvent": { + "description": "Represents the base for all Service Events.", + "allOf": [ + { + "$ref": "#/definitions/FabricEvent" + } + ], + "properties": { + "ServiceId": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + } + }, + "required": [ + "ServiceId" + ], + "x-ms-discriminator-value": "ServiceEvent" + }, + "ServiceEventList": { + "description": "A list of ServiceEvent objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEvent" + } + }, + "ServiceFromTemplateDescription": { + "description": "Defines description for creating a Service Fabric service from a template defined in the application manifest.", + "required": [ + "ApplicationName", + "ServiceName", + "ServiceTypeName" + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data for the newly created service instance." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + } + } + }, + "ServiceHealthEvaluation": { + "x-ms-discriminator-value": "Service", + "description": "Represents health evaluation for a service, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health evaluation is described by this object." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the service. The types of the unhealthy evaluations can be PartitionsHealthEvaluation or EventHealthEvaluation." + } + } + }, + "ServiceHealthState": { + "description": "Represents the health state of a service, which contains the service identifier and its aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthState" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Name of the service whose health state is represented by this object." + } + } + }, + "ServiceHealthStateChunk": { + "description": "Represents the health state chunk of a service, which contains the service name, its aggregated health state and any partitions that respect the filters in the cluster health chunk query description.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealthStateChunk" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health state chunk is provided in this object." + }, + "PartitionHealthStateChunks": { + "$ref": "#/definitions/PartitionHealthStateChunkList", + "description": "The list of partition health state chunks belonging to the service that respect the filters in the cluster health chunk query description." + } + } + }, + "ServiceHealthStateChunkList": { + "description": "The list of service health state chunks that respect the input filters in the chunk query. Returned by get cluster health state chunks query.", + "properties": { + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceHealthStateChunk" + }, + "description": "The list of service health state chunks that respect the input filters in the chunk query." + } + } + }, + "ServiceHealthStateFilter": { + "description": "Defines matching criteria to determine whether a service should be included as a child of an application in the cluster health chunk.\nThe services are only returned if the parent application matches a filter specified in the cluster health chunk query description.\nOne filter can match zero, one or multiple services, depending on its properties.", + "properties": { + "ServiceNameFilter": { + "type": "string", + "description": "The name of the service that matches the filter. The filter is applied only to the specified service, if it exists.\nIf the service doesn't exist, no service is returned in the cluster health chunk based on this filter.\nIf the service exists, it is included as the application's child if the health state matches the other filter properties.\nIf not specified, all services that match the parent filters (if any) are taken into consideration and matched against the other filter members, like health state filter." + }, + "HealthStateFilter": { + "type": "integer", + "default": 0, + "description": "The filter for the health state of the services. It allows selecting services if they match the desired health states.\nThe possible values are integer value of one of the following health states. Only services that match the filter are returned. All services are used to evaluate the cluster aggregated health state.\nIf not specified, default value is None, unless the service name is specified. If the filter has default value and service name is specified, the matching service is returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6, it matches services with HealthState value of OK (2) and Warning (4).\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535." + }, + "PartitionFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthStateFilter" + }, + "description": "Defines a list of filters that specify which partitions to be included in the returned cluster health chunk as children of the service. The partitions are returned only if the parent service matches a filter.\nIf the list is empty, no partitions are returned. All the partitions are used to evaluate the parent service aggregated health state, regardless of the input filters.\nThe service filter may specify multiple partition filters.\nFor example, it can specify a filter to return all partitions with health state Error and another filter to always include a partition identified by its partition ID." + } + } + }, + "ServiceHealth": { + "description": "Information about the health of a Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/EntityHealth" + } + ], + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service whose health information is described by this object." + }, + "PartitionHealthStates": { + "type": "array", + "items": { + "$ref": "#/definitions/PartitionHealthState" + }, + "description": "The list of partition health states associated with the service." + } + } + }, + "ServiceId": { + "type": "string", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceName": { + "type": "string", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceManifestName": { + "type": "string", + "description": "The name of the service manifest." + }, + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceInfo": { + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ManifestVersion": { + "description": "The version of the service manifest.", + "type": "string" + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "ServiceStatus": { + "$ref": "#/definitions/ServiceStatus", + "description": "The status of the application." + }, + "IsServiceGroup": { + "description": "Whether the service is in a service group.", + "type": "boolean" + } + }, + "required": [ + "ServiceKind" + ] + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Invalid", + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ServiceNameInfo": { + "description": "Information about the service name.", + "properties": { + "Id": { + "$ref": "#/definitions/ServiceId", + "description": "The identity of the service. This ID is an encoded representation of the service name. This is used in the REST APIs to identify the service resource.\nStarting in version 6.0, hierarchical names are delimited with the \"\\~\" character. For example, if the service name is \"fabric:/myapp/app1/svc1\",\nthe service identity would be \"myapp~app1\\~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + } + }, + "ServicePackageActivationId": { + "type": "string", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "ServicePartitionInfo": { + "discriminator": "ServiceKind", + "description": "Information about a partition of a Service Fabric service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "HealthState": { + "$ref": "#/definitions/HealthState", + "description": "The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc." + }, + "PartitionStatus": { + "$ref": "#/definitions/ServicePartitionStatus", + "description": "The status of the service fabric service partition." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition identity, partitioning scheme and keys supported by it." + } + } + }, + "ServicePartitionKind": { + "type": "string", + "description": "The kind of partitioning scheme used to partition the service.", + "enum": [ + "Invalid", + "Singleton", + "Int64Range", + "Named" + ], + "x-ms-enum": { + "name": "ServicePartitionKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that there is only one partition, and SingletonPartitionSchemeDescription was specified while creating the service. The value is 1." + }, + { + "value": "Int64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and UniformInt64RangePartitionSchemeDescription was specified while creating the service. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and NamedPartitionInformation was specified while creating the service. The value is 3." + } + ] + } + }, + "ServicePartitionStatus": { + "type": "string", + "description": "The status of the service fabric service partition.", + "enum": [ + "Invalid", + "Ready", + "NotReady", + "InQuorumLoss", + "Reconfiguring", + "Deleting" + ], + "x-ms-enum": { + "name": "ServicePartitionStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates that the partition is ready. This means that for a stateless service partition there is at least one instance that is up and for a stateful service partition the number of ready replicas is greater than or equal to the MinReplicaSetSize. The value is 1." + }, + { + "value": "NotReady", + "description": "Indicates that the partition is not ready. This status is returned when none of the other states apply. The value is 2." + }, + { + "value": "InQuorumLoss", + "description": "Indicates that the partition is in quorum loss. This means that number of replicas that are up and participating in a replica set is less than MinReplicaSetSize for this partition. The value is 3." + }, + { + "value": "Reconfiguring", + "description": "Indicates that the partition is undergoing reconfiguration of its replica sets. This can happen due to failover, upgrade, load balancing or addition or removal of replicas from the replica set. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the partition is being deleted. The value is 5." + } + ] + } + }, + "ServicePlacementInvalidDomainPolicyDescription": { + "x-ms-discriminator-value": "InvalidDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + ], + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + }, + "ServicePlacementNonPartiallyPlaceServicePolicyDescription": { + "x-ms-discriminator-value": "NonPartiallyPlaceService", + "description": "Describes the policy to be used for placement of a Service Fabric service where all replicas must be able to be placed in order for any replicas to be created.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + ] + }, + "ServicePlacementPolicyDescription": { + "discriminator": "Type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "Type" + ], + "properties": { + "Type": { + "$ref": "#/definitions/ServicePlacementPolicyType", + "description": "The type of placement policy for a service fabric service. Following are the possible values." + } + } + }, + "ServicePlacementPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "List of service placement policy descriptions." + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "Invalid", + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of the placement policy is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 1." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 2." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 3." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 4." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 5." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicyDescription": { + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's Primary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric cluster is geographically distributed in order to indicate that a service's primary replica should be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica may not end up located in this domain due to failures, capacity limits, or other constraints.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + ], + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequiredDomainPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomain", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + ], + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequireDomainDistributionPolicyDescription": { + "x-ms-discriminator-value": "RequiredDomainDistribution", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas from the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider a case where replicas are deployed across different data center, with one replica per location. In the event that one of the datacenters goes offline, normally the replica that was placed in that datacenter will be packed into one of the remaining datacenters. If this is not desirable then this policy should be set.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + } + ], + "properties": { + "DomainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicesHealthEvaluation": { + "x-ms-discriminator-value": "Services", + "description": "Represents health evaluation for services of a certain service type belonging to an application, containing health evaluations for each unhealthy service that impacted current aggregated health state. Can be returned when evaluating application health and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Name of the service type of the services." + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy services from the ServiceTypeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of services of the current service type in the application from the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy ServiceHealthEvaluation that impacted the aggregated health." + } + } + }, + "ServiceStatus": { + "type": "string", + "description": "The status of the application.", + "enum": [ + "Unknown", + "Active", + "Upgrading", + "Deleting", + "Creating", + "Failed" + ], + "x-ms-enum": { + "name": "ServiceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the service status is unknown. The value is zero." + }, + { + "value": "Active", + "description": "Indicates the service status is active. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the service is upgrading. The value is 2." + }, + { + "value": "Deleting", + "description": "Indicates the service is being deleted. The value is 3." + }, + { + "value": "Creating", + "description": "Indicates the service is being created. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates creation or deletion was terminated due to persistent failures. Another create/delete request can be accepted. The value is 5." + } + ] + } + }, + "ServiceTypeDescription": { + "discriminator": "Kind", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates whether the service type is a stateful service type or a stateless service type. This property is true if the service type is a stateful service type, false otherwise." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraint to be used when instantiating this service in a Service Fabric cluster." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPolicyDescriptionList", + "description": "List of service placement policy descriptions." + }, + "Extensions": { + "$ref": "#/definitions/ServiceTypeExtensionDescriptionList", + "description": "List of service type extensions." + } + } + }, + "ServiceTypeExtensionDescription": { + "description": "Describes extension of a service type defined in the service manifest.", + "properties": { + "Key": { + "type": "string", + "description": "The name of the extension." + }, + "Value": { + "type": "string", + "description": "The extension value." + } + } + }, + "ServiceTypeExtensionDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeExtensionDescription" + }, + "description": "List of service type extensions." + }, + "ServiceTypeHealthPolicy": { + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.", + "properties": { + "MaxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero.", + "default": 0 + }, + "MaxPercentUnhealthyServices": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero.", + "default": 0 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMapItem" + }, + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type. For example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently. With policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation." + }, + "ServiceTypeHealthPolicyMapItem": { + "description": "Defines an item in ServiceTypeHealthPolicyMap.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key of the service type health policy map item. This is the name of the service type." + }, + "Value": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The value of the service type health policy map item. This is the ServiceTypeHealthPolicy for this service type." + } + } + }, + "ServiceTypeInfo": { + "description": "Information about a service type that is defined in a service manifest of a provisioned application type.", + "properties": { + "ServiceTypeDescription": { + "$ref": "#/definitions/ServiceTypeDescription", + "description": "Describes a service type defined in the service manifest of a provisioned application type. The properties the ones defined in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "ServiceManifestVersion": { + "type": "string", + "description": "The version of the service manifest in which this service type is defined." + }, + "IsServiceGroup": { + "type": "boolean", + "description": "Indicates whether the service is a service group. If it is, the property value is true otherwise false." + } + } + }, + "ServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTypeInfo" + }, + "description": "List of service type information." + }, + "ServiceTypeManifest": { + "description": "Contains the manifest describing a service type registered as part of an application in a Service Fabric cluster.", + "properties": { + "Manifest": { + "type": "string", + "description": "The XML manifest as a string." + } + } + }, + "SingletonPartitionInformation": { + "description": "Information about a partition that is singleton. The services with singleton partitioning scheme are effectively non-partitioned. They only have one partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionInformation" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceInfo": { + "description": "Information about a stateful Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + } + ], + "properties": { + "HasPersistedState": { + "description": "Whether the service has persisted state.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "Stateful" + }, + "StatefulServicePartitionInfo": { + "description": "Information about a partition of a stateful Service Fabric service..", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int64", + "description": "The minimum replica set size as a number." + }, + "LastQuorumLossDuration": { + "type": "string", + "format": "duration", + "description": "The duration for which this partition was in quorum loss. If the partition is currently in quorum loss, it returns the duration since it has been in that state. This field is using ISO8601 format for specifying the duration." + }, + "PrimaryEpoch": { + "$ref": "#/definitions/Epoch", + "description": "An Epoch is a configuration number for the partition as a whole. When the configuration of the replica set changes, for example when the Primary replica changes, the operations that are replicated from the new Primary replica are said to be a new Epoch from the ones which were sent by the old Primary replica." + } + } + }, + "StatefulServiceReplicaHealth": { + "description": "Represents the health of the stateful service replica.\nContains the replica aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + } + ], + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + }, + "StatefulServiceReplicaHealthState": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents the health state of the stateful service replica, which contains the replica ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + } + ], + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + }, + "StatefulServiceTypeDescription": { + "description": "Describes a stateful service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + } + } + }, + "StatelessServiceInfo": { + "description": "Information about a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceInfo" + } + ], + "x-ms-discriminator-value": "Stateless" + }, + "StatelessServiceInstanceHealth": { + "description": "Represents the health of the stateless service instance.\nContains the instance aggregated health state, the health events and the unhealthy evaluations.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealth" + } + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + }, + "StatelessServiceInstanceHealthState": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents the health state of the stateless service instance, which contains the instance ID and the aggregated health state.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaHealthState" + } + ], + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of the stateless service instance on the wire this field is called ReplicaId." + } + } + }, + "StatelessServicePartitionInfo": { + "description": "Information about a partition of a stateless Service Fabric service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePartitionInfo" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "format": "int64", + "description": "Number of instances of this partition." + } + } + }, + "StatelessServiceTypeDescription": { + "description": "Describes a stateless service type defined in the service manifest of a provisioned application type.", + "allOf": [ + { + "$ref": "#/definitions/ServiceTypeDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "UseImplicitHost": { + "type": "boolean", + "description": "A flag indicating if this type is not implemented and hosted by a user service process, but is implicitly hosted by a system created process. This value is true for services using the guest executable services, false otherwise." + } + } + }, + "SystemApplicationHealthEvaluation": { + "x-ms-discriminator-value": "SystemApplication", + "description": "Represents health evaluation for the fabric:/System application, containing information about the data and the algorithm used by health store to evaluate health. The evaluation is returned only when the aggregated health state of the cluster is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the current aggregated health state of the system application. The types of the unhealthy evaluations can be DeployedApplicationsHealthEvaluation, ServicesHealthEvaluation or EventHealthEvaluation." + } + } + }, + "TargetApplicationName": { + "type": "string", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "TargetApplicationTypeVersion": { + "type": "string", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "TargetDeploymentName": { + "type": "string", + "description": "The name of the target deployment." + }, + "UnhealthyEvaluations": { + "description": "List of health evaluations that resulted in the current aggregated health state.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthEvaluationWrapper" + } + }, + "UpgradeDomainDeltaNodesCheckHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainDeltaNodesCheck", + "description": "Represents health evaluation for delta unhealthy cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state.\nCan be returned during cluster upgrade when cluster aggregated health state is Warning or Error.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "BaselineErrorCount": { + "type": "integer", + "format": "int64", + "description": "Number of upgrade domain nodes with aggregated heath state Error in the health store at the beginning of the cluster upgrade." + }, + "BaselineTotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store at the beginning of the cluster upgrade." + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of upgrade domain delta unhealthy nodes from the ClusterUpgradeHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of upgrade domain nodes in the health store." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + }, + "UpgradeDomainInfo": { + "description": "Information about an upgrade domain.", + "properties": { + "Name": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "State": { + "$ref": "#/definitions/UpgradeDomainState", + "description": "The state of the upgrade domain." + } + } + }, + "UpgradeDomainInfoList": { + "type": "array", + "description": "List of upgrade domains and their statuses.", + "items": { + "$ref": "#/definitions/UpgradeDomainInfo" + } + }, + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain" + }, + "UpgradeDomainNodesHealthEvaluation": { + "x-ms-discriminator-value": "UpgradeDomainNodes", + "description": "Represents health evaluation for cluster nodes in an upgrade domain, containing health evaluations for each unhealthy node that impacted current aggregated health state. Can be returned when evaluating cluster health during cluster upgrade and the aggregated health state is either Error or Warning.", + "allOf": [ + { + "$ref": "#/definitions/HealthEvaluation" + } + ], + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "Name of the upgrade domain where nodes health is currently evaluated." + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "Maximum allowed percentage of unhealthy nodes from the ClusterHealthPolicy." + }, + "TotalCount": { + "type": "integer", + "format": "int64", + "description": "Total number of nodes in the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of unhealthy evaluations that led to the aggregated health state. Includes all the unhealthy NodeHealthEvaluation that impacted the aggregated health." + } + } + }, + "UpgradeDomainState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "Pending", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "UpgradeDomainState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade domain state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Pending", + "description": "The upgrade domain has not started upgrading yet. The value is 1" + }, + { + "value": "InProgress", + "description": "The upgrade domain is being upgraded but not complete yet. The value is 2" + }, + { + "value": "Completed", + "description": "The upgrade domain has completed upgrade. The value is 3" + } + ] + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "UpgradeDuration": { + "type": "string", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "PT0H2M0S" + }, + "UpgradeKind": { + "type": "string", + "description": "The kind of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1" + } + ] + } + }, + "UpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored.", + "enum": [ + "Invalid", + "UnmonitoredAuto", + "UnmonitoredManual", + "Monitored" + ], + "default": "UnmonitoredAuto", + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade mode is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1" + }, + { + "value": "UnmonitoredManual", + "description": "The upgrade will stop after completing each upgrade domain, giving the opportunity to manually monitor health before proceeding. The value is 2" + }, + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 3" + } + ] + } + }, + "UpgradeType": { + "type": "string", + "description": "The type of upgrade out of the following possible values.", + "default": "Rolling", + "enum": [ + "Invalid", + "Rolling", + "Rolling_ForceRestart" + ], + "x-ms-enum": { + "name": "UpgradeType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Rolling", + "description": "The upgrade progresses one upgrade domain at a time. The value is 1." + }, + { + "value": "Rolling_ForceRestart", + "description": "The upgrade gets restarted by force. The value is 2." + } + ] + } + }, + "UpgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).", + "default": 42949672925 + }, + "UpgradeState": { + "type": "string", + "description": "The state of the upgrade domain.", + "enum": [ + "Invalid", + "RollingBackInProgress", + "RollingBackCompleted", + "RollingForwardPending", + "RollingForwardInProgress", + "RollingForwardCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 1" + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 2" + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 4" + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5" + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 6" + } + ] + } + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.", + "default": "P10675199DT02H48M05.4775807S" + }, + "WaitForInbuildReplicaSafetyCheck": { + "description": "Safety check that waits for the replica build operation to finish. This indicates that there is a replica that is going through the copy or is providing data for building another replica. Bring the node down will abort this copy operation which are typically expensive involving data movements.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForInbuildReplica" + }, + "WaitForPrimaryPlacementSafetyCheck": { + "description": "Safety check that waits for the primary replica that was moved out of the node due to upgrade to be placed back again on that node.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimaryPlacement" + }, + "WaitForPrimarySwapSafetyCheck": { + "description": "Safety check that waits for the primary replica to be moved out of the node before starting an upgrade to ensure the availability of the primary replica for the partition.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForPrimarySwap" + }, + "WaitForReconfigurationSafetyCheck": { + "description": "Safety check that waits for the current reconfiguration of the partition to be completed before starting an upgrade.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSafetyCheck" + } + ], + "x-ms-discriminator-value": "WaitForReconfiguration" + }, + "LoadMetricReport": { + "description": "Represents the load metric report which contains the time metric was reported, its name and value.", + "properties": { + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "Gets the UTC time when the load was reported." + }, + "Name": { + "type": "string", + "description": "The name of the load metric." + }, + "Value": { + "type": "string", + "format": "int32", + "description": "The value of the load metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue." + }, + "CurrentValue": { + "type": "string", + "format": "double", + "description": "The value of the load metric." + } + } + }, + "PartitionLoadInformation": { + "description": "Represents load information for a partition, which contains the primary and secondary reported load metrics.\nIn case there is no load reported, PartitionLoadInformation will contain the default load for the service of the partition.\nFor default loads, LoadMetricReport's LastReportedUtc is set to 0.", + "properties": { + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "Id of the partition." + }, + "PrimaryLoadMetricReports": { + "type": "array", + "description": "Array of load reports from the primary replica for this partition.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + }, + "SecondaryLoadMetricReports": { + "type": "array", + "description": "Array of aggregated load reports from all secondary replicas for this partition.\nArray only contains the latest reported load for each metric.", + "items": { + "$ref": "#/definitions/LoadMetricReport" + } + } + } + }, + "StatefulServiceReplicaInfo": { + "x-ms-discriminator-value": "Stateful", + "description": "Represents a stateful service replica. This includes information about the identity, role, status, health, node name, uptime, and other details about the replica.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + } + ], + "properties": { + "ReplicaRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + }, + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + } + } + }, + "StatelessServiceInstanceInfo": { + "x-ms-discriminator-value": "Stateless", + "description": "Represents a stateless service instance. This includes information about the identity, status, health, node name, uptime, and other details about the instance.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaInfo" + } + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + } + } + }, + "ClusterFabricCodeVersionString": { + "type": "string", + "description": "The ServiceFabric code version of the cluster." + }, + "ClusterFabricConfigVersionString": { + "type": "string", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "ClusterUpgradeDescriptionObject": { + "description": "Represents a ServiceFabric cluster upgrade", + "properties": { + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "EnableDeltaHealthEvaluation": { + "$ref": "#/definitions/DeltaHealthEvaluationBool", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Defines a health policy used to evaluate the health of the cluster or of a cluster node." + }, + "ClusterUpgradeHealthPolicy": { + "$ref": "#/definitions/ClusterUpgradeHealthPolicyObject", + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade." + }, + "ApplicationHealthPolicyMap": { + "$ref": "#/definitions/ApplicationHealthPolicyMap", + "description": "Defines a map that contains specific application health policies for different applications.\nEach entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health.\nIf an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest).\nThe map is empty by default." + } + } + }, + "ClusterUpgradeHealthPolicyObject": { + "description": "Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.", + "properties": { + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%.", + "maximum": 100, + "minimum": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%.", + "maximum": 100, + "minimum": 0 + } + } + }, + "ClusterUpgradeProgressObject": { + "description": "Information about a cluster upgrade.", + "properties": { + "CodeVersion": { + "$ref": "#/definitions/ClusterFabricCodeVersionString", + "description": "The ServiceFabric code version of the cluster." + }, + "ConfigVersion": { + "$ref": "#/definitions/ClusterFabricConfigVersionString", + "description": "The cluster configuration version (specified in the cluster manifest)." + }, + "UpgradeDomains": { + "$ref": "#/definitions/UpgradeDomainInfoList", + "description": "List of upgrade domains and their statuses." + }, + "UpgradeState": { + "$ref": "#/definitions/UpgradeState", + "description": "The state of the upgrade domain." + }, + "NextUpgradeDomain": { + "$ref": "#/definitions/NextUpgradeDomain", + "description": "The name of the next upgrade domain to be processed." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeDescription": { + "$ref": "#/definitions/ClusterUpgradeDescriptionObject", + "description": "Represents a ServiceFabric cluster upgrade" + }, + "UpgradeDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDurationString", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeDomainDurationInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainDurationString", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UnhealthyEvaluations": { + "$ref": "#/definitions/UnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "$ref": "#/definitions/UpgradeStartTimeUTCString", + "description": "The start time of the upgrade in UTC." + }, + "FailureTimestampUtc": { + "$ref": "#/definitions/UpgradeFailureTimeUTCString", + "description": "The failure time of the upgrade in UTC." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailedUpgradeDomainProgressObject", + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure." + } + } + }, + "ClusterConfigurationUpgradeDescription": { + "description": "Describes the parameters for a standalone cluster configuration upgrade.", + "properties": { + "ClusterConfig": { + "type": "string", + "description": "The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest)." + }, + "HealthCheckRetryTimeout": { + "type": "string", + "format": "duration", + "description": "The length of time between attempts to perform health checks if the application or cluster is not healthy.", + "default": "PT0H0M0S" + }, + "HealthCheckWaitDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time to wait after completing an upgrade domain before starting the health checks process.", + "default": "PT0H0M0S" + }, + "HealthCheckStableDurationInSeconds": { + "type": "string", + "format": "duration", + "description": "The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain.", + "default": "PT0H0M0S" + }, + "UpgradeDomainTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The timeout for the upgrade domain.", + "default": "PT0H0M0S" + }, + "UpgradeTimeoutInSeconds": { + "type": "string", + "format": "duration", + "description": "The upgrade timeout.", + "default": "PT0H0M0S" + }, + "MaxPercentUnhealthyApplications": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "MaxPercentUpgradeDomainDeltaUnhealthyNodes": { + "type": "integer", + "description": "The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100.", + "default": 0 + }, + "ApplicationHealthPolicies": { + "$ref": "#/definitions/ApplicationHealthPolicies", + "description": "Defines the application health policy map used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "ClusterConfig" + ] + }, + "DeltaHealthEvaluationBool": { + "type": "boolean", + "description": "When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain." + }, + "FailedUpgradeDomainProgressObject": { + "description": "The detailed upgrade progress for nodes in the current upgrade domain at the point of failure.", + "properties": { + "DomainName": { + "$ref": "#/definitions/UpgradeDomainName", + "description": "The name of the upgrade domain" + }, + "NodeUpgradeProgressList": { + "$ref": "#/definitions/NodeUpgradeProgressInfoList", + "description": "List of upgrading nodes and their statuses" + } + } + }, + "UpgradeDomainDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current upgrade domain." + }, + "UpgradeDurationString": { + "type": "string", + "description": "The estimated elapsed time spent processing the current overall upgrade." + }, + "UpgradeFailureTimeUTCString": { + "type": "string", + "description": "The failure time of the upgrade in UTC." + }, + "UpgradeStartTimeUTCString": { + "type": "string", + "description": "The start time of the upgrade in UTC." + }, + "UpgradeOrchestrationServiceState": { + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "properties": { + "ServiceState": { + "type": "string", + "description": "The state of Service Fabric Upgrade Orchestration Service." + } + } + }, + "UpgradeOrchestrationServiceStateSummary": { + "description": "Service state summary of Service Fabric Upgrade Orchestration Service.", + "properties": { + "CurrentCodeVersion": { + "type": "string", + "description": "The current code version of the cluster." + }, + "CurrentManifestVersion": { + "type": "string", + "description": "The current manifest version of the cluster." + }, + "TargetCodeVersion": { + "type": "string", + "description": "The target code version of the cluster." + }, + "TargetManifestVersion": { + "type": "string", + "description": "The target manifest version of the cluster." + }, + "PendingUpgradeType": { + "type": "string", + "description": "The type of the pending upgrade of the cluster." + } + } + }, + "ApplicationTypeImageStorePath": { + "description": "Path description for the application package in the image store specified during the prior copy operation.", + "required": [ + "ApplicationTypeBuildPath" + ], + "properties": { + "ApplicationTypeBuildPath": { + "type": "string", + "description": "The relative image store path to the application package." + } + } + }, + "UnprovisionApplicationTypeDescriptionInfo": { + "description": "Describes the operation to unregister or unprovision an application type and its version that was registered with the Service Fabric.", + "required": [ + "ApplicationTypeVersion" + ], + "properties": { + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "Async": { + "type": "boolean", + "description": "The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned." + } + } + }, + "CodePackageName": { + "type": "string", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageEntryPointStatistics": { + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "LastExitCode": { + "type": "string", + "description": "The last exit code of the entry point." + }, + "LastActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when Service Fabric attempted to run the entry point." + }, + "LastExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running." + }, + "LastSuccessfulActivationTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point ran successfully." + }, + "LastSuccessfulExitTime": { + "type": "string", + "format": "date-time", + "description": "The last time (in UTC) when the entry point finished running gracefully." + }, + "ActivationCount": { + "type": "string", + "description": "Number of times the entry point has run." + }, + "ActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to run." + }, + "ContinuousActivationFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to run." + }, + "ExitCount": { + "type": "string", + "description": "Number of times the entry point finished running." + }, + "ExitFailureCount": { + "type": "string", + "description": "Number of times the entry point failed to exit gracefully." + }, + "ContinuousExitFailureCount": { + "type": "string", + "description": "Number of times the entry point continuously failed to exit gracefully." + } + } + }, + "DeployedCodePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedCodePackageInfo" + }, + "description": "List of deployed code package information." + }, + "DeployedCodePackageInfo": { + "description": "Information about code package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package." + }, + "Version": { + "type": "string", + "description": "The version of the code package specified in service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "HostType": { + "$ref": "#/definitions/HostType", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest." + }, + "HostIsolationMode": { + "$ref": "#/definitions/HostIsolationMode", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "RunFrequencyInterval": { + "type": "string", + "description": "The interval at which code package is run. This is used for periodic code package." + }, + "SetupEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "MainEntryPoint": { + "$ref": "#/definitions/CodePackageEntryPoint", + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node." + } + } + }, + "DeploymentStatus": { + "type": "string", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node.", + "enum": [ + "Invalid", + "Downloading", + "Activating", + "Active", + "Upgrading", + "Deactivating" + ], + "x-ms-enum": { + "name": "DeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of the application or service package is not known or invalid. The value is 0." + }, + { + "value": "Downloading", + "description": "Indicates the application or service package is being downloaded to the node from the ImageStore. The value is 1." + }, + { + "value": "Activating", + "description": "Indicates the application or service package is being activated. The value is 2." + }, + { + "value": "Active", + "description": "Indicates the application or service package is active the node. The value is 3." + }, + { + "value": "Upgrading", + "description": "Indicates the application or service package is being upgraded. The value is 4." + }, + { + "value": "Deactivating", + "description": "Indicates the application or service package is being deactivated. The value is 5." + } + ] + } + }, + "EntryPointStatus": { + "type": "string", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node.", + "enum": [ + "Invalid", + "Pending", + "Starting", + "Started", + "Stopping", + "Stopped" + ], + "x-ms-enum": { + "name": "EntryPointStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates status of entry point is not known or invalid. The value is 0." + }, + { + "value": "Pending", + "description": "Indicates the entry point is scheduled to be started. The value is 1." + }, + { + "value": "Starting", + "description": "Indicates the entry point is being started. The value is 2." + }, + { + "value": "Started", + "description": "Indicates the entry point was started successfully and is running. The value is 3." + }, + { + "value": "Stopping", + "description": "Indicates the entry point is being stopped. The value is 4." + }, + { + "value": "Stopped", + "description": "Indicates the entry point is not running. The value is 5." + } + ] + } + }, + "CodePackageEntryPoint": { + "description": "Information about setup or main entry point of a code package deployed on a Service Fabric node.", + "properties": { + "EntryPointLocation": { + "type": "string", + "description": "The location of entry point executable on the node." + }, + "ProcessId": { + "type": "string", + "description": "The process ID of the entry point." + }, + "RunAsUserName": { + "type": "string", + "description": "The user name under which entry point executable is run on the node." + }, + "CodePackageEntryPointStatistics": { + "$ref": "#/definitions/CodePackageEntryPointStatistics", + "description": "Statistics about setup or main entry point of a code package deployed on a Service Fabric node." + }, + "Status": { + "$ref": "#/definitions/EntryPointStatus", + "description": "Specifies the status of the code package entry point deployed on a Service Fabric node." + }, + "NextActivationTime": { + "type": "string", + "format": "date-time", + "description": "The time (in UTC) when the entry point executable will be run next." + }, + "InstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + } + } + }, + "Chaos": { + "description": "Contains a description of Chaos.", + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "If Chaos is running, these are the parameters Chaos is running with." + }, + "Status": { + "$ref": "#/definitions/ChaosStatus", + "description": "Current status of the Chaos run." + }, + "ScheduleStatus": { + "$ref": "#/definitions/ChaosScheduleStatus", + "description": "Current status of the schedule." + } + } + }, + "ChaosStatus": { + "type": "string", + "description": "Current status of the Chaos run.", + "enum": [ + "Invalid", + "Running", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Running", + "description": "Indicates that Chaos is not stopped. The value is one." + }, + { + "value": "Stopped", + "description": "Indicates that Chaos is not scheduling further faults. The value is two." + } + ] + } + }, + "ChaosScheduleStatus": { + "type": "string", + "description": "Current status of the schedule.", + "enum": [ + "Invalid", + "Stopped", + "Active", + "Expired", + "Pending" + ], + "x-ms-enum": { + "name": "ChaosScheduleStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + }, + { + "value": "Stopped", + "description": "Indicates that the schedule is stopped and not being used to schedule runs of chaos. The value is one." + }, + { + "value": "Active", + "description": "Indicates that the schedule is active and is being used to schedule runs of Chaos. The value is two." + }, + { + "value": "Expired", + "description": "Indicates that the schedule is expired and will no longer be used to schedule runs of Chaos. The value is three." + }, + { + "value": "Pending", + "description": "Indicates that the schedule is pending and is not yet being used to schedule runs of Chaos but will be used when the start time is passed. The value is four." + } + ] + } + }, + "ChaosContextMap": { + "additionalProperties": { + "type": "string" + }, + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + }, + "ChaosContext": { + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run.", + "properties": { + "Map": { + "$ref": "#/definitions/ChaosContextMap", + "description": "Describes a map that contains a collection of ChaosContextMapItem's." + } + } + }, + "ChaosParameters": { + "description": "Defines all the parameters to configure a Chaos run.", + "properties": { + "TimeToRunInSeconds": { + "type": "string", + "description": "Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue).", + "default": "4294967295" + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities.\nDuring validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event.", + "default": 60, + "minimum": 0, + "maximum": 4294967295 + }, + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration.\nChaos executes in iterations and two consecutive iterations are separated by a validation phase.\nThe higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs.\nThe recommendation is to start with a value of 2 or 3 and to exercise caution while moving up.", + "default": 1, + "minimum": 0, + "maximum": 4294967295 + }, + "EnableMoveReplicaFaults": { + "type": "boolean", + "description": "Enables or disables the move primary and move secondary faults.", + "default": true + }, + "WaitTimeBetweenFaultsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Wait time (in seconds) between consecutive faults within a single iteration.\nThe larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through.\nThe recommendation is to start with a value between 1 and 5 and exercise caution while moving up.", + "default": 20, + "minimum": 0, + "maximum": 4294967295 + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "integer", + "format": "int64", + "description": "Time-separation (in seconds) between two consecutive iterations of Chaos.\nThe larger the value, the lower the fault injection rate.", + "default": 30, + "minimum": 0, + "maximum": 4294967295 + }, + "ClusterHealthPolicy": { + "$ref": "#/definitions/ClusterHealthPolicy", + "description": "Passed-in cluster health policy is used to validate health of the cluster in between Chaos iterations. If the cluster health is in error or if an unexpected exception happens during fault execution--to provide the cluster with some time to recuperate--Chaos will wait for 30 minutes before the next health-check." + }, + "Context": { + "$ref": "#/definitions/ChaosContext", + "description": "Describes a map, which is a collection of (string, string) type key-value pairs. The map can be used to record information about\nthe Chaos run. There cannot be more than 100 such pairs and each string (key or value) can be at most 4095 characters long.\nThis map is set by the starter of the Chaos run to optionally store the context about the specific run." + }, + "ChaosTargetFilter": { + "$ref": "#/definitions/ChaosTargetFilter", + "description": "List of cluster entities to target for Chaos faults.\nThis filter can be used to target Chaos faults only to certain node types or only to certain application instances. If ChaosTargetFilter is not used, Chaos faults all cluster entities.\nIf ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter specification." + } + } + }, + "ChaosParametersDictionaryItem": { + "description": "Defines an item in ChaosParametersDictionary of the Chaos Schedule.", + "required": [ + "Key", + "Value" + ], + "properties": { + "Key": { + "type": "string", + "description": "The key identifying the Chaos Parameter in the dictionary. This key is referenced by Chaos Schedule Jobs." + }, + "Value": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + }, + "ChaosEvent": { + "discriminator": "Kind", + "description": "Represents an event generated during a Chaos run.", + "properties": { + "Kind": { + "$ref": "#/definitions/ChaosEventKind", + "description": "The kind of Chaos event." + }, + "TimeStampUtc": { + "type": "string", + "description": "The UTC timestamp when this Chaos event was generated.", + "format": "date-time" + } + }, + "required": [ + "Kind", + "TimeStampUtc" + ] + }, + "ChaosEventWrapper": { + "description": "Wrapper object for Chaos event.", + "properties": { + "ChaosEvent": { + "$ref": "#/definitions/ChaosEvent", + "description": "Represents an event generated during a Chaos run." + } + } + }, + "ChaosEventKind": { + "type": "string", + "description": "The kind of Chaos event.", + "enum": [ + "Invalid", + "Started", + "ExecutingFaults", + "Waiting", + "ValidationFailed", + "TestError", + "Stopped" + ], + "x-ms-enum": { + "name": "ChaosEventKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid Chaos event kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Started", + "description": "Indicates a Chaos event that gets generated when Chaos is started." + }, + { + "value": "ExecutingFaults", + "description": "Indicates a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings." + }, + { + "value": "Waiting", + "description": "Indicates a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish." + }, + { + "value": "ValidationFailed", + "description": "Indicates a Chaos event that gets generated when the cluster entities do not become stable and healthy within ChaosParameters.MaxClusterStabilizationTimeoutInSeconds." + }, + { + "value": "TestError", + "description": "Indicates a Chaos event that gets generated when an unexpected event has occurred in the Chaos engine, for example, due to the cluster snapshot being inconsistent, while faulting a faultable entity Chaos found that the entity was already faulted." + }, + { + "value": "Stopped", + "description": "Indicates a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up." + } + ] + } + }, + "ChaosEventsSegment": { + "description": "Contains the list of Chaos events and the continuation token to get the next segment.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "History": { + "$ref": "#/definitions/ChaosEventHistory", + "description": "List of Chaos events that meet the user-supplied criteria." + } + } + }, + "ChaosScheduleDescription": { + "description": "Defines the Chaos Schedule used by Chaos and the version of the Chaos Schedule. The version value wraps back to 0 after surpassing 2,147,483,647.", + "properties": { + "Version": { + "description": "The version number of the Schedule.", + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "Schedule": { + "$ref": "#/definitions/ChaosSchedule", + "description": "Defines the schedule used by Chaos." + } + } + }, + "ChaosSchedule": { + "description": "Defines the schedule used by Chaos.", + "properties": { + "StartDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will start using this schedule.", + "default": "1601-01-01T00:00:00Z" + }, + "ExpiryDate": { + "type": "string", + "format": "date-time", + "description": "The date and time Chaos will continue to use this schedule until.", + "default": "9999-12-31T23:59:59.999Z" + }, + "ChaosParametersDictionary": { + "type": "array", + "description": "A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs.", + "items": { + "$ref": "#/definitions/ChaosParametersDictionaryItem" + } + }, + "Jobs": { + "description": "A list of all Chaos Schedule Jobs that will be automated by the schedule.", + "type": "array", + "items": { + "$ref": "#/definitions/ChaosScheduleJob" + } + } + } + }, + "ChaosScheduleJob": { + "description": "Defines a repetition rule and parameters of Chaos to be used with the Chaos Schedule.", + "properties": { + "ChaosParameters": { + "type": "string", + "description": "A reference to which Chaos Parameters of the Chaos Schedule to use." + }, + "Days": { + "$ref": "#/definitions/ChaosScheduleJobActiveDaysOfWeek", + "description": "Defines the days of the week that a Chaos Schedule Job will run for." + }, + "Times": { + "description": "A list of Time Ranges that specify when during active days that this job will run. The times are interpreted as UTC.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeRange" + } + } + } + }, + "ChaosScheduleJobActiveDaysOfWeek": { + "description": "Defines the days of the week that a Chaos Schedule Job will run for.", + "properties": { + "Sunday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Sunday", + "default": false + }, + "Monday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Monday", + "default": false + }, + "Tuesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Tuesday", + "default": false + }, + "Wednesday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Wednesday", + "default": false + }, + "Thursday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Thursday", + "default": false + }, + "Friday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Friday", + "default": false + }, + "Saturday": { + "type": "boolean", + "description": "Indicates if the Chaos Schedule Job will run on Saturday", + "default": false + } + } + }, + "TimeRange": { + "description": "Defines a time range in a 24 hour day specified by a start and end time.", + "properties": { + "StartTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + }, + "EndTime": { + "$ref": "#/definitions/TimeOfDay", + "description": "Defines an hour and minute of the day specified in 24 hour time." + } + } + }, + "TimeOfDay": { + "description": "Defines an hour and minute of the day specified in 24 hour time.", + "properties": { + "Hour": { + "type": "integer", + "format": "int32", + "description": "Represents the hour of the day. Value must be between 0 and 23 inclusive.", + "minimum": 0, + "maximum": 23 + }, + "Minute": { + "type": "integer", + "format": "int32", + "description": "Represents the minute of the hour. Value must be between 0 to 59 inclusive.", + "minimum": 0, + "maximum": 59 + } + } + }, + "ExecutingFaultsChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos has decided on the faults for an iteration. This Chaos event contains the details of the faults as a list of strings.", + "x-ms-discriminator-value": "ExecutingFaults", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "Faults": { + "type": "array", + "description": "List of string description of the faults that Chaos decided to execute in an iteration.", + "items": { + "type": "string" + } + } + } + }, + "StartedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is started.", + "x-ms-discriminator-value": "Started", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "ChaosParameters": { + "$ref": "#/definitions/ChaosParameters", + "description": "Defines all the parameters to configure a Chaos run." + } + } + }, + "StoppedChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos stops because either the user issued a stop or the time to run was up.", + "x-ms-discriminator-value": "Stopped", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "Reason": { + "type": "string", + "description": "Describes why Chaos stopped. Chaos can stop because of StopChaos API call or the timeToRun provided in ChaosParameters is over." + } + } + }, + "TestErrorChaosEvent": { + "description": "Describes a Chaos event that gets generated when an unexpected event occurs in the Chaos engine.\nFor example, due to the cluster snapshot being inconsistent, while faulting an entity, Chaos found that the entity was already faulted -- which would be an unexpected event.", + "x-ms-discriminator-value": "TestError", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "Reason": { + "type": "string", + "description": "Describes why TestErrorChaosEvent was generated. For example, Chaos tries to fault a partition but finds that the partition is no longer fault tolerant, then a TestErrorEvent gets generated with the reason stating that the partition is not fault tolerant." + } + } + }, + "ValidationFailedChaosEvent": { + "description": "Chaos event corresponding to a failure during validation.", + "x-ms-discriminator-value": "ValidationFailed", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the ValidationFailedChaosEvent was generated. This may happen because more than MaxPercentUnhealthyNodes are unhealthy for more than MaxClusterStabilizationTimeout. This reason will be in the Reason property of the ValidationFailedChaosEvent as a string." + } + } + }, + "WaitingChaosEvent": { + "description": "Describes a Chaos event that gets generated when Chaos is waiting for the cluster to become ready for faulting, for example, Chaos may be waiting for the on-going upgrade to finish.", + "x-ms-discriminator-value": "Waiting", + "allOf": [ + { + "$ref": "#/definitions/ChaosEvent" + } + ], + "properties": { + "Reason": { + "type": "string", + "description": "Describes why the WaitingChaosEvent was generated, for example, due to a cluster upgrade." + } + } + }, + "ChaosEventHistory": { + "type": "array", + "description": "An list of Chaos events that were generated during the time range passed into the GetChaosReport API call.", + "items": { + "$ref": "#/definitions/ChaosEventWrapper" + } + }, + "ChaosTargetFilter": { + "description": "Defines all filters for targeted Chaos faults, for example, faulting only certain node types or faulting only certain applications.\nIf ChaosTargetFilter is not used, Chaos faults all cluster entities. If ChaosTargetFilter is used, Chaos faults only the entities that meet the ChaosTargetFilter\nspecification. NodeTypeInclusionList and ApplicationInclusionList allow a union semantics only. It is not possible to specify an intersection\nof NodeTypeInclusionList and ApplicationInclusionList. For example, it is not possible to specify \"fault this application only when it is on that node type.\"\nOnce an entity is included in either NodeTypeInclusionList or ApplicationInclusionList, that entity cannot be excluded using ChaosTargetFilter. Even if\napplicationX does not appear in ApplicationInclusionList, in some Chaos iteration applicationX can be faulted because it happens to be on a node of nodeTypeY that is included\nin NodeTypeInclusionList. If both NodeTypeInclusionList and ApplicationInclusionList are null or empty, an ArgumentException is thrown.", + "properties": { + "NodeTypeInclusionList": { + "type": "array", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "ApplicationInclusionList": { + "type": "array", + "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "items": { + "$ref": "#/definitions/ApplicationName" + } + } + } + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest." + }, + "ApplicationCapacityDescription": { + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application", + "properties": { + "MinimumNodes": { + "type": "integer", + "format": "int64", + "description": "The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property.", + "minimum": 0 + }, + "MaximumNodes": { + "type": "integer", + "format": "int64", + "description": "The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node.", + "minimum": 0, + "default": 0 + }, + "ApplicationMetrics": { + "$ref": "#/definitions/ApplicationMetricDescriptionList", + "description": "List of application capacity metric description." + } + } + }, + "ApplicationDescription": { + "description": "Describes a Service Fabric application.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "TypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "TypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "ParameterList": { + "$ref": "#/definitions/ApplicationParameterList", + "description": "List of application parameters with overridden values from their default values specified in the application manifest." + }, + "ApplicationCapacity": { + "$ref": "#/definitions/ApplicationCapacityDescription", + "description": "Describes capacity information for services of this application. This description can be used for describing the following.\n- Reserving the capacity for the services on the nodes\n- Limiting the total number of nodes that services of this application can run on\n- Limiting the custom capacity metrics to limit the total consumption of this metric by the services of this application" + } + }, + "required": [ + "Name", + "TypeName", + "TypeVersion" + ] + }, + "ApplicationMetricDescription": { + "description": "Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "MaximumCapacity": { + "type": "integer", + "format": "int64", + "description": "The maximum node capacity for Service Fabric application.\nThis is the maximum Load for an instance of this application on a single node. Even if the capacity of node is greater than this value, Service Fabric will limit the total load of services within the application on each node to this value.\nIf set to zero, capacity for this metric is unlimited on each node.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity.\nWhen updating existing application with application capacity, the product of MaximumNodes and this value must always be smaller than or equal to TotalApplicationCapacity." + }, + "ReservationCapacity": { + "type": "integer", + "format": "int64", + "description": "The node reservation capacity for Service Fabric application.\nThis is the amount of load which is reserved on nodes which have instances of this application.\nIf MinimumNodes is specified, then the product of these values will be the capacity reserved in the cluster for the application.\nIf set to zero, no capacity is reserved for this metric.\nWhen setting application capacity or when updating application capacity; this value must be smaller than or equal to MaximumCapacity for each metric." + }, + "TotalApplicationCapacity": { + "description": "The total metric capacity for Service Fabric application.\nThis is the total metric capacity for this application in the cluster. Service Fabric will try to limit the sum of loads of services within the application to this value.\nWhen creating a new application with application capacity defined, the product of MaximumNodes and MaximumCapacity must always be smaller than or equal to this value.", + "type": "integer", + "format": "int64" + } + } + }, + "ApplicationMetricDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationMetricDescription" + }, + "description": "List of application capacity metric description." + }, + "ComposeDeploymentStatus": { + "type": "string", + "description": "The status of the compose deployment.", + "enum": [ + "Invalid", + "Provisioning", + "Creating", + "Ready", + "Unprovisioning", + "Deleting", + "Failed", + "Upgrading" + ], + "x-ms-enum": { + "name": "ComposeDeploymentStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the compose deployment status is invalid. The value is zero." + }, + { + "value": "Provisioning", + "description": "Indicates that the compose deployment is being provisioned in background. The value is 1." + }, + { + "value": "Creating", + "description": "Indicates that the compose deployment is being created in background. The value is 2." + }, + { + "value": "Ready", + "description": "Indicates that the compose deployment has been successfully created or upgraded. The value is 3." + }, + { + "value": "Unprovisioning", + "description": "Indicates that the compose deployment is being unprovisioned in background. The value is 4." + }, + { + "value": "Deleting", + "description": "Indicates that the compose deployment is being deleted in background. The value is 5." + }, + { + "value": "Failed", + "description": "Indicates that the compose deployment was terminated due to persistent failures. The value is 6." + }, + { + "value": "Upgrading", + "description": "Indicates that the compose deployment is being upgraded in the background. The value is 7." + } + ] + } + }, + "ComposeDeploymentStatusInfo": { + "description": "Information about a Service Fabric compose deployment.", + "properties": { + "Name": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "Status": { + "$ref": "#/definitions/ComposeDeploymentStatus", + "description": "The status of the compose deployment." + }, + "StatusDetails": { + "description": "The status details of compose deployment including failure message.", + "type": "string" + } + } + }, + "ComposeDeploymentUpgradeDescription": { + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent", + "UpgradeKind" + ] + }, + "ComposeDeploymentUpgradeProgressInfo": { + "description": "Describes the parameters for a compose deployment upgrade.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/TargetDeploymentName", + "description": "The name of the target deployment." + }, + "ApplicationName": { + "$ref": "#/definitions/TargetApplicationName", + "description": "The name of the target application, including the 'fabric:' URI scheme." + }, + "UpgradeState": { + "$ref": "#/definitions/ComposeDeploymentUpgradeState", + "description": "The state of the compose deployment upgrade." + }, + "UpgradeStatusDetails": { + "type": "string", + "description": "Additional detailed information about the status of the pending upgrade." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "UpgradeReplicaSetCheckTimeoutInSeconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "MonitoringPolicy": { + "$ref": "#/definitions/MonitoringPolicyDescription", + "description": "Describes the parameters for monitoring an upgrade in Monitored mode." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "TargetApplicationTypeVersion": { + "$ref": "#/definitions/TargetApplicationTypeVersion", + "description": "The target application type version (found in the application manifest) for the application upgrade." + }, + "UpgradeDuration": { + "$ref": "#/definitions/UpgradeDuration", + "description": "The estimated amount of time that the overall upgrade elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "CurrentUpgradeDomainDuration": { + "$ref": "#/definitions/CurrentUpgradeDomainDuration", + "description": "The estimated amount of time spent processing current Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "ApplicationUnhealthyEvaluations": { + "$ref": "#/definitions/ApplicationUnhealthyEvaluations", + "description": "List of health evaluations that resulted in the current aggregated health state." + }, + "CurrentUpgradeDomainProgress": { + "$ref": "#/definitions/CurrentUpgradeDomainProgressInfo", + "description": "Information about the current in-progress upgrade domain." + }, + "StartTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade started." + }, + "FailureTimestampUtc": { + "type": "string", + "description": "The estimated UTC datetime when the upgrade failed and FailureAction was executed." + }, + "FailureReason": { + "$ref": "#/definitions/FailureReason", + "description": "The cause of an upgrade failure that resulted in FailureAction being executed." + }, + "UpgradeDomainProgressAtFailure": { + "$ref": "#/definitions/FailureUpgradeDomainProgressInfo", + "description": "Information about the upgrade domain progress at the time of upgrade failure." + }, + "ApplicationUpgradeStatusDetails": { + "type": "string", + "description": "Additional details of application upgrade including failure message." + } + } + }, + "ComposeDeploymentUpgradeState": { + "type": "string", + "description": "The state of the compose deployment upgrade.", + "enum": [ + "Invalid", + "ProvisioningTarget", + "RollingForwardInProgress", + "RollingForwardPending", + "UnprovisioningCurrent", + "RollingForwardCompleted", + "RollingBackInProgress", + "UnprovisioningTarget", + "RollingBackCompleted", + "Failed" + ], + "x-ms-enum": { + "name": "ComposeDeploymentUpgradeState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the upgrade state is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "ProvisioningTarget", + "description": "The upgrade is in the progress of provisioning target application type version. The value is 1." + }, + { + "value": "RollingForwardInProgress", + "description": "The upgrade is rolling forward to the target version but is not complete yet. The value is 2." + }, + { + "value": "RollingForwardPending", + "description": "The current upgrade domain has finished upgrading. The overall upgrade is waiting for an explicit move next request in UnmonitoredManual mode or performing health checks in Monitored mode. The value is 3" + }, + { + "value": "UnprovisioningCurrent", + "description": "The upgrade is in the progress of unprovisioning current application type version and rolling forward to the target version is completed. The value is 4." + }, + { + "value": "RollingForwardCompleted", + "description": "The upgrade has finished rolling forward. The value is 5." + }, + { + "value": "RollingBackInProgress", + "description": "The upgrade is rolling back to the previous version but is not complete yet. The value is 6." + }, + { + "value": "UnprovisioningTarget", + "description": "The upgrade is in the progress of unprovisioning target application type version and rolling back to the current version is completed. The value is 7." + }, + { + "value": "RollingBackCompleted", + "description": "The upgrade has finished rolling back. The value is 8." + }, + { + "value": "Failed", + "description": "The upgrade has failed and is unable to execute FailureAction. The value is 9." + } + ] + } + }, + "PagedComposeDeploymentStatusInfoList": { + "description": "The list of compose deployments in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of compose deployment status information.", + "items": { + "$ref": "#/definitions/ComposeDeploymentStatusInfo" + } + } + } + }, + "CreateComposeDeploymentDescription": { + "description": "Defines description for creating a Service Fabric compose deployment.", + "properties": { + "DeploymentName": { + "$ref": "#/definitions/DeploymentName", + "description": "The name of the deployment." + }, + "ComposeFileContent": { + "type": "string", + "description": "The content of the compose file that describes the deployment to create." + }, + "RegistryCredential": { + "$ref": "#/definitions/RegistryCredential", + "description": "Credential information to connect to container registry." + } + }, + "required": [ + "DeploymentName", + "ComposeFileContent" + ] + }, + "RegistryCredential": { + "description": "Credential information to connect to container registry.", + "properties": { + "RegistryUserName": { + "type": "string", + "description": "The user name to connect to container registry." + }, + "RegistryPassword": { + "type": "string", + "description": "The password for supplied username to connect to container registry." + }, + "PasswordEncrypted": { + "type": "boolean", + "description": "Indicates that supplied container registry password is encrypted." + } + } + }, + "DeployedServicePackageInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServicePackageInfo" + }, + "description": "List of deployed service package information." + }, + "DeployedServicePackageInfo": { + "description": "Information about service package deployed on a Service Fabric node.", + "properties": { + "Name": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service package as specified in the service manifest." + }, + "Version": { + "type": "string", + "description": "The version of the service package specified in service manifest." + }, + "Status": { + "$ref": "#/definitions/DeploymentStatus", + "description": "Specifies the status of a deployed application or service package on a Service Fabric node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeploymentName": { + "type": "string", + "description": "The name of the deployment." + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelationDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Invalid", + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the partition kind is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionSchemeDescription object, The value is 1." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionSchemeDescription object. The value is 2." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionSchemeDescription object. The value is 3" + } + ] + } + }, + "ServiceCorrelationDescription": { + "description": "Creates a particular correlation between services.", + "required": [ + "Scheme", + "ServiceName" + ], + "properties": { + "Scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "Invalid", + "Affinity", + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "An invalid correlation scheme. Cannot be used. The value is zero." + }, + { + "value": "Affinity", + "description": "Indicates that this service has an affinity relationship with another service. Provided for backwards compatibility, consider preferring the Aligned or NonAlignedAffinity options. The value is 1." + }, + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 2." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 3." + } + ] + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetricDescription" + }, + "description": "The service load metrics is given as an array of ServiceLoadMetricDescription objects." + }, + "ServiceLoadMetricDescription": { + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "Name" + ], + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case-sensitive." + }, + "Weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "PrimaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "SecondaryDefaultLoad": { + "type": "integer", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "DefaultLoad": { + "type": "integer", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServicePackageActivationMode": { + "type": "string", + "description": "The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service.", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "This is the default activation mode. With this activation mode, replicas or instances from different partition(s) of service, on a given node, will share same activation of service package on a node. The value is zero." + }, + { + "value": "ExclusiveProcess", + "description": "With this activation mode, each replica or instance of service, on a given node, will have its own dedicated activation of service package on a node. The value is 1." + } + ] + } + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicyDescription" + }, + "description": "A list that describes the correlation of the service with other services." + }, + "PartitionSchemeDescription": { + "discriminator": "PartitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "PartitionScheme" + ], + "properties": { + "PartitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "NamedPartitionSchemeDescription": { + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "Count", + "Names" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "Names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of size specified by the ‘Count’ parameter, for the names of the partitions." + } + } + }, + "SingletonPartitionSchemeDescription": { + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "UniformInt64RangePartitionSchemeDescription": { + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/PartitionSchemeDescription" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "Count", + "LowKey", + "HighKey" + ], + "properties": { + "Count": { + "type": "integer", + "description": "The number of partitions." + }, + "LowKey": { + "type": "string", + "description": "String indicating the lower bound of the partition key range that\nshould be split between the partitions." + }, + "HighKey": { + "type": "string", + "description": "String indicating the upper bound of the partition key range that\nshould be split between the partitions." + } + } + }, + "ServiceDescription": { + "discriminator": "ServiceKind", + "description": "A ServiceDescription contains all of the information necessary to create a service.", + "required": [ + "ServiceKind", + "ServiceName", + "ServiceTypeName", + "PartitionDescription" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "InitializationData": { + "$ref": "#/definitions/ByteArray", + "description": "The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created." + }, + "PartitionDescription": { + "$ref": "#/definitions/PartitionSchemeDescription", + "description": "The partition description as an object." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "ServiceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "IsDefaultMoveCostSpecified": { + "type": "boolean", + "description": "Indicates if the DefaultMoveCost property is specified." + }, + "ServicePackageActivationMode": { + "$ref": "#/definitions/ServicePackageActivationMode", + "description": "The activation mode of service package to be used for a service." + }, + "ServiceDnsName": { + "type": "string", + "description": "The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceDescription": { + "description": "Describes a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "required": [ + "TargetReplicaSetSize", + "MinReplicaSetSize", + "HasPersistedState" + ], + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "HasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "Flags": { + "type": "integer", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceDescription": { + "description": "Describes a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "InstanceCount" + ], + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ReplicatorQueueStatus": { + "description": "Provides various statistics of the queue used in the service fabric replicator.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.\nDepending on the role of the replicator, the properties in this type imply different meanings.", + "properties": { + "QueueUtilizationPercentage": { + "type": "integer", + "format": "int32", + "description": "Represents the utilization of the queue. A value of 0 indicates that the queue is empty and a value of 100 indicates the queue is full." + }, + "QueueMemorySize": { + "type": "string", + "description": "Represents the virtual memory consumed by the queue in bytes." + }, + "FirstSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is the smallest sequence number of the operation that is present in the queue." + }, + "CompletedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which all the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number that has been applied to the persistent state." + }, + "CommittedSequenceNumber": { + "type": "string", + "description": "On a primary replicator, this is semantically the highest sequence number of the operation for which a write quorum of the secondary replicas have sent an acknowledgement.\nOn a secondary replicator, this is semantically the highest sequence number of the in-order operation received from the primary." + }, + "LastSequenceNumber": { + "type": "string", + "description": "Represents the latest sequence number of the operation that is available in the queue." + } + } + }, + "ReplicatorStatus": { + "discriminator": "Kind", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaRole", + "description": "The role of a replica of a stateful service." + } + } + }, + "PrimaryReplicatorStatus": { + "x-ms-discriminator-value": "Primary", + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a Primary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + } + ], + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the primary replicator." + }, + "RemoteReplicators": { + "$ref": "#/definitions/RemoteReplicatorStatusList", + "description": "The status of all the active and idle secondary replicators that the primary is aware of." + } + } + }, + "SecondaryReplicatorStatus": { + "description": "Provides statistics about the Service Fabric Replicator, when it is functioning in a ActiveSecondary role.", + "allOf": [ + { + "$ref": "#/definitions/ReplicatorStatus" + } + ], + "properties": { + "ReplicationQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the replication queue on the secondary replicator." + }, + "LastReplicationOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a replication operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a replication operation message was never received." + }, + "IsInBuild": { + "type": "boolean", + "description": "Value that indicates whether the replica is currently being built." + }, + "CopyQueueStatus": { + "$ref": "#/definitions/ReplicatorQueueStatus", + "description": "Details about the copy queue on the secondary replicator." + }, + "LastCopyOperationReceivedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which a copy operation was received from the primary.\nUTC 0 represents an invalid value, indicating that a copy operation message was never received." + }, + "LastAcknowledgementSentTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last time-stamp (UTC) at which an acknowledgment was sent to the primary replicator.\nUTC 0 represents an invalid value, indicating that an acknowledgment message was never sent." + } + } + }, + "SecondaryActiveReplicatorStatus": { + "x-ms-discriminator-value": "ActiveSecondary", + "description": "Status of the secondary replicator when it is in active mode and is part of the replica set.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + } + ] + }, + "SecondaryIdleReplicatorStatus": { + "x-ms-discriminator-value": "IdleSecondary", + "description": "Status of the secondary replicator when it is in idle mode and is being built by the primary.", + "allOf": [ + { + "$ref": "#/definitions/SecondaryReplicatorStatus" + } + ] + }, + "RemoteReplicatorStatus": { + "description": "Represents the state of the secondary replicator from the primary replicator’s point of view.", + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Represents the replica ID of the remote secondary replicator." + }, + "LastAcknowledgementProcessedTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The last timestamp (in UTC) when an acknowledgement from the secondary replicator was processed on the primary.\nUTC 0 represents an invalid value, indicating that no acknowledgement messages were ever processed." + }, + "LastReceivedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has received from the primary." + }, + "LastAppliedReplicationSequenceNumber": { + "type": "string", + "description": "The highest replication operation sequence number that the secondary has applied to its state." + }, + "IsInBuild": { + "type": "boolean", + "description": "A value that indicates whether the secondary replica is in the process of being built." + }, + "LastReceivedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has received from the primary.\nA value of -1 implies that the secondary has received all copy operations." + }, + "LastAppliedCopySequenceNumber": { + "type": "string", + "description": "The highest copy operation sequence number that the secondary has applied to its state.\nA value of -1 implies that the secondary has applied all copy operations and the copy process is complete." + }, + "RemoteReplicatorAcknowledgementStatus": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementStatus", + "description": "Represents the acknowledgment status for the remote secondary replicator." + } + } + }, + "RemoteReplicatorStatusList": { + "type": "array", + "items": { + "$ref": "#/definitions/RemoteReplicatorStatus" + }, + "description": "List of remote replicator status" + }, + "RemoteReplicatorAcknowledgementStatus": { + "description": "Provides details about the remote replicators from the primary replicator's point of view.", + "properties": { + "ReplicationStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the replication stream data." + }, + "CopyStreamAcknowledgementDetail": { + "$ref": "#/definitions/RemoteReplicatorAcknowledgementDetail", + "description": "Details about the acknowledgements for operations that are part of the copy stream data." + } + } + }, + "RemoteReplicatorAcknowledgementDetail": { + "description": "Provides various statistics of the acknowledgements that are being received from the remote replicator.", + "properties": { + "AverageReceiveDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to receive an operation." + }, + "AverageApplyDuration": { + "type": "string", + "description": "Represents the average duration it takes for the remote replicator to apply an operation. This usually entails writing the operation to disk." + }, + "NotReceivedCount": { + "type": "string", + "description": "Represents the number of operations not yet received by a remote replicator." + }, + "ReceivedAndNotAppliedCount": { + "type": "string", + "description": "Represents the number of operations received and not yet applied by a remote replicator." + } + } + }, + "DeployedServiceReplicaDetailInfo": { + "discriminator": "ServiceKind", + "description": "Information about a Service Fabric service replica deployed on a node.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of service (Stateless or Stateful)." + }, + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "Full hierarchical name of the service in URI format starting with `fabric:`." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + }, + "CurrentServiceOperation": { + "$ref": "#/definitions/ServiceOperationName", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance." + }, + "CurrentServiceOperationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The start time of the current service operation in UTC format." + }, + "ReportedLoad": { + "$ref": "#/definitions/LoadMetricReportInfoList", + "description": "List of load reported by replica." + } + } + }, + "DeployedStatefulServiceReplicaDetailInfo": { + "description": "Information about a stateful replica running in a code package. Note DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and replicaId.", + "x-ms-discriminator-value": "Stateful", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + ], + "properties": { + "ReplicaId": { + "$ref": "#/definitions/ReplicaId", + "description": "Id of a stateful service replica. ReplicaId is used by Service Fabric to uniquely identify a replica of a partition. It is unique within a partition and does not change for the lifetime of the replica. If a replica gets dropped and another replica gets created on the same node for the same partition, it will get a different value for the id. Sometimes the id of a stateless service instance is also referred as a replica id." + }, + "CurrentReplicatorOperation": { + "$ref": "#/definitions/ReplicatorOperationName", + "description": "Specifies the operation currently being executed by the Replicator." + }, + "ReadStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "WriteStatus": { + "$ref": "#/definitions/PartitionAccessStatus", + "description": "Specifies the access status of the partition." + }, + "ReplicatorStatus": { + "$ref": "#/definitions/ReplicatorStatus", + "description": "Represents a base class for primary or secondary replicator status.\nContains information about the service fabric replicator like the replication/copy queue utilization, last acknowledgement received timestamp, etc." + }, + "ReplicaStatus": { + "$ref": "#/definitions/KeyValueStoreReplicaStatus", + "description": "Key value store related information for the replica." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatefulServiceReplicaInfo", + "description": "Information about a stateful service replica deployed on a node." + } + } + }, + "DeployedStatelessServiceInstanceDetailInfo": { + "description": "Information about a stateless instance running in a code package. Note that DeployedServiceReplicaQueryResult will contain duplicate data like ServiceKind, ServiceName, PartitionId and InstanceId.", + "x-ms-discriminator-value": "Stateless", + "allOf": [ + { + "$ref": "#/definitions/DeployedServiceReplicaDetailInfo" + } + ], + "properties": { + "InstanceId": { + "$ref": "#/definitions/InstanceId", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "DeployedServiceReplicaQueryResult": { + "$ref": "#/definitions/DeployedStatelessServiceInstanceInfo", + "description": "Information about a stateless service instance deployed on a node." + } + } + }, + "FabricReplicaStatus": { + "type": "string", + "description": "Specifies the status of the replica.", + "enum": [ + "Invalid", + "Down", + "Up" + ], + "x-ms-enum": { + "name": "FabricReplicaStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Down", + "description": "Indicates that the replica is down." + }, + { + "value": "Up", + "description": "Indicates that the replica is up." + } + ] + } + }, + "LoadMetricReportInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadMetricReportInfo" + }, + "description": "List of load reported by replica." + }, + "LoadMetricReportInfo": { + "description": "Information about load reported by replica.", + "properties": { + "Name": { + "type": "string", + "description": "The name of the metric." + }, + "Value": { + "type": "integer", + "format": "int32", + "description": "The value of the load for the metric. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentValue." + }, + "CurrentValue": { + "type": "string", + "format": "double", + "description": "The double value of the load for the metric." + }, + "LastReportedUtc": { + "type": "string", + "format": "date-time", + "description": "The UTC time when the load is reported." + } + } + }, + "PartitionAccessStatus": { + "type": "string", + "description": "Specifies the access status of the partition.", + "enum": [ + "Invalid", + "Granted", + "ReconfigurationPending", + "NotPrimary", + "NoWriteQuorum" + ], + "x-ms-enum": { + "name": "PartitionAccessStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the read or write operation access status is not valid. This value is not returned to the caller." + }, + { + "value": "Granted", + "description": "Indicates that the read or write operation access is granted and the operation is allowed." + }, + { + "value": "ReconfigurationPending", + "description": "Indicates that the client should try again later, because a reconfiguration is in progress." + }, + { + "value": "NotPrimary", + "description": "Indicates that this client request was received by a replica that is not a Primary replica." + }, + { + "value": "NoWriteQuorum", + "description": "Indicates that no write quorum is available and, therefore, no write operation can be accepted." + } + ] + } + }, + "ReplicatorOperationName": { + "type": "string", + "description": "Specifies the operation currently being executed by the Replicator.", + "enum": [ + "Invalid", + "None", + "Open", + "ChangeRole", + "UpdateEpoch", + "Close", + "Abort", + "OnDataLoss", + "WaitForCatchup", + "Build" + ], + "x-ms-enum": { + "name": "ReplicatorOperationName", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Default value if the replicator is not yet ready." + }, + { + "value": "None", + "description": "Replicator is not running any operation from Service Fabric perspective." + }, + { + "value": "Open", + "description": "Replicator is opening." + }, + { + "value": "ChangeRole", + "description": "Replicator is in the process of changing its role." + }, + { + "value": "UpdateEpoch", + "description": "Due to a change in the replica set, replicator is being updated with its Epoch." + }, + { + "value": "Close", + "description": "Replicator is closing." + }, + { + "value": "Abort", + "description": "Replicator is being aborted." + }, + { + "value": "OnDataLoss", + "description": "Replicator is handling the data loss condition, where the user service may potentially be recovering state from an external source." + }, + { + "value": "WaitForCatchup", + "description": "Replicator is waiting for a quorum of replicas to be caught up to the latest state." + }, + { + "value": "Build", + "description": "Replicator is in the process of building one or more replicas." + } + ] + } + }, + "ServiceOperationName": { + "type": "string", + "description": "Specifies the current active life-cycle operation on a stateful service replica or stateless service instance.", + "enum": [ + "Unknown", + "None", + "Open", + "ChangeRole", + "Close", + "Abort" + ], + "x-ms-enum": { + "name": "ServiceOperationName", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Reserved for future use." + }, + { + "value": "None", + "description": "The service replica or instance is not going through any life-cycle changes." + }, + { + "value": "Open", + "description": "The service replica or instance is being opened." + }, + { + "value": "ChangeRole", + "description": "The service replica is changing roles." + }, + { + "value": "Close", + "description": "The service replica or instance is being closed." + }, + { + "value": "Abort", + "description": "The service replica or instance is being aborted." + } + ] + } + }, + "ReplicaKind": { + "type": "string", + "description": "The role of a replica of a stateful service.", + "enum": [ + "Invalid", + "KeyValueStore" + ], + "x-ms-enum": { + "name": "ReplicaKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Represents an invalid replica kind. The value is zero." + }, + { + "value": "KeyValueStore", + "description": "Represents a key value store replica. The value is 1" + } + ] + } + }, + "ReplicaStatusBase": { + "discriminator": "Kind", + "description": "Information about the replica.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ReplicaKind", + "description": "The role of a replica of a stateful service." + } + } + }, + "KeyValueStoreReplicaStatus": { + "description": "Key value store related information for the replica.", + "x-ms-discriminator-value": "KeyValueStore", + "allOf": [ + { + "$ref": "#/definitions/ReplicaStatusBase" + } + ], + "properties": { + "DatabaseRowCountEstimate": { + "type": "string", + "description": "Value indicating the estimated number of rows in the underlying database." + }, + "DatabaseLogicalSizeEstimate": { + "type": "string", + "description": "Value indicating the estimated size of the underlying database." + }, + "CopyNotificationCurrentKeyFilter": { + "type": "string", + "description": "Value indicating the latest key-prefix filter applied to enumeration during the callback. Null if there is no pending callback." + }, + "CopyNotificationCurrentProgress": { + "type": "string", + "description": "Value indicating the latest number of keys enumerated during the callback. 0 if there is no pending callback." + }, + "StatusDetails": { + "type": "string", + "description": "Value indicating the current status details of the replica." + } + } + }, + "ServiceUpdateDescription": { + "discriminator": "ServiceKind", + "description": "A ServiceUpdateDescription contains all of the information necessary to update a service.", + "required": [ + "ServiceKind" + ], + "properties": { + "ServiceKind": { + "$ref": "#/definitions/ServiceKind", + "description": "The service kind." + }, + "Flags": { + "type": "string", + "description": "Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified.\nThis property can be a combination of those flags obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set.\n\n- None - Does not indicate any other properties are set. The value is zero.\n- TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1.\n- ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2.\n- QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4.\n- StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8.\n- MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16.\n- PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32.\n- PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64.\n- Correlation - Indicates the CorrelationScheme property is set. The value is 128.\n- Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256.\n- DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512.\n- ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024." + }, + "PlacementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "CorrelationScheme": { + "$ref": "#/definitions/CorrelationSchemeList", + "description": "The correlation scheme." + }, + "LoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList", + "description": "The service load metrics." + }, + "ServicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList", + "description": "The service placement policies." + }, + "DefaultMoveCost": { + "$ref": "#/definitions/MoveCost", + "description": "The move cost for the service." + }, + "ScalingPolicies": { + "$ref": "#/definitions/ScalingPolicyDescriptionList", + "description": "Scaling policies for this service." + } + } + }, + "StatefulServiceUpdateDescription": { + "description": "Describes an update for a stateful service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "TargetReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "MinReplicaSetSize": { + "type": "integer", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "ReplicaRestartWaitDurationSeconds": { + "type": "string", + "description": "The duration, in seconds, between when a replica goes down and when a new replica is created." + }, + "QuorumLossWaitDurationSeconds": { + "type": "string", + "description": "The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss." + }, + "StandByReplicaKeepDurationSeconds": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed." + } + } + }, + "StatelessServiceUpdateDescription": { + "description": "Describes an update for a stateless service.", + "allOf": [ + { + "$ref": "#/definitions/ServiceUpdateDescription" + } + ], + "x-ms-discriminator-value": "Stateless", + "properties": { + "InstanceCount": { + "type": "integer", + "minimum": -1, + "description": "The instance count." + } + } + }, + "ImageStoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileVersion": { + "description": "Information about the version of image store file.", + "properties": { + "VersionNumber": { + "type": "string", + "description": "The current image store version number for the file is used in image store for checking whether it need to be updated." + }, + "EpochDataLossNumber": { + "type": "string", + "description": "The epoch data loss number of image store replica when this file entry was updated or created." + }, + "EpochConfigurationNumber": { + "type": "string", + "description": "The epoch configuration version number of the image store replica when this file entry was created or updated." + } + } + }, + "FileInfo": { + "description": "Information about a image store file.", + "properties": { + "FileSize": { + "type": "string", + "description": "The size of file in bytes." + }, + "FileVersion": { + "$ref": "#/definitions/FileVersion", + "description": "Information about the version of image store file." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the image store file was last modified." + }, + "StoreRelativePath": { + "type": "string", + "description": "The file path relative to the image store root path." + } + } + }, + "FolderInfo": { + "description": "Information about a image store folder. It includes how many files this folder contains and its image store relative path.", + "properties": { + "StoreRelativePath": { + "$ref": "#/definitions/ImageStoreRelativePath", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "FileCount": { + "type": "string", + "description": "The number of files from within the image store folder." + } + } + }, + "ImageStoreContent": { + "description": "Information about the image store content.", + "properties": { + "StoreFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/FileInfo" + }, + "description": "The list of image store file info objects represents files found under the given image store relative path." + }, + "StoreFolders": { + "type": "array", + "items": { + "$ref": "#/definitions/FolderInfo" + }, + "description": "The list of image store folder info objects represents subfolders found under the given image store relative path." + } + } + }, + "ImageStoreCopyDescription": { + "description": "Information about how to copy image store content from one image store relative path to another image store relative path.", + "required": [ + "RemoteSource", + "RemoteDestination" + ], + "properties": { + "RemoteSource": { + "type": "string", + "description": "The relative path of source image store content to be copied from." + }, + "RemoteDestination": { + "type": "string", + "description": "The relative path of destination image store content to be copied to." + }, + "SkipFiles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of the file names to be skipped for copying." + }, + "CheckMarkFile": { + "type": "boolean", + "description": "Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped." + } + } + }, + "InstanceId": { + "type": "string", + "description": "Id of a stateless service instance. InstanceId is used by Service Fabric to uniquely identify an instance of a partition of a stateless service. It is unique within a partition and does not change for the lifetime of the instance. If the instance has failed over on the same or different node, it will get a different value for the InstanceId." + }, + "CodePackageInstanceId": { + "type": "string", + "description": "The instance ID for current running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance id will change." + }, + "HostIsolationMode": { + "type": "string", + "description": "Specifies the isolation mode of main entry point of a code package when it's host type is ContainerHost. This is specified as part of container host policies in application manifest while importing service manifest.", + "enum": [ + "None", + "Process", + "HyperV" + ], + "x-ms-enum": { + "name": "HostIsolationMode", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Indicates the isolation mode is not applicable for given HostType. The value is 0." + }, + { + "value": "Process", + "description": "This is the default isolation mode for a ContainerHost. The value is 1." + }, + { + "value": "HyperV", + "description": "Indicates the ContainerHost is a Hyper-V container. This applies to only Windows containers. The value is 2." + } + ] + } + }, + "HostType": { + "type": "string", + "description": "Specifies the type of host for main entry point of a code package as specified in service manifest.", + "enum": [ + "Invalid", + "ExeHost", + "ContainerHost" + ], + "x-ms-enum": { + "name": "HostType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the type of host is not known or invalid. The value is 0." + }, + { + "value": "ExeHost", + "description": "Indicates the host is an executable. The value is 1." + }, + { + "value": "ContainerHost", + "description": "Indicates the host is a container. The value is 2." + } + ] + } + }, + "RestartDeployedCodePackageDescription": { + "description": "Defines description for restarting a deployed code package on Service Fabric node.", + "required": [ + "ServiceManifestName", + "CodePackageName", + "CodePackageInstanceId" + ], + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest that specified this code package." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package defined in the service manifest." + }, + "CodePackageInstanceId": { + "$ref": "#/definitions/CodePackageInstanceId", + "description": "The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started.\nEach time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running.\nIf an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID.\nNote, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package." + } + } + }, + "DeployedServiceTypeInfo": { + "description": "Information about service type deployed on a node, information such as the status of the service type registration on a node.", + "properties": { + "ServiceTypeName": { + "$ref": "#/definitions/ServiceTypeName", + "description": "Name of the service type as specified in the service manifest." + }, + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of the service manifest in which this service type is defined." + }, + "CodePackageName": { + "$ref": "#/definitions/CodePackageName", + "description": "The name of the code package that registered the service type." + }, + "Status": { + "$ref": "#/definitions/ServiceTypeRegistrationStatus", + "description": "The status of the service type registration on the node." + }, + "ServicePackageActivationId": { + "$ref": "#/definitions/ServicePackageActivationId", + "description": "The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service\nis 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId\nis always an empty string." + } + } + }, + "DeployedServiceTypeInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/DeployedServiceTypeInfo" + }, + "description": "List of information about service type deployed on a node." + }, + "ServiceTypeRegistrationStatus": { + "type": "string", + "description": "The status of the service type registration on the node.", + "enum": [ + "Invalid", + "Disabled", + "Enabled", + "Registered" + ], + "x-ms-enum": { + "name": "ServiceTypeRegistrationStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the registration status is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Disabled", + "description": "Indicates that the service type is disabled on this node. A type gets disabled when there are too many failures of the code package hosting the service type. If the service type is disabled, new replicas of that service type will not be placed on the node until it is enabled again. The service type is enabled again after the process hosting it comes up and re-registers the type or a preconfigured time interval has passed. The value is 1." + }, + { + "value": "Enabled", + "description": "Indicates that the service type is enabled on this node. Replicas of this service type can be placed on this node when the code package registers the service type. The value is 2." + }, + { + "value": "Registered", + "description": "Indicates that the service type is enabled and registered on the node by a code package. Replicas of this service type can now be placed on this node. The value is 3." + } + ] + } + }, + "ServiceEndpointRole": { + "type": "string", + "description": "The role of the replica where the endpoint is reported.", + "enum": [ + "Invalid", + "Stateless", + "StatefulPrimary", + "StatefulSecondary" + ], + "x-ms-enum": { + "name": "ServiceEndpointRole", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the service endpoint role is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Stateless", + "description": "Indicates that the service endpoint is of a stateless service. The value is 1." + }, + { + "value": "StatefulPrimary", + "description": "Indicates that the service endpoint is of a primary replica of a stateful service. The value is 2." + }, + { + "value": "StatefulSecondary", + "description": "Indicates that the service endpoint is of a secondary replica of a stateful service. The value is 3." + } + ] + } + }, + "ResolvedServiceEndpoint": { + "description": "Endpoint of a resolved service partition.", + "properties": { + "Kind": { + "$ref": "#/definitions/ServiceEndpointRole", + "description": "The role of the replica where the endpoint is reported." + }, + "Address": { + "type": "string", + "description": "The address of the endpoint. If the endpoint has multiple listeners the address is a JSON object with one property per listener with the value as the address of that listener." + } + } + }, + "ResolvedServicePartition": { + "description": "Information about a service partition and its associated endpoints.", + "required": [ + "Name", + "PartitionInformation", + "Endpoints", + "Version" + ], + "properties": { + "Name": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "A representation of the resolved partition." + }, + "Endpoints": { + "$ref": "#/definitions/ResolvedServiceEndpointList", + "description": "List of resolved service endpoints of a service partition." + }, + "Version": { + "type": "string", + "description": "The version of this resolved service partition result. This version should be passed in the next time the ResolveService call is made via the PreviousRspVersion query parameter." + } + } + }, + "ResolvedServiceEndpointList": { + "type": "array", + "items": { + "$ref": "#/definitions/ResolvedServiceEndpoint" + }, + "description": "List of resolved service endpoints of a service partition." + }, + "InvokeDataLossResult": { + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "InvokeQuorumLossResult": { + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "NodeResult": { + "description": "Contains information about a node that was targeted by a user-induced operation.", + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "The node instance id." + } + } + }, + "NodeTransitionProgress": { + "description": "Information about an NodeTransition operation. This class contains an OperationState and a NodeTransitionResult. The NodeTransitionResult is not valid until OperationState\nis Completed or Faulted.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "NodeTransitionResult": { + "$ref": "#/definitions/NodeTransitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "NodeTransitionResult": { + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "NodeResult": { + "$ref": "#/definitions/NodeResult", + "description": "Contains information about a node that was targeted by a user-induced operation." + } + } + }, + "OperationId": { + "type": "string", + "format": "uuid", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "OperationState": { + "type": "string", + "description": "The state of the operation.", + "enum": [ + "Invalid", + "Running", + "RollingBack", + "Completed", + "Faulted", + "Cancelled", + "ForceCancelled" + ], + "x-ms-enum": { + "name": "OperationState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "Running", + "description": "The operation is in progress." + }, + { + "value": "RollingBack", + "description": "The operation is rolling back internal system state because it encountered a fatal error or was cancelled by the user. \"RollingBack\" does not refer to user state. For example, if CancelOperation is called on a command of type PartitionDataLoss, state of \"RollingBack\" does not mean service data is being restored (assuming the command has progressed far enough to cause data loss). It means the system is rolling back/cleaning up internal system state associated with the command." + }, + { + "value": "Completed", + "description": "The operation has completed successfully and is no longer running." + }, + { + "value": "Faulted", + "description": "The operation has failed and is no longer running." + }, + { + "value": "Cancelled", + "description": "The operation was cancelled by the user using CancelOperation, and is no longer running." + }, + { + "value": "ForceCancelled", + "description": "The operation was cancelled by the user using CancelOperation, with the force parameter set to true. It is no longer running. Refer to CancelOperation for more details." + } + ] + } + }, + "OperationStatus": { + "description": "Contains the OperationId, OperationState, and OperationType for user-induced operations.", + "properties": { + "OperationId": { + "$ref": "#/definitions/OperationId", + "description": "A GUID that identifies a call to this API. This is also passed into the corresponding GetProgress API." + }, + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "Type": { + "$ref": "#/definitions/OperationType", + "description": "The type of the operation." + } + } + }, + "OperationStatusList": { + "type": "array", + "description": "A list of OperationStatus objects.", + "items": { + "$ref": "#/definitions/OperationStatus" + } + }, + "OperationType": { + "type": "string", + "description": "The type of the operation.", + "enum": [ + "Invalid", + "PartitionDataLoss", + "PartitionQuorumLoss", + "PartitionRestart", + "NodeTransition" + ], + "x-ms-enum": { + "name": "OperationType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The operation state is invalid." + }, + { + "value": "PartitionDataLoss", + "description": "An operation started using the StartDataLoss API." + }, + { + "value": "PartitionQuorumLoss", + "description": "An operation started using the StartQuorumLoss API." + }, + { + "value": "PartitionRestart", + "description": "An operation started using the StartPartitionRestart API." + }, + { + "value": "NodeTransition", + "description": "An operation started using the StartNodeTransition API." + } + ] + } + }, + "PartitionDataLossProgress": { + "description": "Information about a partition data loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeDataLossResult": { + "$ref": "#/definitions/InvokeDataLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionQuorumLossProgress": { + "description": "Information about a partition quorum loss user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "InvokeQuorumLossResult": { + "$ref": "#/definitions/InvokeQuorumLossResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "PartitionRestartProgress": { + "description": "Information about a partition restart user-induced operation.", + "properties": { + "State": { + "$ref": "#/definitions/OperationState", + "description": "The state of the operation." + }, + "RestartPartitionResult": { + "$ref": "#/definitions/RestartPartitionResult", + "description": "Represents information about an operation in a terminal state (Completed or Faulted)." + } + } + }, + "RestartPartitionResult": { + "description": "Represents information about an operation in a terminal state (Completed or Faulted).", + "properties": { + "ErrorCode": { + "type": "integer", + "format": "int32", + "description": "If OperationState is Completed, this is 0. If OperationState is Faulted, this is an error code indicating the reason." + }, + "SelectedPartition": { + "$ref": "#/definitions/SelectedPartition", + "description": "This class returns information about the partition that the user-induced operation acted upon." + } + } + }, + "SelectedPartition": { + "description": "This class returns information about the partition that the user-induced operation acted upon.", + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The name of the service the partition belongs to." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + } + }, + "DeployServicePackageToNodeDescription": { + "description": "Defines description for downloading packages associated with a service manifest to image cache on a Service Fabric node.", + "properties": { + "ServiceManifestName": { + "$ref": "#/definitions/ServiceManifestName", + "description": "The name of service manifest whose packages need to be downloaded." + }, + "ApplicationTypeName": { + "$ref": "#/definitions/ApplicationTypeName", + "description": "The application type name as defined in the application manifest." + }, + "ApplicationTypeVersion": { + "$ref": "#/definitions/ApplicationTypeVersion", + "description": "The version of the application type as defined in the application manifest." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "PackageSharingPolicy": { + "$ref": "#/definitions/PackageSharingPolicyInfoList", + "description": "List of package sharing policy information." + } + }, + "required": [ + "ServiceManifestName", + "ApplicationTypeName", + "ApplicationTypeVersion", + "NodeName" + ] + }, + "PackageSharingPolicyInfo": { + "description": "Represents a policy for the package sharing.", + "properties": { + "SharedPackageName": { + "type": "string", + "description": "The name of code, configuration or data package that should be shared." + }, + "PackageSharingScope": { + "$ref": "#/definitions/PackageSharingPolicyScope", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation." + } + } + }, + "PackageSharingPolicyInfoList": { + "type": "array", + "items": { + "$ref": "#/definitions/PackageSharingPolicyInfo" + }, + "description": "List of package sharing policy information." + }, + "PackageSharingPolicyScope": { + "type": "string", + "description": "Represents the scope for PackageSharingPolicy. This is specified during DeployServicePackageToNode operation.", + "enum": [ + "None", + "All", + "Code", + "Config", + "Data" + ], + "x-ms-enum": { + "name": "PackageSharingPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "No package sharing policy scope. The value is 0." + }, + { + "value": "All", + "description": "Share all code, config and data packages from corresponding service manifest. The value is 1." + }, + { + "value": "Code", + "description": "Share all code packages from corresponding service manifest. The value is 2." + }, + { + "value": "Config", + "description": "Share all config packages from corresponding service manifest. The value is 3." + }, + { + "value": "Data", + "description": "Share all data packages from corresponding service manifest. The value is 4." + } + ] + } + }, + "ResumeApplicationUpgradeDescription": { + "description": "Describes the parameters for resuming an unmonitored manual Service Fabric application upgrade", + "properties": { + "UpgradeDomainName": { + "type": "string", + "description": "The name of the upgrade domain in which to resume the upgrade." + } + }, + "required": [ + "UpgradeDomainName" + ] + }, + "ApplicationUpgradeUpdateDescription": { + "description": "Describes the parameters for updating an ongoing application upgrade.", + "properties": { + "Name": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + }, + "UpgradeKind": { + "$ref": "#/definitions/UpgradeKind", + "description": "The kind of upgrade out of the following possible values." + }, + "ApplicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities." + }, + "UpdateDescription": { + "$ref": "#/definitions/RollingUpgradeUpdateDescription", + "description": "Describes the parameters for updating a rolling upgrade of application or cluster." + } + }, + "required": [ + "Name", + "UpgradeKind" + ] + }, + "RollingUpgradeUpdateDescription": { + "description": "Describes the parameters for updating a rolling upgrade of application or cluster.", + "properties": { + "RollingUpgradeMode": { + "$ref": "#/definitions/UpgradeMode", + "description": "The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored." + }, + "ForceRestart": { + "$ref": "#/definitions/ForceRestart", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data)." + }, + "ReplicaSetCheckTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeReplicaSetCheckTimeout", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "FailureAction": { + "$ref": "#/definitions/FailureAction", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations.\nInvalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically.\nManual indicates that the upgrade will switch to UnmonitoredManual upgrade mode." + }, + "HealthCheckWaitDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckWaitDuration", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckStableDurationInMilliseconds": { + "$ref": "#/definitions/HealthCheckStableDuration", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "HealthCheckRetryTimeoutInMilliseconds": { + "$ref": "#/definitions/HealthCheckRetryTimeout", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeTimeout", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + }, + "UpgradeDomainTimeoutInMilliseconds": { + "$ref": "#/definitions/UpgradeDomainTimeout", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds." + } + }, + "required": [ + "RollingUpgradeMode" + ] + }, + "NameDescription": { + "description": "Describes a Service Fabric name.", + "properties": { + "Name": { + "$ref": "#/definitions/FabricName", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + } + }, + "required": [ + "Name" + ] + }, + "FabricName": { + "type": "string", + "description": "The Service Fabric name, including the 'fabric:' URI scheme." + }, + "PagedSubNameInfoList": { + "description": "A paged list of Service Fabric names. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any name under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "SubNames": { + "type": "array", + "description": "List of the child names.", + "items": { + "$ref": "#/definitions/FabricName" + } + } + } + }, + "PropertyValueKind": { + "type": "string", + "description": "The kind of property, determined by the type of data. Following are the possible values.", + "enum": [ + "Invalid", + "Binary", + "Int64", + "Double", + "String", + "Guid" + ], + "x-ms-enum": { + "name": "PropertyValueKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Binary", + "description": "The data inside the property is a binary blob. The value is 1." + }, + { + "value": "Int64", + "description": "The data inside the property is an int64. The value is 2." + }, + { + "value": "Double", + "description": "The data inside the property is a double. The value is 3." + }, + { + "value": "String", + "description": "The data inside the property is a string. The value is 4." + }, + { + "value": "Guid", + "description": "The data inside the property is a guid. The value is 5." + } + ] + } + }, + "PropertyValue": { + "discriminator": "Kind", + "description": "Describes a Service Fabric property value.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "BinaryPropertyValue": { + "description": "Describes a Service Fabric property value of type Binary.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + } + ], + "x-ms-discriminator-value": "Binary", + "required": [ + "Data" + ], + "properties": { + "Data": { + "$ref": "#/definitions/ByteArray", + "description": "Array of bytes to be sent as an integer array. Each element of array is a number between 0 and 255." + } + } + }, + "Int64PropertyValue": { + "description": "Describes a Service Fabric property value of type Int64.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + } + ], + "x-ms-discriminator-value": "Int64", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "DoublePropertyValue": { + "description": "Describes a Service Fabric property value of type Double.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + } + ], + "x-ms-discriminator-value": "Double", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "number", + "format": "double", + "description": "The data of the property value." + } + } + }, + "StringPropertyValue": { + "description": "Describes a Service Fabric property value of type String.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + } + ], + "x-ms-discriminator-value": "String", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "description": "The data of the property value." + } + } + }, + "GuidPropertyValue": { + "description": "Describes a Service Fabric property value of type Guid.", + "allOf": [ + { + "$ref": "#/definitions/PropertyValue" + } + ], + "x-ms-discriminator-value": "Guid", + "required": [ + "Data" + ], + "properties": { + "Data": { + "type": "string", + "format": "uuid", + "description": "The data of the property value." + } + } + }, + "PropertyInfo": { + "discriminator": "Kind", + "description": "Information about a Service Fabric property.", + "properties": { + "Name": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "Metadata": { + "$ref": "#/definitions/PropertyMetadata", + "description": "The metadata associated with a property, including the property's name." + } + }, + "required": [ + "Name", + "Metadata" + ] + }, + "PagedPropertyInfoList": { + "description": "The paged list of Service Fabric properties under a given name. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "IsConsistent": { + "type": "boolean", + "description": "Indicates whether any property under the given name has been modified during the enumeration. If there was a modification, this property value is false." + }, + "Properties": { + "type": "array", + "description": "List of property information.", + "items": { + "$ref": "#/definitions/PropertyInfo" + } + } + } + }, + "PropertyDescription": { + "description": "Description of a Service Fabric property.", + "properties": { + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + }, + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + } + }, + "required": [ + "PropertyName", + "Value" + ] + }, + "PropertyName": { + "type": "string", + "description": "The name of the Service Fabric property." + }, + "PropertyMetadata": { + "description": "The metadata associated with a property, including the property's name.", + "properties": { + "TypeId": { + "$ref": "#/definitions/PropertyValueKind", + "description": "The kind of property, determined by the type of data. Following are the possible values." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID." + }, + "Parent": { + "$ref": "#/definitions/FabricName", + "description": "The name of the parent Service Fabric Name for the property. It could be thought of as the name-space/table under which the property exists." + }, + "SizeInBytes": { + "type": "integer", + "description": "The length of the serialized property value." + }, + "LastModifiedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Represents when the Property was last modified. Only write operations will cause this field to be updated." + }, + "SequenceNumber": { + "type": "string", + "description": "The version of the property. Every time a property is modified, its sequence number is increased." + } + } + }, + "PropertyCustomTypeId": { + "type": "string", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + }, + "PropertyBatchDescriptionList": { + "description": "Describes a list of property batch operations to be executed. Either all or none of the operations will be committed.", + "properties": { + "Operations": { + "type": "array", + "items": { + "$ref": "#/definitions/PropertyBatchOperation" + }, + "description": "A list of the property batch operations to be executed." + } + } + }, + "PropertyBatchOperationKind": { + "type": "string", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values.", + "enum": [ + "Invalid", + "Put", + "Get", + "CheckExists", + "CheckSequence", + "Delete", + "CheckValue" + ], + "x-ms-enum": { + "name": "PropertyBatchOperationKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property operation is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Put", + "description": "The operation will create or edit a property. The value is 1." + }, + { + "value": "Get", + "description": "The operation will get a property. The value is 2." + }, + { + "value": "CheckExists", + "description": "The operation will check that a property exists or doesn't exists, depending on the provided value. The value is 3." + }, + { + "value": "CheckSequence", + "description": "The operation will ensure that the sequence number is equal to the provided value. The value is 4." + }, + { + "value": "Delete", + "description": "The operation will delete a property. The value is 5." + }, + { + "value": "CheckValue", + "description": "The operation will ensure that the value of a property is equal to the provided value. The value is 7." + } + ] + } + }, + "PropertyBatchOperation": { + "discriminator": "Kind", + "description": "Represents the base type for property operations that can be put into a batch and submitted.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchOperationKind", + "description": "The kind of property batch operation, determined by the operation to be performed. The following are the possible values." + }, + "PropertyName": { + "$ref": "#/definitions/PropertyName", + "description": "The name of the Service Fabric property." + } + }, + "required": [ + "Kind", + "PropertyName" + ] + }, + "CheckExistsPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the Boolean existence of a property with the Exists argument.\nThe PropertyBatchOperation operation fails if the property's existence is not equal to the Exists argument.\nThe CheckExistsPropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckExists", + "properties": { + "Exists": { + "type": "boolean", + "description": "Whether or not the property should exist for the operation to pass." + } + }, + "required": [ + "Exists" + ] + }, + "CheckSequencePropertyBatchOperation": { + "description": "Compares the Sequence Number of a property with the SequenceNumber argument.\nA property's sequence number can be thought of as that property's version.\nEvery time the property is modified, its sequence number is increased.\nThe sequence number can be found in a property's metadata.\nThe comparison fails if the sequence numbers are not equal.\nCheckSequencePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckSequence", + "properties": { + "SequenceNumber": { + "type": "string", + "description": "The expected sequence number." + } + }, + "required": [ + "SequenceNumber" + ] + }, + "CheckValuePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that compares the value of the property with the expected value.\nThe CheckValuePropertyBatchOperation is generally used as a precondition for the write operations in the batch.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "CheckValue", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "The expected property value." + } + }, + "required": [ + "Value" + ] + }, + "DeletePropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that deletes a specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Delete" + }, + "GetPropertyBatchOperation": { + "description": "Represents a PropertyBatchOperation that gets the specified property if it exists.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Get", + "properties": { + "IncludeValue": { + "type": "boolean", + "default": false, + "description": "Whether or not to return the property value with the metadata.\nTrue if values should be returned with the metadata; False to return only property metadata." + } + } + }, + "PutPropertyBatchOperation": { + "description": "Puts the specified property under the specified name.\nNote that if one PropertyBatchOperation in a PropertyBatch fails,\nthe entire batch fails and cannot be committed in a transactional manner.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchOperation" + } + ], + "x-ms-discriminator-value": "Put", + "properties": { + "Value": { + "$ref": "#/definitions/PropertyValue", + "description": "Describes a Service Fabric property value." + }, + "CustomTypeId": { + "$ref": "#/definitions/PropertyCustomTypeId", + "description": "The property's custom type ID. Using this property, the user is able to tag the type of the value of the property." + } + }, + "required": [ + "Value" + ] + }, + "PropertyBatchInfoKind": { + "type": "string", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values.", + "enum": [ + "Invalid", + "Successful", + "Failed" + ], + "x-ms-enum": { + "name": "PropertyBatchInfoKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the property batch info is invalid. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Successful", + "description": "The property batch succeeded." + }, + { + "value": "Failed", + "description": "The property batch failed." + } + ] + } + }, + "PropertyBatchInfo": { + "discriminator": "Kind", + "description": "Information about the results of a property batch.", + "properties": { + "Kind": { + "$ref": "#/definitions/PropertyBatchInfoKind", + "description": "The kind of property batch info, determined by the results of a property batch. The following are the possible values." + } + }, + "required": [ + "Kind" + ] + }, + "SuccessfulPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch succeeding. Contains the results of any \"Get\" operations in the batch.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Successful", + "properties": { + "Properties": { + "additionalProperties": { + "$ref": "#/definitions/PropertyInfo" + }, + "description": "A map containing the properties that were requested through any \"Get\" property batch operations. The key represents the index of the \"Get\" operation in the original request, in string form. The value is the property. If a property is not found, it will not be in the map." + } + } + }, + "FailedPropertyBatchInfo": { + "description": "Derived from PropertyBatchInfo. Represents the property batch failing. Contains information about the specific batch failure.", + "allOf": [ + { + "$ref": "#/definitions/PropertyBatchInfo" + } + ], + "x-ms-discriminator-value": "Failed", + "properties": { + "ErrorMessage": { + "type": "string", + "description": "The error message of the failed operation. Describes the exception thrown due to the first unsuccessful operation in the property batch." + }, + "OperationIndex": { + "type": "integer", + "description": "The index of the unsuccessful operation in the property batch." + } + } + }, + "EntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc.", + "enum": [ + "Invalid", + "Node", + "Partition", + "Service", + "Application", + "Replica", + "DeployedApplication", + "DeployedServicePackage", + "Cluster" + ], + "x-ms-enum": { + "name": "EntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "Node", + "description": "Indicates the entity is a Service Fabric node. The value is 1." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition. The value is 2." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service. The value is 3." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application. The value is 4." + }, + { + "value": "Replica", + "description": "Indicates the entity is a Service Fabric replica. The value is 5." + }, + { + "value": "DeployedApplication", + "description": "Indicates the entity is a Service Fabric deployed application. The value is 6." + }, + { + "value": "DeployedServicePackage", + "description": "Indicates the entity is a Service Fabric deployed service package. The value is 7." + }, + { + "value": "Cluster", + "description": "Indicates the entity is a Service Fabric cluster. The value is 8." + } + ] + } + }, + "HealthStateCount": { + "description": "Represents information about how many health entities are in Ok, Warning and Error health state.", + "properties": { + "OkCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Ok.", + "minimum": 0 + }, + "WarningCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Warning.", + "minimum": 0 + }, + "ErrorCount": { + "type": "integer", + "format": "int64", + "description": "The number of health entities with aggregated health state Error.", + "minimum": 0 + } + } + }, + "EntityKindHealthStateCount": { + "description": "Represents health state count for entities of the specified entity kind.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/EntityKind", + "description": "The entity kind for which health states are evaluated." + }, + "HealthStateCount": { + "$ref": "#/definitions/HealthStateCount", + "description": "The health state count for the entities of the specified kind." + } + } + }, + "HealthStatistics": { + "description": "The health statistics of an entity, returned as part of the health query result when the query description is configured to include statistics.\nThe statistics include health state counts for all children types of the current entity.\nFor example, for cluster, the health statistics include health state counts for nodes, applications, services, partitions, replicas, deployed applications and deployed service packages.\nFor partition, the health statistics include health counts for replicas.", + "properties": { + "HealthStateCountList": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityKindHealthStateCount" + }, + "description": "List of health state counts per entity kind, which keeps track of how many children of the queried entity are in Ok, Warning and Error state." + } + } + }, + "BackupPolicyDescription": { + "description": "Describes a backup policy for configuring periodic backup.", + "required": [ + "Name", + "AutoRestoreOnDataLoss", + "Schedule", + "MaxIncrementalBackups", + "Storage" + ], + "properties": { + "Name": { + "type": "string", + "description": "The unique name identifying this backup policy." + }, + "AutoRestoreOnDataLoss": { + "type": "boolean", + "description": "Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event." + }, + "MaxIncrementalBackups": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions\n- The replica has never taken a full backup since it has become primary,\n- Some of the log records since the last backup has been truncated, or\n- Replica passed the MaxAccumulatedBackupLogSizeInMB limit." + }, + "Schedule": { + "$ref": "#/definitions/BackupScheduleDescription", + "description": "Describes the backup schedule parameters." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the details of backup storage where to store the periodic backups." + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicyDescription", + "description": "Describes the policy to retain backups in storage." + } + } + }, + "PagedBackupPolicyDescriptionList": { + "description": "The list of backup policies configured in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "The list of backup policies information.", + "items": { + "$ref": "#/definitions/BackupPolicyDescription" + } + } + } + }, + "BasicRetentionPolicyDescription": { + "description": "Describes basic retention policy.", + "allOf": [ + { + "$ref": "#/definitions/RetentionPolicyDescription" + } + ], + "x-ms-discriminator-value": "Basic", + "required": [ + "RetentionDuration" + ], + "properties": { + "RetentionDuration": { + "type": "string", + "format": "duration", + "description": "It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format." + }, + "MinimumNumberOfBackups": { + "type": "integer", + "minimum": 0, + "description": "It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it." + } + } + }, + "RetentionPolicyType": { + "type": "string", + "description": "The type of retention policy. Currently only \"Basic\" retention policy is supported.", + "enum": [ + "Basic", + "Invalid" + ], + "x-ms-enum": { + "name": "RetentionPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Indicates a basic retention policy type." + }, + { + "value": "Invalid", + "description": "Indicates an invalid retention policy type." + } + ] + } + }, + "DisableBackupDescription": { + "description": "It describes the body parameters while disabling backup of a backup entity(Application/Service/Partition).", + "required": [ + "CleanBackup" + ], + "properties": { + "CleanBackup": { + "type": "boolean", + "description": "Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup." + } + } + }, + "RetentionPolicyDescription": { + "description": "Describes the retention policy configured.", + "required": [ + "RetentionPolicyType" + ], + "discriminator": "RetentionPolicyType", + "properties": { + "RetentionPolicyType": { + "$ref": "#/definitions/RetentionPolicyType", + "description": "The type of retention policy. Currently only \"Basic\" retention policy is supported." + } + } + }, + "BackupStorageDescription": { + "required": [ + "StorageKind" + ], + "discriminator": "StorageKind", + "properties": { + "StorageKind": { + "$ref": "#/definitions/BackupStorageKind", + "description": "The kind of backup storage, where backups are saved." + }, + "FriendlyName": { + "type": "string", + "description": "Friendly name for this backup storage." + } + }, + "description": "Describes the parameters for the backup storage." + }, + "BackupStorageKind": { + "type": "string", + "description": "The kind of backup storage, where backups are saved.", + "enum": [ + "Invalid", + "FileShare", + "AzureBlobStore" + ], + "x-ms-enum": { + "name": "BackupStorageKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup storage kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "FileShare", + "description": "Indicates file/ SMB share to be used as backup storage." + }, + { + "value": "AzureBlobStore", + "description": "Indicates Azure blob store to be used as backup storage." + } + ] + } + }, + "BackupScheduleDescription": { + "description": "Describes the backup schedule parameters.", + "required": [ + "ScheduleKind" + ], + "discriminator": "ScheduleKind", + "properties": { + "ScheduleKind": { + "$ref": "#/definitions/BackupScheduleKind", + "description": "The kind of backup schedule, time based or frequency based." + } + } + }, + "BackupScheduleKind": { + "type": "string", + "description": "The kind of backup schedule, time based or frequency based.", + "enum": [ + "Invalid", + "TimeBased", + "FrequencyBased" + ], + "x-ms-enum": { + "name": "BackupScheduleKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "TimeBased", + "description": "Indicates a time-based backup schedule." + }, + { + "value": "FrequencyBased", + "description": "Indicates a frequency-based backup schedule." + } + ] + } + }, + "ApplicationBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric application specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + } + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + }, + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupConfigurationInfo": { + "description": "Backup configuration information for a specific Service Fabric service specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + }, + "x-ms-discriminator-value": "Service" + }, + "PagedBackupConfigurationInfoList": { + "description": "The list of backup configuration information. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup configuration information.", + "items": { + "$ref": "#/definitions/BackupConfigurationInfo" + } + } + } + }, + "BackupPolicyScope": { + "type": "string", + "description": "Specifies the scope at which the backup policy is applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupPolicyScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup policy scope type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup policy is applied at partition level. Hence overriding any policy which may have applied at partition's service or application level." + }, + { + "value": "Service", + "description": "Indicates the backup policy is applied at service level. All partitions of the service inherit this policy unless explicitly overridden at partition level." + }, + { + "value": "Application", + "description": "Indicates the backup policy is applied at application level. All services and partitions of the application inherit this policy unless explicitly overridden at service or partition level." + } + ] + } + }, + "BackupSuspensionScope": { + "type": "string", + "description": "Specifies the scope at which the backup suspension was applied.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupSuspensionScope", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup suspension scope type also indicating entity is not suspended. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the backup suspension is applied at partition level." + }, + { + "value": "Service", + "description": "Indicates the backup suspension is applied at service level. All partitions of the service are hence suspended for backup." + }, + { + "value": "Application", + "description": "Indicates the backup suspension is applied at application level. All services and partitions of the application are hence suspended for backup." + } + ] + } + }, + "RestorePartitionDescription": { + "description": "Specifies the parameters needed to trigger a restore of a specific partition.", + "required": [ + "BackupId", + "BackupLocation" + ], + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID." + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup relative to the backup storage specified/ configured." + }, + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Location of the backup from where the partition will be restored." + } + } + }, + "RestoreProgressInfo": { + "description": "Describes the progress of a restore operation on a partition.", + "properties": { + "RestoreState": { + "$ref": "#/definitions/RestoreState", + "description": "Represents the current state of the partition restore operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "Timestamp when operation succeeded or failed." + }, + "RestoredEpoch": { + "$ref": "#/definitions/Epoch", + "description": "Describes the epoch at which the partition is restored." + }, + "RestoredLsn": { + "type": "string", + "description": "Restored LSN." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing restore operation." + } + } + }, + "RestoreState": { + "type": "string", + "description": "Represents the current state of the partition restore operation.", + "enum": [ + "Invalid", + "Accepted", + "RestoreInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "RestoreState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid restore state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Restore is yet to be triggered." + }, + { + "value": "RestoreInProgress", + "description": "Restore operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupPartitionDescription": { + "description": "Describes the parameters for triggering partition's backup.", + "properties": { + "BackupStorage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Specifies the details of the backup storage where to save the backup." + } + } + }, + "BackupInfo": { + "description": "Represents a backup point which can be used to trigger a restore.", + "properties": { + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique backup ID ." + }, + "BackupChainId": { + "type": "string", + "format": "uuid", + "description": "Unique backup chain ID. All backups part of the same chain has the same backup chain id. A backup chain is comprised of 1 full backup and multiple incremental backups." + }, + "ApplicationName": { + "type": "string", + "description": "Name of the Service Fabric application this partition backup belongs to." + }, + "ServiceName": { + "type": "string", + "description": "Name of the Service Fabric service this partition backup belongs to." + }, + "PartitionInformation": { + "$ref": "#/definitions/PartitionInformation", + "description": "Information about the partition to which this backup belongs to" + }, + "BackupLocation": { + "type": "string", + "description": "Location of the backup, relative to the backup store." + }, + "BackupType": { + "$ref": "#/definitions/BackupType", + "description": "Describes the type of backup, whether its full or incremental." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/Epoch", + "description": "Epoch of the last record in this backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "LSN of the last record in this backup." + }, + "CreationTimeUtc": { + "type": "string", + "format": "date-time", + "description": "The date time when this backup was taken." + }, + "ServiceManifestVersion": { + "type": "string", + "description": "Manifest Version of the service this partition backup belongs to." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in getting backup point information." + } + } + }, + "PagedBackupInfoList": { + "description": "The list of backups. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup information.", + "items": { + "$ref": "#/definitions/BackupInfo" + } + } + } + }, + "BackupType": { + "type": "string", + "description": "Describes the type of backup, whether its full or incremental.", + "enum": [ + "Invalid", + "Full", + "Incremental" + ], + "x-ms-enum": { + "name": "BackupType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Full", + "description": "Indicates a full backup." + }, + { + "value": "Incremental", + "description": "Indicates an incremental backup. A backup chain is comprised of a full backup followed by 0 or more incremental backups." + } + ] + } + }, + "AzureBlobBackupStorageDescription": { + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + } + ], + "x-ms-discriminator-value": "AzureBlobStore", + "required": [ + "ConnectionString", + "ContainerName" + ], + "properties": { + "ConnectionString": { + "type": "string", + "description": "The connection string to connect to the Azure blob store." + }, + "ContainerName": { + "type": "string", + "description": "The name of the container in the blob store to store and enumerate backups from." + } + }, + "description": "Describes the parameters for Azure blob store used for storing and enumerating backups." + }, + "FileShareBackupStorageDescription": { + "allOf": [ + { + "$ref": "#/definitions/BackupStorageDescription" + } + ], + "x-ms-discriminator-value": "FileShare", + "required": [ + "Path" + ], + "description": "Describes the parameters for file share storage used for storing or enumerating backups.", + "properties": { + "Path": { + "type": "string", + "description": "UNC path of the file share where to store or enumerate backups from." + }, + "PrimaryUserName": { + "type": "string", + "description": "Primary user name to access the file share." + }, + "PrimaryPassword": { + "type": "string", + "description": "Primary password to access the share location." + }, + "SecondaryUserName": { + "type": "string", + "description": "Secondary user name to access the file share." + }, + "SecondaryPassword": { + "type": "string", + "description": "Secondary password to access the share location" + } + } + }, + "FrequencyBasedBackupScheduleDescription": { + "description": "Describes the frequency based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "FrequencyBased", + "required": [ + "Interval" + ], + "properties": { + "Interval": { + "type": "string", + "format": "duration", + "description": "Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy." + } + } + }, + "TimeBasedBackupScheduleDescription": { + "description": "Describes the time based backup schedule.", + "allOf": [ + { + "$ref": "#/definitions/BackupScheduleDescription" + } + ], + "x-ms-discriminator-value": "TimeBased", + "required": [ + "ScheduleFrequencyType", + "RunTimes" + ], + "properties": { + "ScheduleFrequencyType": { + "$ref": "#/definitions/BackupScheduleFrequencyType", + "description": "Describes the frequency with which to run the time based backup schedule." + }, + "RunDays": { + "$ref": "#/definitions/DayOfWeekList", + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "RunTimes": { + "$ref": "#/definitions/TimeList", + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + } + } + }, + "BackupScheduleFrequencyType": { + "type": "string", + "description": "Describes the frequency with which to run the time based backup schedule.", + "enum": [ + "Invalid", + "Daily", + "Weekly" + ], + "x-ms-enum": { + "name": "BackupScheduleFrequencyType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup schedule frequency type. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Daily", + "description": "Indicates that the time based backup schedule is repeated at a daily frequency." + }, + { + "value": "Weekly", + "description": "Indicates that the time based backup schedule is repeated at a weekly frequency." + } + ] + } + }, + "TimeList": { + "type": "array", + "items": { + "type": "string", + "format": "date-time" + }, + "description": "Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored." + }, + "DayOfWeekList": { + "type": "array", + "items": { + "$ref": "#/definitions/DayOfWeek" + }, + "description": "List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly." + }, + "DayOfWeek": { + "type": "string", + "description": "Describes the days in a week.", + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true, + "values": [ + { + "value": "Sunday", + "description": "Indicates the Day referred is Sunday." + }, + { + "value": "Monday", + "description": "Indicates the Day referred is Monday." + }, + { + "value": "Tuesday", + "description": "Indicates the Day referred is Tuesday." + }, + { + "value": "Wednesday", + "description": "Indicates the Day referred is Wednesday." + }, + { + "value": "Thursday", + "description": "Indicates the Day referred is Thursday." + }, + { + "value": "Friday", + "description": "Indicates the Day referred is Friday." + }, + { + "value": "Saturday", + "description": "Indicates the Day referred is Saturday." + } + ] + } + }, + "BackupProgressInfo": { + "description": "Describes the progress of a partition's backup.", + "properties": { + "BackupState": { + "$ref": "#/definitions/BackupState", + "description": "Represents the current state of the partition backup operation." + }, + "TimeStampUtc": { + "type": "string", + "format": "date-time", + "description": "TimeStamp in UTC when operation succeeded or failed." + }, + "BackupId": { + "type": "string", + "format": "uuid", + "description": "Unique ID of the newly created backup." + }, + "BackupLocation": { + "type": "string", + "description": "Location, relative to the backup store, of the newly created backup." + }, + "EpochOfLastBackupRecord": { + "$ref": "#/definitions/Epoch", + "description": "Specifies the epoch of the last record included in backup." + }, + "LsnOfLastBackupRecord": { + "type": "string", + "description": "The LSN of last record included in backup." + }, + "FailureError": { + "$ref": "#/definitions/FabricErrorError", + "description": "Denotes the failure encountered in performing backup operation." + } + } + }, + "BackupConfigurationInfo": { + "discriminator": "Kind", + "description": "Describes the backup configuration information.", + "properties": { + "Kind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + }, + "PolicyName": { + "description": "The name of the backup policy which is applicable to this Service Fabric application or service or partition.", + "type": "string" + }, + "PolicyInheritedFrom": { + "$ref": "#/definitions/BackupPolicyScope", + "description": "Specifies the scope at which the backup policy is applied." + }, + "SuspensionInfo": { + "$ref": "#/definitions/BackupSuspensionInfo", + "description": "Describes the backup suspension details." + } + }, + "required": [ + "Kind" + ] + }, + "PartitionBackupConfigurationInfo": { + "description": "Backup configuration information, for a specific partition, specifying what backup policy is being applied and suspend description, if any.", + "allOf": [ + { + "$ref": "#/definitions/BackupConfigurationInfo" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The partition ID indentifying the partition." + } + }, + "x-ms-discriminator-value": "Partition" + }, + "BackupState": { + "type": "string", + "description": "Represents the current state of the partition backup operation.", + "enum": [ + "Invalid", + "Accepted", + "BackupInProgress", + "Success", + "Failure", + "Timeout" + ], + "x-ms-enum": { + "name": "BackupState", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid backup state. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Accepted", + "description": "Operation has been validated and accepted. Backup is yet to be triggered." + }, + { + "value": "BackupInProgress", + "description": "Backup operation has been triggered and is under process." + }, + { + "value": "Success", + "description": "Operation completed with success." + }, + { + "value": "Failure", + "description": "Operation completed with failure." + }, + { + "value": "Timeout", + "description": "Operation timed out." + } + ] + } + }, + "BackupEntity": { + "discriminator": "EntityKind", + "description": "Describes the Service Fabric entity that is configured for backup.", + "properties": { + "EntityKind": { + "$ref": "#/definitions/BackupEntityKind", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled." + } + }, + "required": [ + "EntityKind" + ] + }, + "ApplicationBackupEntity": { + "description": "Identifies the Service Fabric application which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + } + ], + "properties": { + "ApplicationName": { + "$ref": "#/definitions/ApplicationName", + "description": "The name of the application, including the 'fabric:' URI scheme." + } + }, + "x-ms-discriminator-value": "Application" + }, + "ServiceBackupEntity": { + "description": "Identifies the Service Fabric stateful service which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + } + }, + "x-ms-discriminator-value": "Service" + }, + "PartitionBackupEntity": { + "description": "Identifies the Service Fabric stateful partition which is being backed up.", + "allOf": [ + { + "$ref": "#/definitions/BackupEntity" + } + ], + "properties": { + "ServiceName": { + "$ref": "#/definitions/ServiceName", + "description": "The full name of the service with 'fabric:' URI scheme." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "The partition ID indentifying the partition." + } + }, + "x-ms-discriminator-value": "Partition" + }, + "EnableBackupDescription": { + "description": "Specifies the parameters needed to enable periodic backup.", + "required": [ + "BackupPolicyName" + ], + "properties": { + "BackupPolicyName": { + "type": "string", + "description": "Name of the backup policy to be used for enabling periodic backups." + } + } + }, + "PagedBackupEntityList": { + "description": "The list of backup entities that are being periodically backed. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of backup entity information.", + "items": { + "$ref": "#/definitions/BackupEntity" + } + } + } + }, + "BackupSuspensionInfo": { + "description": "Describes the backup suspension details.", + "properties": { + "IsSuspended": { + "type": "boolean", + "description": "Indicates whether periodic backup is suspended at this level or not." + }, + "SuspensionInheritedFrom": { + "$ref": "#/definitions/BackupSuspensionScope", + "description": "Specifies the scope at which the backup suspension was applied." + } + } + }, + "BackupEntityKind": { + "type": "string", + "description": "The entity type of a Service Fabric entity such as Application, Service or a Partition where periodic backups can be enabled.", + "enum": [ + "Invalid", + "Partition", + "Service", + "Application" + ], + "x-ms-enum": { + "name": "BackupEntityKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid entity kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "Partition", + "description": "Indicates the entity is a Service Fabric partition." + }, + { + "value": "Service", + "description": "Indicates the entity is a Service Fabric service." + }, + { + "value": "Application", + "description": "Indicates the entity is a Service Fabric application." + } + ] + } + }, + "GetBackupByStorageQueryDescription": { + "description": "Describes additional filters to be applied, while listing backups, and backup storage details from where to fetch the backups.", + "required": [ + "Storage", + "BackupEntity" + ], + "properties": { + "StartDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning." + }, + "EndDateTimeFilter": { + "type": "string", + "format": "date-time", + "description": "Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end." + }, + "Latest": { + "type": "boolean", + "default": false, + "description": "If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity." + }, + "Storage": { + "$ref": "#/definitions/BackupStorageDescription", + "description": "Describes the parameters for the backup storage from where to enumerate backups. This is optional and by default backups are enumerated from the backup storage where this backup entity is currently being backed up (as specified in backup policy). This parameter is useful to be able to enumerate backups from another cluster where you may intend to restore." + }, + "BackupEntity": { + "$ref": "#/definitions/BackupEntity", + "description": "Indicates the entity for which to enumerate backups." + } + } + }, + "NodeImpact": { + "description": "Describes the expected impact of a repair to a particular node.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "NodeName": { + "type": "string", + "description": "The name of the impacted node." + }, + "ImpactLevel": { + "type": "string", + "enum": [ + "Invalid", + "None", + "Restart", + "RemoveData", + "RemoveNode" + ], + "description": "The level of impact expected.", + "x-ms-enum": { + "name": "ImpactLevel", + "modelAsString": true, + "values": [ + { + "value": "Invalid" + }, + { + "value": "None" + }, + { + "value": "Restart" + }, + { + "value": "RemoveData" + }, + { + "value": "RemoveNode" + } + ] + } + } + }, + "required": [ + "NodeName" + ] + }, + "NodeRepairImpactDescription": { + "description": "Describes the expected impact of a repair on a set of nodes.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairImpactDescriptionBase" + } + ], + "properties": { + "NodeImpactList": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeImpact" + }, + "description": "The list of nodes impacted by a repair action and their respective expected impact." + } + } + }, + "NodeRepairTargetDescription": { + "description": "Describes the list of nodes targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "x-ms-discriminator-value": "Node", + "allOf": [ + { + "$ref": "#/definitions/RepairTargetDescriptionBase" + } + ], + "properties": { + "NodeNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of nodes targeted by a repair action." + } + } + }, + "RepairImpactDescriptionBase": { + "discriminator": "Kind", + "description": "Describes the expected impact of executing a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairImpactKind", + "description": "The kind of repair impact represented by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairImpactKind": { + "description": "Specifies the kind of the impact. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairImpactKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair impact is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair impact affects a set of Service Fabric nodes." + } + ] + } + }, + "RepairTargetDescriptionBase": { + "discriminator": "Kind", + "description": "Describes the entities targeted by a repair action.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Kind": { + "$ref": "#/definitions/RepairTargetKind", + "description": "The kind of repair target described by the current object." + } + }, + "required": [ + "Kind" + ] + }, + "RepairTargetKind": { + "description": "Specifies the kind of the repair target. This type supports the Service Fabric platform; it is not meant to be used directly from your code.'", + "type": "string", + "enum": [ + "Invalid", + "Node" + ], + "x-ms-enum": { + "name": "RepairTargetKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "The repair target is not valid or is of an unknown type." + }, + { + "value": "Node", + "description": "The repair target is a set of Service Fabric nodes." + } + ] + } + }, + "RepairTask": { + "description": "Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The version of the repair task.\nWhen creating a new repair task, the version must be set to zero. When updating a repair task,\nthe version is used for optimistic concurrency checks. If the version is\nset to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the\nupdate will only succeed if the actual current version of the repair task matches this value." + }, + "Description": { + "type": "string", + "description": "A description of the purpose of the repair task, or other informational details.\nMay be set when the repair task is created, and is immutable once set." + }, + "State": { + "type": "string", + "enum": [ + "Invalid", + "Created", + "Claimed", + "Preparing", + "Approved", + "Executing", + "Restoring", + "Completed" + ], + "description": "The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.", + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Created", + "description": "Indicates that the repair task has been created." + }, + { + "value": "Claimed", + "description": "Indicates that the repair task has been claimed by a repair executor." + }, + { + "value": "Preparing", + "description": "Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully." + }, + { + "value": "Approved", + "description": "Indicates that the repair task has been approved by the Repair Manager and is safe to execute." + }, + { + "value": "Executing", + "description": "Indicates that execution of the repair task is in progress." + }, + { + "value": "Restoring", + "description": "Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online." + }, + { + "value": "Completed", + "description": "Indicates that the repair task has completed, and no further state changes will occur." + } + ] + } + }, + "Flags": { + "type": "integer", + "description": "A bitwise-OR of the following values, which gives additional details about the status of the repair task.\n- 1 - Cancellation of the repair has been requested\n- 2 - Abort of the repair has been requested\n- 4 - Approval of the repair was forced via client request" + }, + "Action": { + "type": "string", + "description": "The requested repair action. Must be specified when the repair task is created, and is immutable once set." + }, + "Target": { + "$ref": "#/definitions/RepairTargetDescriptionBase", + "description": "The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nMay be set when the repair task is created, and is immutable once set." + }, + "Executor": { + "type": "string", + "description": "The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set." + }, + "ExecutorData": { + "type": "string", + "description": "A data string that the repair executor can use to store its internal state." + }, + "Impact": { + "$ref": "#/definitions/RepairImpactDescriptionBase", + "description": "The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair.\nImpact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set." + }, + "ResultStatus": { + "type": "string", + "enum": [ + "Invalid", + "Succeeded", + "Cancelled", + "Interrupted", + "Failed", + "Pending" + ], + "description": "A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.", + "x-ms-enum": { + "name": "ResultStatus", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value." + }, + { + "value": "Succeeded", + "description": "Indicates that the repair task completed execution successfully." + }, + { + "value": "Cancelled", + "description": "Indicates that the repair task was cancelled prior to execution." + }, + { + "value": "Interrupted", + "description": "Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed." + }, + { + "value": "Failed", + "description": "Indicates that there was a failure during execution of the repair task. Some work may have been performed." + }, + { + "value": "Pending", + "description": "Indicates that the repair task result is not yet available, because the repair task has not finished executing." + } + ] + } + }, + "ResultCode": { + "type": "integer", + "description": "A numeric value providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "ResultDetails": { + "type": "string", + "description": "A string providing additional details about the result of the repair task execution.\nMay be specified in the Restoring and later states, and is immutable once set." + }, + "History": { + "$ref": "#/definitions/RepairTaskHistory", + "description": "An object that contains timestamps of the repair task's state transitions.\nThese timestamps are updated by the system, and cannot be directly modified." + }, + "PreparingHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Preparing state." + }, + "RestoringHealthCheckState": { + "$ref": "#/definitions/RepairTaskHealthCheckState", + "description": "The workflow state of the health check when the repair task is in the Restoring state." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Preparing state." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A value to determine if health checks will be performed when the repair task enters the Restoring state." + } + }, + "required": [ + "TaskId", + "Action", + "State" + ] + }, + "RepairTaskApproveDescription": { + "description": "Describes a request for forced approval of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskCancelDescription": { + "description": "Describes a request to cancel a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + }, + "RequestAbort": { + "type": "boolean", + "description": "_True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskDeleteDescription": { + "description": "Describes a request to delete a completed repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the completed repair task to be deleted." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskHealthCheckState": { + "description": "Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Succeeded", + "Skipped", + "TimedOut" + ], + "x-ms-enum": { + "name": "RepairTaskHealthCheckState", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "Indicates that the health check has not started." + }, + { + "value": "InProgress", + "description": "Indicates that the health check is in progress." + }, + { + "value": "Succeeded", + "description": "Indicates that the health check succeeded." + }, + { + "value": "Skipped", + "description": "Indicates that the health check was skipped." + }, + { + "value": "TimedOut", + "description": "Indicates that the health check timed out." + } + ] + } + }, + "RepairTaskHistory": { + "description": "A record of the times when the repair task entered each state.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "CreatedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Created state." + }, + "ClaimedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Claimed state." + }, + "PreparingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Preparing state." + }, + "ApprovedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Approved state" + }, + "ExecutingUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Executing state" + }, + "RestoringUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Restoring state" + }, + "CompletedUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task entered the Completed state" + }, + "PreparingHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Preparing state." + }, + "PreparingHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Preparing state." + }, + "RestoringHealthCheckStartUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task started the health check in the Restoring state." + }, + "RestoringHealthCheckEndUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "The time when the repair task completed the health check in the Restoring state." + } + } + }, + "RepairTaskList": { + "type": "array", + "description": "A list of repair tasks.", + "items": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskUpdateHealthPolicyDescription": { + "description": "Describes a request to update the health policy of a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "TaskId": { + "type": "string", + "description": "The ID of the repair task to be updated." + }, + "Version": { + "type": "string", + "description": "The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed." + }, + "PerformPreparingHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + }, + "PerformRestoringHealthCheck": { + "type": "boolean", + "description": "A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value." + } + }, + "required": [ + "TaskId" + ] + }, + "RepairTaskUpdateInfo": { + "description": "Describes the result of an operation that created or updated a repair task.\n\nThis type supports the Service Fabric platform; it is not meant to be used directly from your code.", + "properties": { + "Version": { + "type": "string", + "description": "The new version of the repair task." + } + }, + "required": [ + "Version" + ] + }, + "ReconfigurationInformation": { + "description": "Information about current reconfiguration like phase, type, previous configuration role of replica and reconfiguration start date time.", + "properties": { + "PreviousConfigurationRole": { + "$ref": "#/definitions/ReplicaRole", + "description": "Replica role before reconfiguration started." + }, + "ReconfigurationPhase": { + "$ref": "#/definitions/ReconfigurationPhase", + "description": "Current phase of ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationType": { + "$ref": "#/definitions/ReconfigurationType", + "description": "Type of current ongoing reconfiguration. If no reconfiguration is taking place then this value will be \"None\"." + }, + "ReconfigurationStartTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Start time (in UTC) of the ongoing reconfiguration. If no reconfiguration is taking place then this value will be zero date-time." + } + } + }, + "ReconfigurationPhase": { + "type": "string", + "description": "The reconfiguration phase of a replica of a stateful service.", + "enum": [ + "Unknown", + "None", + "Phase0", + "Phase1", + "Phase2", + "Phase3", + "Phase4", + "AbortPhaseZero" + ], + "x-ms-enum": { + "name": "ReconfigurationPhase", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration phase." + }, + { + "value": "None", + "description": "Specifies that there is no reconfiguration in progress." + }, + { + "value": "Phase0", + "description": "Refers to the phase where the reconfiguration is transferring data from the previous primary to the new primary." + }, + { + "value": "Phase1", + "description": "Refers to the phase where the reconfiguration is querying the replica set for the progress." + }, + { + "value": "Phase2", + "description": "Refers to the phase where the reconfiguration is ensuring that data from the current primary is present in a majority of the replica set." + }, + { + "value": "Phase3", + "description": "This phase is for internal use only." + }, + { + "value": "Phase4", + "description": "This phase is for internal use only." + }, + { + "value": "AbortPhaseZero", + "description": "This phase is for internal use only." + } + ] + } + }, + "ReconfigurationType": { + "type": "string", + "description": "The type of reconfiguration for replica of a stateful service.", + "enum": [ + "Unknown", + "SwapPrimary", + "Failover", + "Other" + ], + "x-ms-enum": { + "name": "ReconfigurationType", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the invalid reconfiguration type." + }, + { + "value": "SwapPrimary", + "description": "Specifies that the primary replica is being swapped with a different replica." + }, + { + "value": "Failover", + "description": "Reconfiguration triggered in response to a primary going down. This could be due to many reasons such as primary replica crashing etc." + }, + { + "value": "Other", + "description": "Reconfigurations where the primary replica is not changing." + } + ] + } + }, + "InfrastructureServiceResponse": { + "type": "string", + "format": "binary", + "description": "This is a weakly-typed response stream to the client. It contains the JSON response from the infrastructure service without deserialization.\nThe content of the response depends on which command was issued to the infrastructure service." + }, + "UploadChunkRange": { + "description": "Information about which portion of the file to upload.", + "properties": { + "StartPosition": { + "type": "string", + "description": "The start position of the portion of the file. It's represented by the number of bytes." + }, + "EndPosition": { + "type": "string", + "description": "The end position of the portion of the file. It's represented by the number of bytes." + } + } + }, + "UploadSessionInfo": { + "description": "Information about an image store upload session. A session is associated with a relative path in the image store.", + "properties": { + "StoreRelativePath": { + "type": "string", + "description": "The remote location within image store. This path is relative to the image store root." + }, + "SessionId": { + "type": "string", + "format": "uuid", + "description": "A unique ID of the upload session. A session ID can be reused only if the session was committed or removed." + }, + "ModifiedDate": { + "type": "string", + "format": "date-time", + "description": "The date and time when the upload session was last modified." + }, + "FileSize": { + "type": "string", + "description": "The size in bytes of the uploading file." + }, + "ExpectedRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadChunkRange" + }, + "description": "List of chunk ranges that image store has not received yet." + } + } + }, + "UploadSession": { + "description": "Information about a image store upload session", + "properties": { + "UploadSessions": { + "type": "array", + "items": { + "$ref": "#/definitions/UploadSessionInfo" + }, + "description": "When querying upload session by upload session ID, the result contains only one upload session. When querying upload session by image store relative path, the result might contain multiple upload sessions." + } + } + }, + "ScalingPolicyDescription": { + "description": "Describes how the scaling should be performed", + "required": [ + "ScalingTrigger", + "ScalingMechanism" + ], + "properties": { + "ScalingTrigger": { + "$ref": "#/definitions/ScalingTriggerDescription", + "description": "Specifies the trigger associated with this scaling policy" + }, + "ScalingMechanism": { + "$ref": "#/definitions/ScalingMechanismDescription", + "description": "Specifies the mechanism associated with this scaling policy" + } + } + }, + "ScalingPolicyDescriptionList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicyDescription" + }, + "description": "A list that describes the scaling policies." + }, + "ScalingTriggerDescription": { + "discriminator": "Kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingTriggerKind", + "description": "Specifies the kind of scaling trigger" + } + } + }, + "ScalingMechanismDescription": { + "discriminator": "Kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "Kind" + ], + "properties": { + "Kind": { + "$ref": "#/definitions/ScalingMechanismKind", + "description": "Specifies the kind of scaling mechanism" + } + } + }, + "ScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "AveragePartitionLoad", + "AverageServiceLoad" + ], + "x-ms-enum": { + "name": "ScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling trigger is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "AveragePartitionLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a partition. The value is 1." + }, + { + "value": "AverageServiceLoad", + "description": "Indicates a trigger where scaling decisions are made based on average load of a service. The value is 2." + } + ] + } + }, + "ScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be scaled.", + "enum": [ + "Invalid", + "PartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates the scaling mechanism is invalid. All Service Fabric enumerations have the invalid type. The value is zero." + }, + { + "value": "PartitionInstanceCount", + "description": "Indicates a mechanism for scaling where new instances are added or removed from a partition. The value is 1." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Indicates a mechanism for scaling where new named partitions are added or removed from a service. The value is 2." + } + ] + } + }, + "AveragePartitionLoadScalingTrigger": { + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTriggerDescription" + } + ], + "x-ms-discriminator-value": "AverageServiceLoad", + "required": [ + "MetricName", + "LowerLoadThreshold", + "UpperLoadThreshold", + "ScaleIntervalInSeconds" + ], + "properties": { + "MetricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "LowerLoadThreshold": { + "type": "string", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "UpperLoadThreshold": { + "type": "string", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "ScaleIntervalInSeconds": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The period in seconds on which a decision is made whether to scale or not." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + } + ], + "x-ms-discriminator-value": "PartitionInstanceCount", + "required": [ + "MinInstanceCount", + "MaxInstanceCount", + "ScaleIncrement" + ], + "properties": { + "MinInstanceCount": { + "type": "integer", + "description": "Minimum number of instances of the partition." + }, + "MaxInstanceCount": { + "type": "integer", + "description": "Maximum number of instances of the partition." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1''N-1'", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanismDescription" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "MinPartitionCount", + "MaxPartitionCount", + "ScaleIncrement" + ], + "properties": { + "MinPartitionCount": { + "type": "integer", + "description": "Minimum number of named partitions of the service." + }, + "MaxPartitionCount": { + "type": "integer", + "description": "Maximum number of named partitions of the service." + }, + "ScaleIncrement": { + "type": "integer", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationCreatedEvent": { + "description": "Application Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "ApplicationDefinitionKind": { + "type": "string", + "description": "Application definition kind." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "ApplicationDefinitionKind" + ], + "x-ms-discriminator-value": "ApplicationCreated" + }, + "ApplicationDeletedEvent": { + "description": "Application Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion" + ], + "x-ms-discriminator-value": "ApplicationDeleted" + }, + "ApplicationNewHealthReportEvent": { + "description": "Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ApplicationNewHealthReport" + }, + "ApplicationHealthReportExpiredEvent": { + "description": "Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ApplicationHealthReportExpired" + }, + "ApplicationUpgradeCompletedEvent": { + "description": "Application Upgrade Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ApplicationUpgradeCompleted" + }, + "ApplicationUpgradeDomainCompletedEvent": { + "description": "Application Upgrade Domain Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Upgrade time of domain in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ApplicationUpgradeDomainCompleted" + }, + "ApplicationUpgradeRollbackCompletedEvent": { + "description": "Application Upgrade Rollback Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackCompleted" + }, + "ApplicationUpgradeRollbackStartedEvent": { + "description": "Application Upgrade Rollback Started event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "FailureReason": { + "type": "string", + "description": "Describes reason of failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall upgrade time in milli-seconds." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ApplicationUpgradeRollbackStarted" + }, + "ApplicationUpgradeStartedEvent": { + "description": "Application Upgrade Started event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "CurrentApplicationTypeVersion": { + "type": "string", + "description": "Current Application type version." + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "Target Application type version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "ApplicationTypeName", + "CurrentApplicationTypeVersion", + "ApplicationTypeVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ], + "x-ms-discriminator-value": "ApplicationUpgradeStarted" + }, + "DeployedApplicationNewHealthReportEvent": { + "description": "Deployed Application Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "DeployedApplicationNewHealthReport" + }, + "DeployedApplicationHealthReportExpiredEvent": { + "description": "Deployed Application Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ApplicationInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Application instance." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ApplicationInstanceId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "DeployedApplicationHealthReportExpired" + }, + "ApplicationProcessExitedEvent": { + "description": "Process Exited event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ExeName": { + "type": "string", + "description": "Name of executable." + }, + "ProcessId": { + "type": "integer", + "format": "int64", + "description": "Process Id." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ExeName", + "ProcessId", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ], + "x-ms-discriminator-value": "ApplicationProcessExited" + }, + "ApplicationContainerInstanceExitedEvent": { + "description": "Container Exited event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ServiceName": { + "type": "string", + "description": "Name of Service." + }, + "ServicePackageName": { + "type": "string", + "description": "Name of Service package." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Activation Id of Service package." + }, + "IsExclusive": { + "type": "boolean", + "description": "Indicates IsExclusive flag." + }, + "CodePackageName": { + "type": "string", + "description": "Name of Code package." + }, + "EntryPointType": { + "type": "string", + "description": "Type of EntryPoint." + }, + "ImageName": { + "type": "string", + "description": "Name of Container image." + }, + "ContainerName": { + "type": "string", + "description": "Name of Container." + }, + "HostId": { + "type": "string", + "description": "Host Id." + }, + "ExitCode": { + "type": "integer", + "format": "int64", + "description": "Exit code of process." + }, + "UnexpectedTermination": { + "type": "boolean", + "description": "Indicates if termination is unexpected." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of process." + } + }, + "required": [ + "ServiceName", + "ServicePackageName", + "ServicePackageActivationId", + "IsExclusive", + "CodePackageName", + "EntryPointType", + "ImageName", + "ContainerName", + "HostId", + "ExitCode", + "UnexpectedTermination", + "StartTime" + ], + "x-ms-discriminator-value": "ApplicationContainerInstanceExited" + }, + "NodeAbortedEvent": { + "description": "Node Aborted event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ], + "x-ms-discriminator-value": "NodeAborted" + }, + "NodeAddedToClusterEvent": { + "description": "Node Added event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ], + "x-ms-discriminator-value": "NodeAddedToCluster" + }, + "NodeClosedEvent": { + "description": "Node Closed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "Error": { + "type": "string", + "description": "Describes error." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "Error" + ], + "x-ms-discriminator-value": "NodeClosed" + }, + "NodeDeactivateCompletedEvent": { + "description": "Node Deactivate Completed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "EffectiveDeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + }, + "BatchIdsWithDeactivateIntent": { + "type": "string", + "description": "Batch Ids." + }, + "StartTime": { + "type": "string", + "format": "date-time", + "description": "Start time." + } + }, + "required": [ + "NodeInstance", + "EffectiveDeactivateIntent", + "BatchIdsWithDeactivateIntent", + "StartTime" + ], + "x-ms-discriminator-value": "NodeDeactivateCompleted" + }, + "NodeDeactivateStartedEvent": { + "description": "Node Deactivate Started event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "BatchId": { + "type": "string", + "description": "Batch Id." + }, + "DeactivateIntent": { + "type": "string", + "description": "Describes deactivate intent." + } + }, + "required": [ + "NodeInstance", + "BatchId", + "DeactivateIntent" + ], + "x-ms-discriminator-value": "NodeDeactivateStarted" + }, + "NodeDownEvent": { + "description": "Node Down event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeUpAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last up." + } + }, + "required": [ + "NodeInstance", + "LastNodeUpAt" + ], + "x-ms-discriminator-value": "NodeDown" + }, + "NodeNewHealthReportEvent": { + "description": "Node Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "NodeNewHealthReport" + }, + "NodeHealthReportExpiredEvent": { + "description": "Node Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "NodeInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "NodeHealthReportExpired" + }, + "NodeOpenSucceededEvent": { + "description": "Node Opened Succeeded event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion" + ], + "x-ms-discriminator-value": "NodeOpenSucceeded" + }, + "NodeOpenFailedEvent": { + "description": "Node Open Failed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "UpgradeDomain": { + "type": "string", + "description": "Upgrade domain of Node." + }, + "FaultDomain": { + "type": "string", + "description": "Fault domain of Node." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "Hostname": { + "type": "string", + "description": "Name of Host." + }, + "IsSeedNode": { + "type": "boolean", + "description": "Indicates if it is seed node." + }, + "NodeVersion": { + "type": "string", + "description": "Version of Node." + }, + "Error": { + "type": "string", + "description": "Describes the error." + } + }, + "required": [ + "NodeInstance", + "NodeId", + "UpgradeDomain", + "FaultDomain", + "IpAddressOrFQDN", + "Hostname", + "IsSeedNode", + "NodeVersion", + "Error" + ], + "x-ms-discriminator-value": "NodeOpenFailed" + }, + "NodeRemovedFromClusterEvent": { + "description": "Node Removed event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeId": { + "type": "string", + "description": "Id of Node." + }, + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "NodeType": { + "type": "string", + "description": "Type of Node." + }, + "FabricVersion": { + "type": "string", + "description": "Fabric version." + }, + "IpAddressOrFQDN": { + "type": "string", + "description": "IP address or FQDN." + }, + "NodeCapacities": { + "type": "string", + "description": "Capacities." + } + }, + "required": [ + "NodeId", + "NodeInstance", + "NodeType", + "FabricVersion", + "IpAddressOrFQDN", + "NodeCapacities" + ], + "x-ms-discriminator-value": "NodeRemovedFromCluster" + }, + "NodeUpEvent": { + "description": "Node Up event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "LastNodeDownAt": { + "type": "string", + "format": "date-time", + "description": "Time when Node was last down." + } + }, + "required": [ + "NodeInstance", + "LastNodeDownAt" + ], + "x-ms-discriminator-value": "NodeUp" + }, + "PartitionNewHealthReportEvent": { + "description": "Partition Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "PartitionNewHealthReport" + }, + "PartitionHealthReportExpiredEvent": { + "description": "Partition Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "PartitionHealthReportExpired" + }, + "PartitionReconfiguredEvent": { + "description": "Partition Reconfiguration event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "NodeInstanceId": { + "type": "string", + "description": "Id of Node instance." + }, + "ServiceType": { + "type": "string", + "description": "Type of Service." + }, + "CcEpochDataLossVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochDataLoss version." + }, + "CcEpochConfigVersion": { + "type": "integer", + "format": "int64", + "description": "CcEpochConfig version." + }, + "ReconfigType": { + "type": "string", + "description": "Type of reconfiguration." + }, + "Result": { + "type": "string", + "description": "Describes reconfiguration result." + }, + "Phase0DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase0 in milli-seconds." + }, + "Phase1DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase1 in milli-seconds." + }, + "Phase2DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase2 in milli-seconds." + }, + "Phase3DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase3 in milli-seconds." + }, + "Phase4DurationMs": { + "type": "number", + "format": "double", + "description": "Duration of Phase4 in milli-seconds." + }, + "TotalDurationMs": { + "type": "number", + "format": "double", + "description": "Total duration in milli-seconds." + } + }, + "required": [ + "NodeName", + "NodeInstanceId", + "ServiceType", + "CcEpochDataLossVersion", + "CcEpochConfigVersion", + "ReconfigType", + "Result", + "Phase0DurationMs", + "Phase1DurationMs", + "Phase2DurationMs", + "Phase3DurationMs", + "Phase4DurationMs", + "TotalDurationMs" + ], + "x-ms-discriminator-value": "PartitionReconfigured" + }, + "PartitionPrimaryMoveAnalysisEvent": { + "description": "Partition Primary Move Analysis event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionAnalysisEvent" + } + ], + "properties": { + "WhenMoveCompleted": { + "type": "string", + "format": "date-time", + "description": "Time when the move was completed." + }, + "PreviousNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "CurrentNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "MoveReason": { + "type": "string", + "description": "Move reason." + }, + "RelevantTraces": { + "type": "string", + "description": "Relevant traces." + } + }, + "required": [ + "WhenMoveCompleted", + "PreviousNode", + "CurrentNode", + "MoveReason", + "RelevantTraces" + ], + "x-ms-discriminator-value": "PartitionPrimaryMoveAnalysis" + }, + "ServiceCreatedEvent": { + "description": "Service Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + } + ], + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + }, + "PartitionId": { + "$ref": "#/definitions/PartitionId", + "description": "An internal ID used by Service Fabric to uniquely identify a partition. This is a randomly generated GUID when the service was created. The partition ID is unique and does not change for the lifetime of the service. If the same service was deleted and recreated the IDs of its partitions would be different." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion", + "PartitionId" + ], + "x-ms-discriminator-value": "ServiceCreated" + }, + "ServiceDeletedEvent": { + "description": "Service Deleted event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + } + ], + "properties": { + "ServiceTypeName": { + "type": "string", + "description": "Service type name." + }, + "ApplicationName": { + "type": "string", + "description": "Application name." + }, + "ApplicationTypeName": { + "type": "string", + "description": "Application type name." + }, + "ServiceInstance": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "IsStateful": { + "type": "boolean", + "description": "Indicates if Service is stateful." + }, + "PartitionCount": { + "type": "integer", + "format": "int32", + "description": "Number of partitions." + }, + "TargetReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Size of target replicas set." + }, + "MinReplicaSetSize": { + "type": "integer", + "format": "int32", + "description": "Minimum size of replicas set." + }, + "ServicePackageVersion": { + "type": "string", + "description": "Version of Service package." + } + }, + "required": [ + "ServiceTypeName", + "ApplicationName", + "ApplicationTypeName", + "ServiceInstance", + "IsStateful", + "PartitionCount", + "TargetReplicaSetSize", + "MinReplicaSetSize", + "ServicePackageVersion" + ], + "x-ms-discriminator-value": "ServiceDeleted" + }, + "ServiceNewHealthReportEvent": { + "description": "Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + } + ], + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ServiceNewHealthReport" + }, + "ServiceHealthReportExpiredEvent": { + "description": "Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ServiceEvent" + } + ], + "properties": { + "InstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "InstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ServiceHealthReportExpired" + }, + "DeployedServicePackageNewHealthReportEvent": { + "description": "Deployed Service Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifestName", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "DeployedServicePackageNewHealthReport" + }, + "DeployedServicePackageHealthReportExpiredEvent": { + "description": "Deployed Service Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "ServiceManifest": { + "type": "string", + "description": "Service manifest name." + }, + "ServicePackageInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Service package instance." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ServiceManifest", + "ServicePackageInstanceId", + "ServicePackageActivationId", + "NodeName", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "DeployedServicePackageHealthReportExpired" + }, + "StatefulReplicaNewHealthReportEvent": { + "description": "Stateful Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "StatefulReplicaNewHealthReport" + }, + "StatefulReplicaHealthReportExpiredEvent": { + "description": "Stateful Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "ReplicaInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Replica instance." + }, + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "ReplicaInstanceId", + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "StatefulReplicaHealthReportExpired" + }, + "StatelessReplicaNewHealthReportEvent": { + "description": "Stateless Replica Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "StatelessReplicaNewHealthReport" + }, + "StatelessReplicaHealthReportExpiredEvent": { + "description": "Stateless Replica Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "StatelessReplicaHealthReportExpired" + }, + "ClusterNewHealthReportEvent": { + "description": "Cluster Health Report Created event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ClusterNewHealthReport" + }, + "ClusterHealthReportExpiredEvent": { + "description": "Cluster Health Report Expired event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "SourceId": { + "type": "string", + "description": "Id of report source." + }, + "Property": { + "type": "string", + "description": "Describes the property." + }, + "HealthState": { + "type": "string", + "description": "Describes the property health state." + }, + "TimeToLiveMs": { + "type": "integer", + "format": "int64", + "description": "Time to live in milli-seconds." + }, + "SequenceNumber": { + "type": "integer", + "format": "int64", + "description": "Sequence number of report." + }, + "Description": { + "type": "string", + "description": "Description of report." + }, + "RemoveWhenExpired": { + "type": "boolean", + "description": "Indicates the removal when it expires." + }, + "SourceUtcTimestamp": { + "type": "string", + "format": "date-time", + "description": "Source time." + } + }, + "required": [ + "SourceId", + "Property", + "HealthState", + "TimeToLiveMs", + "SequenceNumber", + "Description", + "RemoveWhenExpired", + "SourceUtcTimestamp" + ], + "x-ms-discriminator-value": "ClusterHealthReportExpired" + }, + "ClusterUpgradeCompletedEvent": { + "description": "Cluster Upgrade Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ClusterUpgradeCompleted" + }, + "ClusterUpgradeDomainCompletedEvent": { + "description": "Cluster Upgrade Domain Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeState": { + "type": "string", + "description": "State of upgrade." + }, + "UpgradeDomains": { + "type": "string", + "description": "Upgrade domains." + }, + "UpgradeDomainElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Duration of domain upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "UpgradeState", + "UpgradeDomains", + "UpgradeDomainElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ClusterUpgradeDomainCompleted" + }, + "ClusterUpgradeRollbackCompletedEvent": { + "description": "Cluster Upgrade Rollback Completed event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackCompleted" + }, + "ClusterUpgradeRollbackStartedEvent": { + "description": "Cluster Upgrade Rollback Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "FailureReason": { + "type": "string", + "description": "Describes failure." + }, + "OverallUpgradeElapsedTimeInMs": { + "type": "number", + "format": "double", + "description": "Overall duration of upgrade in milli-seconds." + } + }, + "required": [ + "TargetClusterVersion", + "FailureReason", + "OverallUpgradeElapsedTimeInMs" + ], + "x-ms-discriminator-value": "ClusterUpgradeRollbackStarted" + }, + "ClusterUpgradeStartedEvent": { + "description": "Cluster Upgrade Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "CurrentClusterVersion": { + "type": "string", + "description": "Current Cluster version." + }, + "TargetClusterVersion": { + "type": "string", + "description": "Target Cluster version." + }, + "UpgradeType": { + "type": "string", + "description": "Type of upgrade." + }, + "RollingUpgradeMode": { + "type": "string", + "description": "Mode of upgrade." + }, + "FailureAction": { + "type": "string", + "description": "Action if failed." + } + }, + "required": [ + "CurrentClusterVersion", + "TargetClusterVersion", + "UpgradeType", + "RollingUpgradeMode", + "FailureAction" + ], + "x-ms-discriminator-value": "ClusterUpgradeStarted" + }, + "ChaosStoppedEvent": { + "description": "Chaos Stopped event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "Reason": { + "type": "string", + "description": "Describes reason." + } + }, + "required": [ + "Reason" + ], + "x-ms-discriminator-value": "ChaosStopped" + }, + "ChaosStartedEvent": { + "description": "Chaos Started event.", + "allOf": [ + { + "$ref": "#/definitions/ClusterEvent" + } + ], + "properties": { + "MaxConcurrentFaults": { + "type": "integer", + "format": "int64", + "description": "Maximum number of concurrent faults." + }, + "TimeToRunInSeconds": { + "type": "number", + "format": "double", + "description": "Time to run in seconds." + }, + "MaxClusterStabilizationTimeoutInSeconds": { + "type": "number", + "format": "double", + "description": "Maximum timeout for cluster stabilization in seconds." + }, + "WaitTimeBetweenIterationsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between iterations in seconds." + }, + "WaitTimeBetweenFautlsInSeconds": { + "type": "number", + "format": "double", + "description": "Wait time between faults in seconds." + }, + "MoveReplicaFaultEnabled": { + "type": "boolean", + "description": "Indicates MoveReplica fault is enabled." + }, + "IncludedNodeTypeList": { + "type": "string", + "description": "List of included Node types." + }, + "IncludedApplicationList": { + "type": "string", + "description": "List of included Applications." + }, + "ClusterHealthPolicy": { + "type": "string", + "description": "Health policy." + }, + "ChaosContext": { + "type": "string", + "description": "Chaos Context." + } + }, + "required": [ + "MaxConcurrentFaults", + "TimeToRunInSeconds", + "MaxClusterStabilizationTimeoutInSeconds", + "WaitTimeBetweenIterationsInSeconds", + "WaitTimeBetweenFautlsInSeconds", + "MoveReplicaFaultEnabled", + "IncludedNodeTypeList", + "IncludedApplicationList", + "ClusterHealthPolicy", + "ChaosContext" + ], + "x-ms-discriminator-value": "ChaosStarted" + }, + "ChaosCodePackageRestartScheduledEvent": { + "description": "Chaos Restart Code Package Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ApplicationEvent" + } + ], + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "NodeName": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ServiceManifestName": { + "type": "string", + "description": "Service manifest name." + }, + "CodePackageName": { + "type": "string", + "description": "Code package name." + }, + "ServicePackageActivationId": { + "type": "string", + "description": "Id of Service package activation." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "NodeName", + "ServiceManifestName", + "CodePackageName", + "ServicePackageActivationId" + ], + "x-ms-discriminator-value": "ChaosCodePackageRestartScheduled" + }, + "ChaosReplicaRemovalScheduledEvent": { + "description": "Chaos Remove Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ], + "x-ms-discriminator-value": "ChaosReplicaRemovalScheduled" + }, + "ChaosPartitionSecondaryMoveScheduledEvent": { + "description": "Chaos Move Secondary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "SourceNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "DestinationNode": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "SourceNode", + "DestinationNode", + "ForcedMove" + ], + "x-ms-discriminator-value": "ChaosPartitionSecondaryMoveScheduled" + }, + "ChaosPartitionPrimaryMoveScheduledEvent": { + "description": "Chaos Move Primary Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/PartitionEvent" + } + ], + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceName": { + "type": "string", + "description": "Service name." + }, + "NodeTo": { + "$ref": "#/definitions/NodeName", + "description": "The name of a Service Fabric node." + }, + "ForcedMove": { + "type": "boolean", + "description": "Indicates a forced move." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceName", + "NodeTo", + "ForcedMove" + ], + "x-ms-discriminator-value": "ChaosPartitionPrimaryMoveScheduled" + }, + "ChaosReplicaRestartScheduledEvent": { + "description": "Chaos Restart Replica Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/ReplicaEvent" + } + ], + "properties": { + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + }, + "ServiceUri": { + "type": "string", + "description": "Service name." + } + }, + "required": [ + "FaultGroupId", + "FaultId", + "ServiceUri" + ], + "x-ms-discriminator-value": "ChaosReplicaRestartScheduled" + }, + "ChaosNodeRestartScheduledEvent": { + "description": "Chaos Restart Node Fault Scheduled event.", + "allOf": [ + { + "$ref": "#/definitions/NodeEvent" + } + ], + "properties": { + "NodeInstanceId": { + "type": "integer", + "format": "int64", + "description": "Id of Node instance." + }, + "FaultGroupId": { + "type": "string", + "format": "uuid", + "description": "Id of fault group." + }, + "FaultId": { + "type": "string", + "format": "uuid", + "description": "Id of fault." + } + }, + "required": [ + "NodeInstanceId", + "FaultGroupId", + "FaultId" + ], + "x-ms-discriminator-value": "ChaosNodeRestartScheduled" + }, + "ResourceStatus": { + "description": "Status of the resource.", + "type": "string", + "enum": [ + "Unknown", + "Ready", + "Upgrading", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ResourceStatus", + "modelAsString": true, + "values": [ + { + "value": "Unknown", + "description": "Indicates the resource status is unknown. The value is zero." + }, + { + "value": "Ready", + "description": "Indicates the resource is ready. The value is 1." + }, + { + "value": "Upgrading", + "description": "Indicates the resource is upgrading. The value is 2." + }, + { + "value": "Creating", + "description": "Indicates the resource is being created. The value is 3." + }, + { + "value": "Deleting", + "description": "Indicates the resource is being deletd. The value is 4." + }, + { + "value": "Failed", + "description": "Indicates the resource is not functional due to persistent failures. See statusDetails property for more details. The value is 5." + } + ] + } + }, + "SecretKind": { + "type": "string", + "description": "Describes the kind of secret.", + "enum": [ + "inlinedValue" + ], + "x-ms-enum": { + "name": "SecretKind", + "modelAsString": true, + "values": [ + { + "value": "inlinedValue", + "description": "A simple secret resource whose plaintext value is provided by the user." + } + ] + } + }, + "SecretResourceProperties": { + "description": "Describes the properties of a secret resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SecretResourcePropertiesBase" + } + ], + "properties": { + "description": { + "description": "User readable description of the secret.", + "type": "string" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the secret." + }, + "contentType": { + "type": "string", + "description": "The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed." + } + } + }, + "InlinedValueSecretResourceProperties": { + "description": "Describes the properties of a secret resource whose value is provided explicitly as plaintext. The secret resource may have multiple values, each being uniquely versioned. The secret value of each version is stored encrypted, and delivered as plaintext into the context of applications referencing it.", + "allOf": [ + { + "$ref": "#/definitions/SecretResourceProperties" + } + ], + "x-ms-discriminator-value": "inlinedValue" + }, + "SecretResourceName": { + "type": "string", + "description": "Name of the Secret resource." + }, + "SecretResourceDescription": { + "description": "This type describes a secret resource.", + "properties": { + "properties": { + "$ref": "#/definitions/SecretResourceProperties", + "description": "Describes the properties of a secret resource." + }, + "name": { + "$ref": "#/definitions/SecretResourceName", + "description": "Name of the Secret resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "PagedSecretResourceDescriptionList": { + "type": "object", + "description": "The list of secret resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/SecretResourceDescription" + } + } + }, + "x-sf-clientlib": { + "TypeName": "PagedData", + "SkipGeneration": "true" + } + }, + "SecretResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a secret resource, including its kind.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/SecretKind", + "description": "Describes the kind of secret." + } + }, + "required": [ + "kind" + ] + }, + "SecretValue": { + "type": "object", + "description": "This type represents the unencrypted value of the secret.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueProperties": { + "type": "object", + "description": "This type describes properties of secret value resource.", + "properties": { + "value": { + "type": "string", + "description": "The actual value of the secret." + } + } + }, + "SecretValueResourceDescription": { + "description": "This type describes a value of a secret resource. The name of this resource is the version identifier corresponding to this secret value.", + "properties": { + "name": { + "type": "string", + "description": "Version identifier of the secret value." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecretValueResourceProperties", + "description": "This type describes properties of a secret value resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "PagedSecretValueResourceDescriptionList": { + "type": "object", + "description": "The list of values of a secret resource, paged if the number of results exceeds the limits of a single message. The next set of results can be obtained by executing the same query with the continuation token provided in the previous page.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "items": { + "$ref": "#/definitions/SecretValueResourceDescription" + }, + "description": "One page of the list." + } + }, + "x-sf-clientlib": { + "TypeName": "PagedData", + "SkipGeneration": "true" + } + }, + "SecretValueResourceProperties": { + "description": "This type describes properties of a secret value resource.", + "allOf": [ + { + "$ref": "#/definitions/SecretValueProperties" + } + ] + }, + "VolumeProperties": { + "description": "Describes properties of a volume resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the volume." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the volume." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the volume." + }, + "provider": { + "$ref": "#/definitions/VolumeProvider", + "description": "Provider of the volume." + }, + "azureFileParameters": { + "$ref": "#/definitions/VolumeProviderParametersAzureFile", + "description": "This type describes a volume provided by an Azure Files file share." + } + }, + "required": [ + "provider" + ] + }, + "VolumeProvider": { + "type": "string", + "description": "Describes the provider of the volume resource.", + "enum": [ + "SFAzureFile" + ], + "x-ms-enum": { + "name": "VolumeProvider", + "modelAsString": true, + "values": [ + { + "value": "SFAzureFile", + "description": "Provides volumes that are backed by Azure Files." + } + ] + } + }, + "VolumeProviderParametersAzureFile": { + "description": "This type describes a volume provided by an Azure Files file share.", + "properties": { + "accountName": { + "description": "Name of the Azure storage account for the File Share.", + "type": "string" + }, + "accountKey": { + "description": "Access key of the Azure storage account for the File Share.", + "type": "string" + }, + "shareName": { + "description": "Name of the Azure Files file share that provides storage for the volume.", + "type": "string" + } + }, + "required": [ + "accountName", + "shareName" + ] + }, + "VolumeReference": { + "description": "Describes a reference to a volume resource.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the volume being referenced." + }, + "readOnly": { + "type": "boolean", + "description": "The flag indicating whether the volume is read only. Default is 'false'." + }, + "destinationPath": { + "type": "string", + "description": "The path within the container at which the volume should be mounted. Only valid path characters are allowed." + } + }, + "required": [ + "name", + "destinationPath" + ] + }, + "ApplicationScopedVolume": { + "description": "Describes a volume whose lifetime is scoped to the application's lifetime.", + "allOf": [ + { + "$ref": "#/definitions/VolumeReference" + } + ], + "properties": { + "creationParameters": { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters", + "description": "Describes parameters for creating application-scoped volumes." + } + }, + "required": [ + "creationParameters" + ] + }, + "ApplicationScopedVolumeCreationParameters": { + "description": "Describes parameters for creating application-scoped volumes.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/ApplicationScopedVolumeKind", + "description": "Specifies the application-scoped volume kind." + }, + "description": { + "description": "User readable description of the volume.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "ApplicationScopedVolumeCreationParametersServiceFabricVolumeDisk": { + "description": "Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks", + "allOf": [ + { + "$ref": "#/definitions/ApplicationScopedVolumeCreationParameters" + } + ], + "properties": { + "sizeDisk": { + "description": "Volume size", + "type": "string", + "enum": [ + "Small", + "Medium", + "Large" + ], + "x-ms-enum": { + "name": "SizeTypes", + "modelAsString": true + } + } + }, + "required": [ + "sizeDisk" + ], + "x-ms-discriminator-value": "ServiceFabricVolumeDisk" + }, + "ApplicationScopedVolumeKind": { + "description": "Specifies the application-scoped volume kind.", + "type": "string", + "enum": [ + "ServiceFabricVolumeDisk" + ], + "x-ms-enum": { + "name": "ApplicationScopedVolumeKind", + "modelAsString": true, + "values": [ + { + "value": "ServiceFabricVolumeDisk", + "description": "Provides Service Fabric High Availability Volume Disk" + } + ] + } + }, + "VolumeResourceName": { + "type": "string", + "description": "Name of the Volume resource." + }, + "VolumeResourceDescription": { + "description": "This type describes a volume resource.", + "properties": { + "name": { + "$ref": "#/definitions/VolumeResourceName", + "description": "Name of the Volume resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VolumeProperties", + "description": "Describes properties of a volume resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "PagedVolumeResourceDescriptionList": { + "type": "object", + "description": "The list of volume resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/VolumeResourceDescription" + } + } + } + }, + "NetworkKind": { + "type": "string", + "description": "The type of a Service Fabric container network.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "NetworkKind", + "modelAsString": true, + "values": [ + { + "value": "Local", + "description": "Indicates a container network local to a single Service Fabric cluster. The value is 1." + } + ] + } + }, + "NetworkResourceProperties": { + "description": "Describes properties of a network resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourcePropertiesBase" + } + ], + "properties": { + "description": { + "type": "string", + "description": "User readable description of the network." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the network." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the network." + } + } + }, + "LocalNetworkResourceProperties": { + "description": "Information about a Service Fabric container network local to a single Service Fabric cluster.", + "allOf": [ + { + "$ref": "#/definitions/NetworkResourceProperties" + } + ], + "x-ms-discriminator-value": "Local", + "properties": { + "networkAddressPrefix": { + "$ref": "#/definitions/NetworkAddressPrefix", + "description": "Address space for the local container network." + } + } + }, + "NetworkAddressPrefix": { + "type": "string", + "description": "Address space for a container network. This is expressed in CIDR notation." + }, + "NetworkRef": { + "description": "Describes a network reference in a service.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network" + }, + "endpointRefs": { + "description": "A list of endpoints that are exposed on this network.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointRef" + } + } + } + }, + "EndpointRef": { + "description": "Describes a reference to a service endpoint.", + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint." + } + } + }, + "NetworkResourceName": { + "type": "string", + "description": "Name of the Network resource." + }, + "NetworkResourceDescription": { + "description": "This type describes a network resource.", + "properties": { + "name": { + "$ref": "#/definitions/NetworkResourceName", + "description": "Name of the Network resource." + }, + "properties": { + "$ref": "#/definitions/NetworkResourceProperties", + "description": "Describes properties of a network resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "NetworkResourcePropertiesBase": { + "discriminator": "kind", + "description": "This type describes the properties of a network resource, including its kind.", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/NetworkKind", + "description": "The type of a Service Fabric container network." + } + }, + "required": [ + "kind" + ] + }, + "PagedNetworkResourceDescriptionList": { + "type": "object", + "description": "The list of network resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/NetworkResourceDescription" + } + } + } + }, + "GatewayDestination": { + "description": "Describes destination endpoint for routing traffic.", + "type": "object", + "properties": { + "applicationName": { + "type": "string", + "description": "Name of the service fabric Mesh application." + }, + "serviceName": { + "type": "string", + "description": "service that contains the endpoint." + }, + "endpointName": { + "type": "string", + "description": "name of the endpoint in the service." + } + }, + "required": [ + "applicationName", + "endpointName", + "serviceName" + ] + }, + "GatewayProperties": { + "description": "Describes properties of a gateway resource.", + "properties": { + "description": { + "description": "User readable description of the gateway.", + "type": "string" + }, + "sourceNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network the gateway should listen on for requests." + }, + "destinationNetwork": { + "$ref": "#/definitions/NetworkRef", + "description": "Network that the Application is using." + }, + "tcp": { + "description": "Configuration for tcp connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/TcpConfig" + } + }, + "http": { + "description": "Configuration for http connectivity for this gateway.", + "type": "array", + "items": { + "$ref": "#/definitions/HttpConfig" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the resource." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the gateway." + }, + "ipAddress": { + "readOnly": true, + "type": "string", + "description": "IP address of the gateway. This is populated in the response and is ignored for incoming requests." + } + }, + "required": [ + "destinationNetwork", + "sourceNetwork" + ] + }, + "HttpConfig": { + "description": "Describes the http configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "hosts": { + "type": "array", + "description": "description for routing.", + "items": { + "$ref": "#/definitions/HttpHostConfig" + } + } + }, + "required": [ + "hosts", + "name", + "port" + ] + }, + "HttpHostConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http hostname config name." + }, + "routes": { + "type": "array", + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can hamdle general cases.", + "items": { + "$ref": "#/definitions/HttpRouteConfig" + } + } + }, + "required": [ + "name", + "routes" + ] + }, + "HttpRouteConfig": { + "description": "Describes the hostname properties for http routing.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "http route name." + }, + "match": { + "$ref": "#/definitions/HttpRouteMatchRule", + "description": "Describes a rule for http route matching." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "match", + "name" + ] + }, + "HttpRouteMatchHeader": { + "description": "Describes header information for http route matching.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of header to match in request." + }, + "value": { + "type": "string", + "description": "Value of header to match in request." + }, + "type": { + "type": "string", + "description": "how to match header value", + "enum": [ + "exact" + ], + "x-ms-enum": { + "name": "HeaderMatchType", + "modelAsString": true + } + } + }, + "required": [ + "name" + ] + }, + "HttpRouteMatchPath": { + "description": "Path to match for routing.", + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "Uri path to match for request." + }, + "rewrite": { + "type": "string", + "description": "replacement string for matched part of the Uri." + }, + "type": { + "type": "string", + "description": "how to match value in the Uri", + "enum": [ + "prefix" + ], + "x-ms-enum": { + "name": "PathMatchType", + "modelAsString": true + } + } + }, + "required": [ + "type", + "value" + ] + }, + "HttpRouteMatchRule": { + "description": "Describes a rule for http route matching.", + "type": "object", + "properties": { + "path": { + "$ref": "#/definitions/HttpRouteMatchPath", + "description": "Path to match for routing." + }, + "headers": { + "type": "array", + "description": "headers and their values to match in request.", + "items": { + "$ref": "#/definitions/HttpRouteMatchHeader" + } + } + }, + "required": [ + "path" + ] + }, + "TcpConfig": { + "description": "Describes the tcp configuration for external connectivity for this network.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "tcp gateway config name." + }, + "port": { + "type": "integer", + "description": "Specifies the port at which the service endpoint below needs to be exposed." + }, + "destination": { + "$ref": "#/definitions/GatewayDestination", + "description": "Describes destination endpoint for routing traffic." + } + }, + "required": [ + "destination", + "name", + "port" + ] + }, + "GatewayResourceName": { + "type": "string", + "description": "Name of the Gateway resource." + }, + "GatewayResourceDescription": { + "description": "This type describes a gateway resource.", + "properties": { + "name": { + "$ref": "#/definitions/GatewayResourceName", + "description": "Name of the Gateway resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GatewayProperties", + "description": "Describes properties of a gateway resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "PagedGatewayResourceDescriptionList": { + "type": "object", + "description": "The list of gateway resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/GatewayResourceDescription" + } + } + } + }, + "ApplicationProperties": { + "description": "Describes properties of a application resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the application." + }, + "services": { + "type": "array", + "description": "Describes the services in the application. This property is used to create or modify services of the application. On get only the name of the service is returned. The service description can be obtained by querying for the service resource.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsDescription", + "description": "Describes the diagnostics definition and usage for an application resource." + }, + "debugParams": { + "description": "Internal - used by Visual Studio to setup the debugging session on the local development environment.", + "type": "string" + }, + "serviceNames": { + "readOnly": true, + "description": "Names of the services in the application.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the application." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the application." + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the application's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the application is marked unhealthy." + } + } + }, + "AzureInternalMonitoringPipelineSinkDescription": { + "allOf": [ + { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + ], + "x-ms-discriminator-value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva.", + "properties": { + "accountName": { + "description": "Azure Internal monitoring pipeline account.", + "type": "string" + }, + "namespace": { + "description": "Azure Internal monitoring pipeline account namespace.", + "type": "string" + }, + "maConfigUrl": { + "description": "Azure Internal monitoring agent configuration.", + "type": "string" + }, + "fluentdConfigUrl": { + "description": "Azure Internal monitoring agent fluentd configuration." + }, + "autoKeyConfigUrl": { + "description": "Azure Internal monitoring pipeline autokey associated with the certificate.", + "type": "string" + } + } + }, + "DiagnosticsDescription": { + "description": "Describes the diagnostics options available", + "properties": { + "sinks": { + "description": "List of supported sinks that can be referenced.", + "type": "array", + "items": { + "$ref": "#/definitions/DiagnosticsSinkProperties" + } + }, + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "defaultSinkRefs": { + "description": "The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsRef": { + "description": "Reference to sinks in DiagnosticsDescription.", + "properties": { + "enabled": { + "description": "Status of whether or not sinks are enabled.", + "type": "boolean" + }, + "sinkRefs": { + "description": "List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DiagnosticsSinkKind": { + "type": "string", + "description": "The kind of DiagnosticsSink.", + "enum": [ + "Invalid", + "AzureInternalMonitoringPipeline" + ], + "x-ms-enum": { + "name": "DiagnosticsSinkKind", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Indicates an invalid sink kind. All Service Fabric enumerations have the invalid type." + }, + { + "value": "AzureInternalMonitoringPipeline", + "description": "Diagnostics settings for Geneva." + } + ] + } + }, + "DiagnosticsSinkProperties": { + "description": "Properties of a DiagnosticsSink.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/DiagnosticsSinkKind", + "description": "The kind of DiagnosticsSink." + }, + "name": { + "description": "Name of the sink. This value is referenced by DiagnosticsReferenceDescription", + "type": "string" + }, + "description": { + "description": "A description of the sink.", + "type": "string" + } + }, + "required": [ + "kind" + ] + }, + "AddRemoveReplicaScalingMechanism": { + "description": "Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups).", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMechanism" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AddRemoveReplica", + "properties": { + "minCount": { + "type": "integer", + "description": "Minimum number of containers (scale down won't be performed below this number)." + }, + "maxCount": { + "type": "integer", + "description": "Maximum number of containers (scale up won't be performed above this number)." + }, + "scaleIncrement": { + "type": "integer", + "description": "Each time auto scaling is performed, this number of containers will be added or removed." + } + }, + "required": [ + "minCount", + "maxCount", + "scaleIncrement" + ] + }, + "AutoScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing auto scaling operation. Derived classes will describe the actual mechanism.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMechanismKind", + "description": "The type of auto scaling mechanism." + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMechanismKind": { + "type": "string", + "description": "Enumerates the mechanisms for auto scaling.", + "enum": [ + "AddRemoveReplica" + ], + "x-ms-enum": { + "name": "AutoScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "AddRemoveReplica", + "description": "Indicates that scaling should be performed by adding or removing replicas." + } + ] + } + }, + "AutoScalingMetric": { + "type": "object", + "discriminator": "kind", + "description": "Describes the metric that is used for triggering auto scaling operation. Derived classes will describe resources or metrics.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingMetricKind", + "description": "The type of auto scaling metric" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingMetricKind": { + "type": "string", + "description": "Enumerates the metrics that are used for triggering auto scaling.", + "enum": [ + "Resource" + ], + "x-ms-enum": { + "name": "AutoScalingMetricKind", + "modelAsString": true, + "values": [ + { + "value": "Resource", + "description": "Indicates that the metric is one of resources, like cpu or memory." + } + ] + } + }, + "AutoScalingPolicy": { + "description": "Describes the auto scaling policy", + "type": "object", + "properties": { + "name": { + "description": "The name of the auto scaling policy.", + "type": "string" + }, + "trigger": { + "$ref": "#/definitions/AutoScalingTrigger", + "description": "Determines when auto scaling operation will be invoked." + }, + "mechanism": { + "$ref": "#/definitions/AutoScalingMechanism", + "description": "The mechanism that is used to scale when auto scaling operation is invoked." + } + }, + "required": [ + "name", + "trigger", + "mechanism" + ] + }, + "AutoScalingResourceMetric": { + "description": "Describes the resource that is used for triggering auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingMetric" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "Resource", + "properties": { + "name": { + "$ref": "#/definitions/AutoScalingResourceMetricName", + "description": "Name of the resource." + } + }, + "required": [ + "name" + ] + }, + "AutoScalingResourceMetricName": { + "type": "string", + "description": "Enumerates the resources that are used for triggering auto scaling.", + "enum": [ + "cpu", + "memoryInGB" + ], + "x-ms-enum": { + "name": "AutoScalingResourceMetricName", + "modelAsString": true, + "values": [ + { + "value": "cpu", + "description": "Indicates that the resource is CPU cores." + }, + { + "value": "memoryInGB", + "description": "Indicates that the resource is memory in GB." + } + ] + } + }, + "AutoScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing auto scaling operation.", + "properties": { + "kind": { + "$ref": "#/definitions/AutoScalingTriggerKind", + "description": "The type of auto scaling trigger" + } + }, + "required": [ + "kind" + ] + }, + "AutoScalingTriggerKind": { + "type": "string", + "description": "Enumerates the triggers for auto scaling.", + "enum": [ + "AverageLoad" + ], + "x-ms-enum": { + "name": "AutoScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AverageLoad", + "description": "Indicates that scaling should be performed based on average load of all replicas in the service." + } + ] + } + }, + "ContainerCodePackageProperties": { + "description": "Describes a container and its runtime properties.", + "properties": { + "name": { + "description": "The name of the code package.", + "type": "string" + }, + "image": { + "description": "The Container image to use.", + "type": "string" + }, + "imageRegistryCredential": { + "$ref": "#/definitions/ImageRegistryCredential", + "description": "Image registry credential." + }, + "entrypoint": { + "description": "Override for the default entry point in the container.", + "type": "string" + }, + "commands": { + "description": "Command array to execute within the container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in this container", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "settings": { + "description": "The settings to set in this container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "type": "array", + "items": { + "$ref": "#/definitions/Setting" + } + }, + "labels": { + "description": "The labels to set in this container.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerLabel" + } + }, + "endpoints": { + "description": "The endpoints exposed by this container.", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointProperties" + } + }, + "resources": { + "description": "The resources required by this container.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeRefs": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeReference" + } + }, + "volumes": { + "description": "Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationScopedVolume" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + }, + "reliableCollectionsRefs": { + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliablecollectionsRef for more details.", + "type": "array", + "items": { + "$ref": "#/definitions/ReliableCollectionsRef" + } + }, + "instanceView": { + "readOnly": true, + "$ref": "#/definitions/ContainerInstanceView", + "description": "Runtime information of a container instance." + } + }, + "required": [ + "name", + "image", + "resources" + ] + }, + "ContainerEvent": { + "description": "A container event.", + "properties": { + "name": { + "type": "string", + "description": "The name of the container event." + }, + "count": { + "type": "integer", + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "description": "Date/time of the first event." + }, + "lastTimestamp": { + "type": "string", + "description": "Date/time of the last event." + }, + "message": { + "type": "string", + "description": "The event message" + }, + "type": { + "type": "string", + "description": "The event type." + } + } + }, + "ContainerInstanceView": { + "description": "Runtime information of a container instance.", + "properties": { + "restartCount": { + "type": "integer", + "description": "The number of times the container has been restarted." + }, + "currentState": { + "$ref": "#/definitions/ContainerState", + "description": "Current container instance state." + }, + "previousState": { + "$ref": "#/definitions/ContainerState", + "description": "Previous container instance state." + }, + "events": { + "description": "The events of this container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerEvent" + } + } + } + }, + "ContainerLabel": { + "description": "Describes a container label.", + "properties": { + "name": { + "description": "The name of the container label.", + "type": "string" + }, + "value": { + "description": "The value of the container label.", + "type": "string" + } + }, + "required": [ + "name", + "value" + ] + }, + "ContainerState": { + "description": "The container state.", + "properties": { + "state": { + "type": "string", + "description": "The state of this container" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state started." + }, + "exitCode": { + "type": "string", + "description": "The container exit code." + }, + "finishTime": { + "type": "string", + "format": "date-time", + "description": "Date/time when the container state finished." + }, + "detailStatus": { + "description": "Human-readable status of this state.", + "type": "string" + } + } + }, + "EndpointProperties": { + "description": "Describes a container endpoint.", + "properties": { + "name": { + "description": "The name of the endpoint.", + "type": "string" + }, + "port": { + "description": "Port used by the container.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EnvironmentVariable": { + "description": "Describes an environment variable for the container.", + "properties": { + "name": { + "description": "The name of the environment variable.", + "type": "string" + }, + "value": { + "description": "The value of the environment variable.", + "type": "string" + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "properties": { + "server": { + "type": "string", + "description": "Docker image registry server, without protocol such as `http` and `https`." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations." + } + }, + "required": [ + "server", + "username" + ] + }, + "OperatingSystemType": { + "type": "string", + "description": "The operation system required by the code in service.", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OperatingSystemType", + "modelAsString": true, + "values": [ + { + "value": "Linux", + "description": "The required operating system is Linux." + }, + { + "value": "Windows", + "description": "The required operating system is Windows." + } + ] + } + }, + "ReliableCollectionsRef": { + "description": "Specifying this parameter adds support for reliable collections", + "properties": { + "name": { + "description": "Name of ReliableCollection resource. Right now it's not used and you can use any string.", + "type": "string" + }, + "doNotPersistState": { + "description": "False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache.", + "type": "boolean" + } + }, + "required": [ + "name" + ] + }, + "ResourceLimits": { + "description": "This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted.", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "CPU limits in cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + } + }, + "ResourceRequests": { + "description": "This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits.", + "properties": { + "memoryInGB": { + "description": "The memory request in GB for this container.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "Requested number of CPU cores. At present, only full cores are supported.", + "type": "number", + "format": "double" + } + }, + "required": [ + "memoryInGB", + "cpu" + ] + }, + "ResourceRequirements": { + "description": "This type describes the resource requirements for a container or a service.", + "properties": { + "requests": { + "$ref": "#/definitions/ResourceRequests", + "description": "Describes the requested resources for a given container." + }, + "limits": { + "$ref": "#/definitions/ResourceLimits", + "description": "Describes the maximum limits on the resources for a given container." + } + }, + "required": [ + "requests" + ] + }, + "ServiceProperties": { + "description": "Describes properties of a service resource.", + "properties": { + "description": { + "type": "string", + "description": "User readable description of the service." + }, + "replicaCount": { + "type": "integer", + "description": "The number of replicas of the service to create. Defaults to 1 if not specified." + }, + "autoScalingPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScalingPolicy" + }, + "description": "Auto scaling policies" + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ResourceStatus", + "description": "Status of the service." + }, + "statusDetails": { + "readOnly": true, + "type": "string", + "description": "Gives additional information about the current status of the service." + }, + "healthState": { + "readOnly": true, + "$ref": "#/definitions/HealthState", + "description": "Describes the health state of an application resource." + }, + "unhealthyEvaluation": { + "readOnly": true, + "type": "string", + "description": "When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy." + } + } + }, + "ServiceReplicaProperties": { + "description": "Describes the properties of a service replica.", + "properties": { + "osType": { + "$ref": "#/definitions/OperatingSystemType", + "description": "The operation system required by the code in service." + }, + "codePackages": { + "description": "Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.).", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerCodePackageProperties" + } + }, + "networkRefs": { + "type": "array", + "description": "The names of the private networks that this service needs to be part of.", + "items": { + "$ref": "#/definitions/NetworkRef" + } + }, + "diagnostics": { + "$ref": "#/definitions/DiagnosticsRef", + "description": "Reference to sinks in DiagnosticsDescription." + } + }, + "required": [ + "osType", + "codePackages" + ] + }, + "Setting": { + "description": "Describes a setting for the container. The setting file path can be fetched from environment variable \"Fabric_SettingPath\". The path for Windows container is \"C:\\\\secrets\". The path for Linux container is \"/var/secrets\".", + "properties": { + "name": { + "description": "The name of the setting.", + "type": "string" + }, + "value": { + "description": "The value of the setting.", + "type": "string" + } + } + }, + "ServiceReplicaDescription": { + "description": "Describes a replica of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + } + ], + "properties": { + "replicaName": { + "type": "string", + "description": "Name of the replica." + } + }, + "required": [ + "replicaName" + ] + }, + "AverageLoadScalingTrigger": { + "description": "Describes the average load trigger used for auto scaling.", + "allOf": [ + { + "$ref": "#/definitions/AutoScalingTrigger" + }, + { + "type": "object" + } + ], + "x-ms-discriminator-value": "AverageLoad", + "properties": { + "metric": { + "$ref": "#/definitions/AutoScalingMetric", + "description": "Description of the metric that is used for scaling." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "Lower load threshold (if average load is below this threshold, service will scale down)." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "Upper load threshold (if average load is above this threshold, service will scale up)." + }, + "scaleIntervalInSeconds": { + "type": "integer", + "description": "Scale interval that indicates how often will this trigger be checked.", + "minimum": 60 + } + }, + "required": [ + "metric", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleIntervalInSeconds" + ] + }, + "ServiceResourceName": { + "type": "string", + "description": "Name of the Service resource." + }, + "ServiceResourceDescription": { + "description": "This type describes a service resource.", + "properties": { + "name": { + "$ref": "#/definitions/ServiceResourceName", + "description": "Name of the Service resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceResourceProperties", + "description": "This type describes properties of a service resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "ServiceResourceProperties": { + "description": "This type describes properties of a service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceReplicaProperties" + }, + { + "$ref": "#/definitions/ServiceProperties" + } + ] + }, + "PagedServiceResourceDescriptionList": { + "type": "object", + "description": "The list of service resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/ServiceResourceDescription" + } + } + } + }, + "PagedServiceReplicaDescriptionList": { + "description": "The list of service resource replicas in the cluster. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "List of service resource replica description.", + "items": { + "$ref": "#/definitions/ServiceReplicaDescription" + } + } + } + }, + "ApplicationResourceName": { + "type": "string", + "description": "Name of the Application resource." + }, + "ApplicationResourceDescription": { + "description": "This type describes a application resource.", + "properties": { + "name": { + "$ref": "#/definitions/ApplicationResourceName", + "description": "Name of the Application resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "Describes properties of a application resource." + } + }, + "required": [ + "name", + "properties" + ] + }, + "PagedApplicationResourceDescriptionList": { + "type": "object", + "description": "The list of application resources. The list is paged when all of the results cannot fit in a single message. The next set of results can be obtained by executing the same query with the continuation token provided in this list.", + "properties": { + "ContinuationToken": { + "$ref": "#/definitions/ContinuationToken", + "description": "The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response." + }, + "Items": { + "type": "array", + "description": "One page of the list.", + "items": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + } + } + } + }, + "parameters": { + "CodePackageNameRequiredPathParam": { + "name": "codePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package of the service." + }, + "ApiVersion_6-4-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.4-preview" + ], + "required": true, + "default": "6.4-preview", + "description": "The version of the API. This parameter is required and its value must be '6.4-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-4-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.4-preview", + "description": "The version number for the preview functionality of 6.4 runtime" + } + ] + } + }, + "TailOptionalQueryParam": { + "name": "Tail", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs." + }, + "ApiVersion_6-0-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0-preview" + ], + "required": true, + "default": "6.0-preview", + "description": "The version of the API. This parameter is required and its value must be '\"6.0-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-0-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0-preview", + "description": "The version number for the preview functionality of 6.0 runtime." + } + ] + } + }, + "ApiVersion_6-0_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.0" + ], + "required": true, + "default": "6.0", + "description": "The version of the API. This parameter is required and its value must be '6.0'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-0_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.0", + "description": "The 6.0 version of the API." + } + ] + } + }, + "ApiVersion_6-1_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.1" + ], + "required": true, + "default": "6.1", + "description": "The version of the API. This parameter is required and its value must be '6.1'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accept any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0, but if the runtime is 6.1, in order to make it easier to write the clients, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-1_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.1", + "description": "The 6.1 version of the API." + } + ] + } + }, + "ApiVersion_6-2_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2" + ], + "required": true, + "default": "6.2", + "description": "The version of the API. This parameter is required and its value must be '6.2'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-2_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2", + "description": "The 6.2 version of the API." + } + ] + } + }, + "ApiVersion_6-2-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.2-preview" + ], + "required": true, + "default": "6.2-preview", + "description": "The version of the API. This parameter is required and its value must be '6.2-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-2-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.2-preview", + "description": "The version number for the preview functionality of 6.2 runtime" + } + ] + } + }, + "ApiVersion_6-3_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.3" + ], + "required": true, + "default": "6.3", + "description": "The version of the API. This parameter is required and its value must be '6.3'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-3_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.3", + "description": "The 6.3 version of the API." + } + ] + } + }, + "ApiVersion_6-3-Preview_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.3-preview" + ], + "required": true, + "default": "6.3-preview", + "description": "The version of the API. This parameter is required and its value must be '6.3-preview'.", + "x-ms-enum": { + "name": "ApiVersion_6-3-Preview_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.3-preview", + "description": "The version number for the preview functionality of 6.3 runtime" + } + ] + } + }, + "ApiVersion_6-4_RequiredQueryParam": { + "name": "api-version", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "6.4" + ], + "required": true, + "default": "6.4", + "description": "The version of the API. This parameter is required and its value must be '6.4'.\n\nService Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.\n\nAdditionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.", + "x-ms-enum": { + "name": "ApiVersion_6-4_RequiredQueryParam", + "modelAsString": true, + "values": [ + { + "value": "6.4", + "description": "The 6.4 version of the API." + } + ] + } + }, + "ApplicationDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationDefinitionKindFilter", + "description": "Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1.\n- Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationHealthPolicyOptionalBodyParam": { + "name": "ApplicationHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of an application or one of its children.\nIf not present, the health evaluation uses the health policy from application manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationHealthPolicy" + } + }, + "ApplicationIdRequiredPathParam": { + "name": "applicationId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the application name is \"fabric:/myapp/app1\", the application identity would be \"myapp~app1\" in 6.0+ and \"myapp/app1\" in previous versions." + }, + "ApplicationsHealthStateFilterOptionalQueryParam": { + "name": "ApplicationsHealthStateFilter", + "description": "Allows filtering of the application health state objects returned in the result of cluster health\nquery based on their health state.\nThe possible values for this parameter include integer value obtained from members or bitwise operations\non members of HealthStateFilter enumeration. Only applications that match the filter are returned.\nAll applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeDefinitionKindFilterOptionalQueryParam": { + "name": "ApplicationTypeDefinitionKindFilter", + "description": "Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type.\n- Default - Default value, which performs the same function as selecting \"All\". The value is 0.\n- All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535.\n- ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1.\n- Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ApplicationTypeNameOptionalQueryParam": { + "name": "ApplicationTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The application type name used to filter the applications to query for. This value should not contain the application type version." + }, + "ApplicationTypeNameRequiredPathParam": { + "name": "applicationTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the application type." + }, + "ApplicationTypeVersionOptionalQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The version of the application type." + }, + "ApplicationTypeVersionRequiredQueryParam": { + "name": "ApplicationTypeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The version of the application type." + }, + "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam": { + "name": "ProvisionApplicationTypeDescriptionBaseRequiredBodyParam", + "in": "body", + "description": "The base type of provision application type description which supports either image store-based provision or external store-based provision.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionApplicationTypeDescriptionBase" + } + }, + "ClusterConfigurationUpgradeDescriptionRequiredBodyParam": { + "name": "ClusterConfigurationUpgradeDescription", + "in": "body", + "description": "Parameters for a standalone cluster configuration upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterConfigurationUpgradeDescription" + } + }, + "ClusterHealthPoliciesOptionalBodyParam": { + "name": "ClusterHealthPolicies", + "in": "body", + "description": "Describes the health policies used to evaluate the cluster health.\nIf not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicies" + } + }, + "ClusterHealthPolicyOptionalBodyParam": { + "name": "ClusterHealthPolicy", + "in": "body", + "description": "Describes the health policies used to evaluate the health of a cluster or node. If not present, the health evaluation uses the health policy from cluster manifest or the default health policy.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthPolicy" + } + }, + "ClusterHealthChunkQueryDescriptionOptionalBodyParam": { + "name": "ClusterHealthChunkQueryDescription", + "in": "body", + "description": "Describes the cluster and application health policies used to evaluate the cluster health and the filters to select which cluster entities to be returned.\nIf the cluster health policy is present, it is used to evaluate the cluster events and the cluster nodes. If not present, the health evaluation uses the cluster health policy defined in the cluster manifest or the default cluster health policy.\nBy default, each application is evaluated using its specific application health policy, defined in the application manifest, or the default health policy, if no policy is defined in manifest.\nIf the application health policy map is specified, and it has an entry for an application, the specified application health policy\nis used to evaluate the application health.\nUsers can specify very flexible filters to select which cluster entities to include in response. The selection can be done based on the entities health state and based on the hierarchy.\nThe query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return\nonly services that are in Error or Warning, and all partitions and replicas for one of these services.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ClusterHealthChunkQueryDescription" + } + }, + "CodePackageInstanceIdRequiredQueryParam": { + "name": "CodePackageInstanceId", + "description": "ID that uniquely identifies a code package instance deployed on a service fabric node.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "CodePackageNameRequiredQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "CodeVersionOptionalQueryParam": { + "name": "CodeVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The product version of Service Fabric." + }, + "ConfigVersionOptionalQueryParam": { + "name": "ConfigVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The config version of Service Fabric." + }, + "ConfigurationApiVersionRequiredQueryParam": { + "name": "ConfigurationApiVersion", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The API version of the Standalone cluster json configuration." + }, + "ContainerApiRequiredBodyParam": { + "name": "ContainerApiRequestBody", + "in": "body", + "description": "Parameters for making container API call", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ContainerApiRequestBody" + } + }, + "ContinuationTokenOptionalQueryParam": { + "name": "ContinuationToken", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded." + }, + "DeployedApplicationsHealthStateFilterOptionalQueryParam": { + "name": "DeployedApplicationsHealthStateFilter", + "description": "Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned.\nAll deployed applications are used to evaluate the aggregated health state. If not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values, obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of deployed applications with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServicePackagesHealthStateFilterOptionalQueryParam": { + "name": "DeployedServicePackagesHealthStateFilter", + "description": "Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeploymentNameRequiredPathParam": { + "name": "deploymentName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the deployment." + }, + "EventsHealthStateFilterOptionalQueryParam": { + "name": "EventsHealthStateFilter", + "description": "Allows filtering the collection of HealthEvent objects returned based on health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly events that match the filter are returned. All events are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ExcludeApplicationParametersOptionalQueryParam": { + "name": "ExcludeApplicationParameters", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "The flag that specifies whether application parameters will be excluded from the result." + }, + "HealthInformationRequiredBodyParam": { + "name": "HealthInformation", + "in": "body", + "description": "Describes the health information for the health report. This information needs to be present in all of the health reports sent to the health manager.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/HealthInformation" + } + }, + "NodeNameRequiredPathParam": { + "name": "nodeName", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of the node." + }, + "NodesHealthStateFilterOptionalQueryParam": { + "name": "NodesHealthStateFilter", + "description": "Allows filtering of the node health state objects returned in the result of cluster health query\nbased on their health state. The possible values for this parameter include integer value of one of the\nfollowing health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state.\nIf not specified, all entries are returned.\nThe state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator.\nFor example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "NodeStatusFilterOptionalQueryParam": { + "name": "NodeStatusFilter", + "description": "Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default", + "all", + "up", + "down", + "enabling", + "disabling", + "disabled", + "unknown", + "removed" + ], + "required": false, + "default": "default", + "x-ms-enum": { + "name": "NodeStatusFilter", + "modelAsString": true, + "values": [ + { + "value": "default", + "description": "This filter value will match all of the nodes excepts the ones with status as Unknown or Removed." + }, + { + "value": "all", + "description": "This filter value will match all of the nodes." + }, + { + "value": "up", + "description": "This filter value will match nodes that are Up." + }, + { + "value": "down", + "description": "This filter value will match nodes that are Down." + }, + { + "value": "enabling", + "description": "This filter value will match nodes that are in the process of being enabled with status as Enabling." + }, + { + "value": "disabling", + "description": "This filter value will match nodes that are in the process of being disabled with status as Disabling." + }, + { + "value": "disabled", + "description": "This filter value will match nodes that are Disabled." + }, + { + "value": "unknown", + "description": "This filter value will match nodes whose status is Unknown. A node would be in Unknown state if Service Fabric does not have authoritative information about that node. This can happen if the system learns about a node at runtime." + }, + { + "value": "removed", + "description": "This filter value will match nodes whose status is Removed. These are the nodes that are removed from the cluster using the RemoveNodeState API." + } + ] + } + }, + "PartitionIdOptionalQueryParam": { + "name": "PartitionId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": false, + "description": "The identity of the partition." + }, + "PartitionIdRequiredPathParam": { + "name": "partitionId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "format": "uuid", + "required": true, + "description": "The identity of the partition." + }, + "ProvisionFabricDescriptionRequiredBodyParam": { + "name": "ProvisionFabricDescription", + "in": "body", + "description": "Describes the parameters for provisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ProvisionFabricDescription" + } + }, + "UnprovisionFabricDescriptionRequiredBodyParam": { + "name": "UnprovisionFabricDescription", + "in": "body", + "description": "Describes the parameters for unprovisioning a cluster.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionFabricDescription" + } + }, + "ResumeClusterUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeClusterUpgradeDescription" + } + }, + "UpdateClusterUpgradeDescriptionRequiredBodyParam": { + "name": "UpdateClusterUpgradeDescription", + "in": "body", + "description": "Parameters for updating a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UpdateClusterUpgradeDescription" + } + }, + "StartClusterUpgradeDescriptionRequiredBodyParam": { + "name": "StartClusterUpgradeDescription", + "in": "body", + "description": "Describes the parameters for starting a cluster upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/StartClusterUpgradeDescription" + } + }, + "ReplicaHealthReportServiceKindRequiredQueryParam": { + "name": "ReplicaHealthReportServiceKind", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "description": "The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values.", + "type": "string", + "enum": [ + "Stateless", + "Stateful" + ], + "default": "Stateful", + "x-ms-enum": { + "name": "ReplicaHealthReportServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 1" + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 2." + } + ] + } + }, + "ReplicaIdRequiredPathParam": { + "name": "replicaId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identifier of the replica." + }, + "ReplicasHealthStateFilerOptionalQueryParam": { + "name": "ReplicasHealthStateFilter", + "description": "Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be returned.The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "ServiceIdRequiredPathParam": { + "name": "serviceId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme.\nStarting from version 6.0, hierarchical names are delimited with the \"~\" character.\nFor example, if the service name is \"fabric:/myapp/app1/svc1\", the service identity would be \"myapp~app1~svc1\" in 6.0+ and \"myapp/app1/svc1\" in previous versions." + }, + "ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServiceManifestNameRequiredQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of a service manifest registered as part of an application type in a Service Fabric cluster." + }, + "ServicePackageNameRequiredPathParam": { + "name": "servicePackageName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the service package." + }, + "ServicesHealthStateFilterOptionalQueryParam": { + "name": "ServicesHealthStateFilter", + "description": "Allows filtering of the services health state objects returned in the result of services health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly services that match the filter are returned. All services are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values,\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of services with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "CreateServiceFromTemplateRequiredBodyParam": { + "name": "ServiceFromTemplateDescription", + "in": "body", + "description": "Describes the service that needs to be created from the template defined in the application manifest.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceFromTemplateDescription" + } + }, + "ServiceTypeNameOptionalQueryParam": { + "name": "ServiceTypeName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The service type name used to filter the services to query for." + }, + "InfrastructureCommandRequiredQueryParam": { + "name": "Command", + "description": "The text of the command to be invoked. The content of the command is infrastructure-specific.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "InfrastructureServiceIdOptionalQueryParam": { + "name": "ServiceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "description": "The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running.", + "required": false + }, + "ForceRemoveOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "ForceRemoveReplicaOptionalQueryParam": { + "name": "ForceRemove", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas." + }, + "DeactivationIntentDescriptionRequiredBodyParam": { + "name": "DeactivationIntentDescription", + "in": "body", + "description": "Describes the intent or reason for deactivating the node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeactivationIntentDescription" + } + }, + "RestartNodeDescriptionRequiredBodyParam": { + "name": "RestartNodeDescription", + "in": "body", + "description": "The instance of the node to be restarted and a flag indicating the need to take dump of the fabric process.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartNodeDescription" + } + }, + "ApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeDescription", + "in": "body", + "description": "Parameters for an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeDescription" + } + }, + "ComposeDeploymentUpgradeDescriptionRequiredBodyParam": { + "name": "ComposeDeploymentUpgradeDescription", + "in": "body", + "description": "Parameters for upgrading compose deployment.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ComposeDeploymentUpgradeDescription" + } + }, + "ApplicationTypeImageStorePathRequiredBodyParam": { + "name": "ApplicationTypeImageStorePath", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationTypeImageStorePath" + } + }, + "UnprovisionApplicationTypeRequiredBodyParam": { + "name": "UnprovisionApplicationTypeDescriptionInfo", + "in": "body", + "description": "The relative path for the application package in the image store specified during the prior copy operation.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/UnprovisionApplicationTypeDescriptionInfo" + } + }, + "UpgradeOrchestrationServiceStateRequiredBodyParam": { + "name": "UpgradeOrchestrationServiceState", + "in": "body", + "x-ms-parameter-location": "method", + "required": true, + "description": "Service state of Service Fabric Upgrade Orchestration Service.", + "schema": { + "$ref": "#/definitions/UpgradeOrchestrationServiceState" + } + }, + "ChaosParametersRequiredBodyParam": { + "name": "ChaosParameters", + "in": "body", + "description": "Describes all the parameters to configure a Chaos run.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosParameters" + } + }, + "StartTimeUtcOptionalQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "EndTimeUtcOptionalQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details." + }, + "ApplicationNameRequiredQueryParam": { + "name": "ApplicationName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The name of application to create from compose file. This is typically the full name of the application including 'fabric:' URI scheme." + }, + "CreateComposeDeploymentRequiredBodyParam": { + "name": "CreateComposeDeploymentDescription", + "in": "body", + "description": "Describes the compose deployment that needs to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/CreateComposeDeploymentDescription" + } + }, + "PasswordEncryptedOptionalQueryParam": { + "name": "PasswordEncrypted", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "Indicates that supplied container repository password is encrypted." + }, + "RepositoryPasswordOptionalQueryParam": { + "name": "RepositoryPassword", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The password for supplied username to connect to container repository." + }, + "RepositoryUserNameOptionalQueryParam": { + "name": "RepositoryUserName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The user name to connect to container repository." + }, + "MaxResultsOptionalQueryParam": { + "name": "MaxResults", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "minimum": 0, + "default": 0, + "required": false, + "description": "The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message." + }, + "ApplicationDescriptionRequiredBodyParam": { + "name": "ApplicationDescription", + "in": "body", + "description": "Description for creating an application.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationDescription" + } + }, + "ServiceDescriptionRequiredBodyParam": { + "name": "ServiceDescription", + "in": "body", + "description": "The information necessary to create a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceDescription" + } + }, + "ServiceUpdateDescriptionRequiredBodyParam": { + "name": "ServiceUpdateDescription", + "in": "body", + "description": "The information necessary to update a service.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ServiceUpdateDescription" + } + }, + "ImageStoreCopyDescriptionRequiredBodyParam": { + "name": "ImageStoreCopyDescription", + "in": "body", + "description": "Describes the copy description for the image store.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ImageStoreCopyDescription" + } + }, + "CodePackageNameOptionalQueryParam": { + "name": "CodePackageName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster." + }, + "RestartDeployedCodePackageRequiredBodyParam": { + "name": "RestartDeployedCodePackageDescription", + "in": "body", + "description": "Describes the deployed code package on Service Fabric node to restart.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestartDeployedCodePackageDescription" + } + }, + "PartitionsHealthStateFilterOptionalQueryParam": { + "name": "PartitionsHealthStateFilter", + "description": "Allows filtering of the partitions health state objects returned in the result of service health query based on their health state.\nThe possible values for this parameter include integer value of one of the following health states.\nOnly partitions that match the filter are returned. All partitions are used to evaluate the aggregated health state.\nIf not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these value\nobtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned.\n\n- Default - Default value. Matches any HealthState. The value is zero.\n- None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1.\n- Ok - Filter that matches input with HealthState value Ok. The value is 2.\n- Warning - Filter that matches input with HealthState value Warning. The value is 4.\n- Error - Filter that matches input with HealthState value Error. The value is 8.\n- All - Filter that matches input with any HealthState value. The value is 65535.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 0 + }, + "DeployedServiceType_ServiceManifestNameOptionalQueryParam": { + "name": "ServiceManifestName", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest." + }, + "ServiceTypeNameRequiredPathParam": { + "name": "serviceTypeName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Specifies the name of a Service Fabric service type." + }, + "ImageStoreContentPathRequiredPathParam": { + "name": "contentPath", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "Relative path to file or folder in the image store from its root." + }, + "PartitionKeyTypeOptionalQueryParam": { + "name": "PartitionKeyType", + "description": "Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following.\n- None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1.\n- Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2.\n- Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "PartitionKeyValueOptionalQueryParam": { + "name": "PartitionKeyValue", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "Partition key. This is required if the partition scheme for the service is Int64Range or Named. \nThis is not the partition ID, but rather, either the integer key value, or the name of the partition ID.\nFor example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an\ninteger in that range. Query service description to see the range or name." + }, + "PreviousRspVersionOptionalQueryParam": { + "name": "PreviousRspVersion", + "in": "query", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": false, + "description": "The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale." + }, + "DataLossModeRequiredQueryParam": { + "name": "DataLossMode", + "description": "This enum is passed to the StartDataLoss API to indicate what type of data loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "PartialDataLoss", + "FullDataLoss" + ], + "required": true, + "x-ms-enum": { + "name": "DataLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "PartialDataLoss", + "description": "PartialDataLoss option will cause a quorum of replicas to go down, triggering an OnDataLoss event in the system for the given partition." + }, + { + "value": "FullDataLoss", + "description": "FullDataLoss option will drop all the replicas which means that all the data will be lost." + } + ] + } + }, + "FaultOperationIdRequiredQueryParam": { + "name": "OperationId", + "description": "A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true + }, + "ForceRequiredQueryParam": { + "name": "Force", + "description": "Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": true, + "default": false + }, + "NodeInstanceIdRequiredQueryParam": { + "name": "NodeInstanceId", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The node instance ID of the target node. This can be determined through GetNodeInfo API." + }, + "NodeTransitionTypeRequiredQueryParam": { + "name": "NodeTransitionType", + "description": "Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "Start", + "Stop" + ], + "required": true, + "x-ms-enum": { + "name": "NodeTransitionType", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "Start", + "description": "Transition a stopped node to up." + }, + { + "value": "Stop", + "description": "Transition an up node to stopped." + } + ] + } + }, + "QuorumLossDurationRequiredQueryParam": { + "name": "QuorumLossDuration", + "description": "The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true + }, + "QuorumLossModeRequiredQueryParam": { + "name": "QuorumLossMode", + "description": "This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "QuorumReplicas", + "AllReplicas" + ], + "required": true, + "x-ms-enum": { + "name": "QuorumLossMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "QuorumReplicas", + "description": "Partial Quorum loss mode : Minimum number of replicas for a partition will be down that will cause a quorum loss." + }, + { + "value": "AllReplicas" + } + ] + } + }, + "RestartPartitionModeRequiredQueryParam": { + "name": "RestartPartitionMode", + "description": "Describe which partitions to restart.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Invalid", + "AllReplicasOrInstances", + "OnlyActiveSecondaries" + ], + "required": true, + "x-ms-enum": { + "name": "RestartPartitionMode", + "modelAsString": true, + "values": [ + { + "value": "Invalid", + "description": "Reserved. Do not pass into API." + }, + { + "value": "AllReplicasOrInstances", + "description": "All replicas or instances in the partition are restarted at once." + }, + { + "value": "OnlyActiveSecondaries", + "description": "Only the secondary replicas are restarted." + } + ] + } + }, + "StateFilterRequiredQueryParam": { + "name": "StateFilter", + "description": "Used to filter on OperationState's for user-induced operations.\n\n- 65535 - select All\n- 1 - select Running\n- 2 - select RollingBack\n- 8 - select Completed\n- 16 - select Faulted\n- 32 - select Cancelled\n- 64 - select ForceCancelled", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "StopDurationInSecondsRequiredQueryParam": { + "name": "StopDurationInSeconds", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int32", + "minimum": 0, + "required": true, + "description": "The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up." + }, + "TypeFilterRequiredQueryParam": { + "name": "TypeFilter", + "description": "Used to filter on OperationType for user-induced operations.\n\n- 65535 - select all\n- 1 - select PartitionDataLoss.\n- 2 - select PartitionQuorumLoss.\n- 4 - select PartitionRestart.\n- 8 - select NodeTransition.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": true, + "default": 65535 + }, + "DeployServicePackageToNodeRequiredBodyParam": { + "name": "DeployServicePackageToNodeDescription", + "in": "body", + "description": "Describes information for deploying a service package to a Service Fabric node.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DeployServicePackageToNodeDescription" + } + }, + "ResumeApplicationUpgradeDescriptionRequiredBodyParam": { + "name": "ResumeApplicationUpgradeDescription", + "in": "body", + "description": "Describes the parameters for resuming an application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ResumeApplicationUpgradeDescription" + } + }, + "ApplicationUpgradeUpdateDescriptionRequiredBodyParam": { + "name": "ApplicationUpgradeUpdateDescription", + "in": "body", + "description": "Parameters for updating an existing application upgrade.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationUpgradeUpdateDescription" + } + }, + "TimeoutOptionalQueryParam": { + "name": "timeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "format": "int64", + "required": false, + "minimum": 1, + "maximum": 4294967295, + "default": 60, + "description": "The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds." + }, + "NameDescriptionRequiredBodyParam": { + "name": "NameDescription", + "in": "body", + "description": "Describes the Service Fabric name to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NameDescription" + } + }, + "NameIdRequiredPathParam": { + "name": "nameId", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The Service Fabric name, without the 'fabric:' URI scheme." + }, + "RecursiveOptionalQueryParam": { + "name": "Recursive", + "description": "Allows specifying that the search performed should be recursive.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeValuesOptionalQueryParam": { + "name": "IncludeValues", + "description": "Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "PropertyDescriptionRequiredBodyParam": { + "name": "PropertyDescription", + "in": "body", + "description": "Describes the Service Fabric property to be created.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyDescription" + } + }, + "PropertyNameRequiredQueryParam": { + "name": "PropertyName", + "description": "Specifies the name of the property to get.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true + }, + "PropertyBatchDescriptionListRequiredBodyParam": { + "name": "PropertyBatchDescriptionList", + "in": "body", + "description": "Describes the property batch operations to be submitted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/PropertyBatchDescriptionList" + } + }, + "ImmediateOptionalQueryParam": { + "name": "Immediate", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "A flag that indicates whether the report should be sent immediately.\nA health report is sent to a Service Fabric gateway Application, which forwards to the health store.\nIf Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using.\nThis is useful for critical reports that should be sent as soon as possible.\nDepending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway.\nIf Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration.\nThis is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing.\nBy default, reports are not sent immediately." + }, + "ExcludeHealthStatisticsOptionalQueryParam": { + "name": "ExcludeHealthStatistics", + "description": "Indicates whether the health statistics should be returned as part of the query result. False by default.\nThe statistics show the number of children entities in health state Ok, Warning, and Error.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeSystemApplicationHealthStatisticsOptionalQueryParam": { + "name": "IncludeSystemApplicationHealthStatistics", + "description": "Indicates whether the health statistics should include the fabric:/System application health statistics. False by default.\nIf IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric:/System application.\nOtherwise, the query result includes health statistics only for user applications.\nThe health statistics must be included in the query result for this parameter to be applied.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false + }, + "IncludeHealthStateOptionalQueryParam": { + "name": "IncludeHealthState", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "default": false, + "description": "Include the health state of an entity.\nIf this parameter is false or not specified, then the health state returned is \"Unknown\".\nWhen set to true, the query goes in parallel to the node and the health system service before the results are merged.\nAs a result, the query is more expensive and may take a longer time." + }, + "BackupPolicyDescriptionRequiredBodyParam": { + "name": "BackupPolicyDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the backup policy.", + "schema": { + "$ref": "#/definitions/BackupPolicyDescription" + } + }, + "DisableBackupDescriptionOptionalBodyParam": { + "name": "DisableBackupDescription", + "in": "body", + "description": "Specifies the parameters to disable backup for any backup entity.", + "required": false, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/DisableBackupDescription" + } + }, + "BackupPolicyNameRequiredPathParam": { + "name": "backupPolicyName", + "in": "path", + "description": "The name of the backup policy.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "EnableBackupDescriptionRequiredBodyParam": { + "name": "EnableBackupDescription", + "in": "body", + "description": "Specifies the parameters for enabling backup.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/EnableBackupDescription" + } + }, + "RestorePartitionDescriptionRequiredBodyParam": { + "name": "RestorePartitionDescription", + "in": "body", + "description": "Describes the parameters to restore the partition.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RestorePartitionDescription" + } + }, + "RestoreTimeoutOptionalQueryParam": { + "name": "RestoreTimeout", + "description": "Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "default": 10 + }, + "BackupPartitionDescriptionOptionalBodyParam": { + "name": "BackupPartitionDescription", + "in": "body", + "required": false, + "x-ms-parameter-location": "method", + "description": "Describes the parameters to backup the partition now. If not present, backup operation uses default parameters from the backup policy current associated with this partition.", + "schema": { + "$ref": "#/definitions/BackupPartitionDescription" + } + }, + "BackupTimeoutOptionalQueryParam": { + "name": "BackupTimeout", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false, + "description": "Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes.", + "default": 10 + }, + "LatestOptionalQueryParam": { + "name": "Latest", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get only the most recent backup available for a partition for the specified time range.", + "required": false, + "default": false + }, + "StartDateTimeFilterOptionalQueryParam": { + "name": "StartDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated." + }, + "EndDateTimeFilterOptionalQueryParam": { + "name": "EndDateTimeFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "date-time", + "required": false, + "description": "Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup." + }, + "GetBackupByStorageQueryDescriptionRequiredBodyParam": { + "name": "GetBackupByStorageQueryDescription", + "in": "body", + "required": true, + "x-ms-parameter-location": "method", + "description": "Describes the filters and backup storage details to be used for enumerating backups.", + "schema": { + "$ref": "#/definitions/GetBackupByStorageQueryDescription" + } + }, + "RepairTaskApproveDescriptionRequiredBodyParam": { + "name": "RepairTaskApproveDescription", + "in": "body", + "description": "Describes the repair task to be approved.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskApproveDescription" + } + }, + "RepairTaskCancelDescriptionRequiredBodyParam": { + "name": "RepairTaskCancelDescription", + "in": "body", + "description": "Describes the repair task to be cancelled.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskCancelDescription" + } + }, + "RepairTaskDeleteDescriptionRequiredBodyParam": { + "name": "RepairTaskDeleteDescription", + "in": "body", + "description": "Describes the repair task to be deleted.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTaskDeleteDescription" + } + }, + "RepairTaskExecutorFilterOptionalQueryParam": { + "name": "ExecutorFilter", + "description": "The name of the repair executor whose claimed tasks should be included in the list.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskIdFilterOptionalQueryParam": { + "name": "TaskIdFilter", + "description": "The repair task ID prefix to be matched.", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false + }, + "RepairTaskRequiredBodyParam": { + "name": "RepairTask", + "in": "body", + "description": "Describes the repair task to be created or updated.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/RepairTask" + } + }, + "RepairTaskStateFilterOptionalQueryParam": { + "name": "StateFilter", + "description": "A bitwise-OR of the following values, specifying which task states should be included in the result list.\n\n- 1 - Created\n- 2 - Claimed\n- 4 - Preparing\n- 8 - Approved\n- 16 - Executing\n- 32 - Restoring\n- 64 - Completed", + "in": "query", + "x-ms-parameter-location": "method", + "type": "integer", + "required": false + }, + "RepairTaskUpdateHealthPolicyDescriptionRequiredBodyParam": { + "name": "RepairTaskUpdateHealthPolicyDescription", + "in": "body", + "description": "Describes the repair task healthy policy to be updated.", + "x-ms-parameter-location": "method", + "required": true, + "schema": { + "$ref": "#/definitions/RepairTaskUpdateHealthPolicyDescription" + } + }, + "UploadSessionIdRequiredQueryParam": { + "name": "session-id", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "format": "uuid", + "required": true, + "description": "A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed." + }, + "UploadFileChunkContentRangeHeaderParam": { + "name": "Content-Range", + "in": "header", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "When uploading file chunks to the image store, the Content-Range header field need to be configured and sent with a request. The format should looks like \"bytes {First-Byte-Position}-{Last-Byte-Position}/{File-Length}\". For example, Content-Range:bytes 300-5000/20000 indicates that user is sending bytes 300 through 5,000 and the total file length is 20,000 bytes." + }, + "ChaosScheduleRequiredBodyParam": { + "name": "ChaosSchedule", + "in": "body", + "description": "Describes the schedule used by Chaos.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ChaosScheduleDescription" + } + }, + "StartTimeUtcRequiredQueryParam": { + "name": "StartTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EndTimeUtcRequiredQueryParam": { + "name": "EndTimeUtc", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ." + }, + "EventsTypesFilterOptionalQueryParam": { + "name": "EventsTypesFilter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "required": false, + "description": "This is a comma separated string specifying the types of FabricEvents that should only be included in the response." + }, + "ExcludeAnalysisEventsOptionalQueryParam": { + "name": "ExcludeAnalysisEvents", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the retrieval of AnalysisEvents if true is passed." + }, + "SkipCorrelationLookupOptionalQueryParam": { + "name": "SkipCorrelationLookup", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "required": false, + "description": "This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated." + }, + "EventInstanceIdRequiredPathParam": { + "name": "eventInstanceId", + "in": "path", + "x-ms-parameter-location": "method", + "type": "string", + "required": true, + "description": "The EventInstanceId." + }, + "PreviousOptionalQueryParam": { + "name": "Previous", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Specifies whether to get container logs from exited/dead containers of the code package instance.", + "required": false, + "default": false + }, + "SecretResourceDescriptionRequiredBodyParam": { + "name": "secretResourceDescription", + "in": "body", + "description": "Description for creating a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretResourceDescription" + } + }, + "SecretResourceNameRequiredPathParam": { + "name": "secretResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource." + }, + "SecretValueResourceDescriptionRequiredBodyParam": { + "name": "secretValueResourceDescription", + "in": "body", + "description": "Description for creating a value of a secret resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/SecretValueResourceDescription" + } + }, + "SecretValueResourceNameRequiredPathParam": { + "name": "secretValueResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The name of the secret resource value which is typically the version identifier for the value." + }, + "VolumeResourceDescriptionRequiredBodyParam": { + "name": "volumeResourceDescription", + "in": "body", + "description": "Description for creating a Volume resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/VolumeResourceDescription" + } + }, + "VolumeResourceNameRequiredPathParam": { + "name": "volumeResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the volume." + }, + "NetworkResourceDescriptionRequiredBodyParam": { + "name": "networkResourceDescription", + "in": "body", + "description": "Description for creating a Network resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/NetworkResourceDescription" + } + }, + "NetworkResourceNameRequiredPathParam": { + "name": "networkResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the network." + }, + "ApplicationResourceDescriptionRequiredBodyParam": { + "name": "applicationResourceDescription", + "in": "body", + "description": "Description for creating a Application resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/ApplicationResourceDescription" + } + }, + "ApplicationResourceNameRequiredPathParam": { + "name": "applicationResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the application." + }, + "ServiceResourceNameRequiredPathParam": { + "name": "serviceResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the service." + }, + "ReplicaNameRequiredPathParam": { + "name": "replicaName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "Service Fabric replica name." + }, + "GatewayResourceDescriptionRequiredBodyParam": { + "name": "gatewayResourceDescription", + "in": "body", + "description": "Description for creating a Gateway resource.", + "required": true, + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/GatewayResourceDescription" + } + }, + "GatewayResourceNameRequiredPathParam": { + "name": "gatewayResourceName", + "in": "path", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "required": true, + "description": "The identity of the gateway." + } + } +} diff --git a/specification/servicefabric/data-plane/readme.go.md b/specification/servicefabric/data-plane/readme.go.md index a3a64274cce0..d3ea191da6f9 100644 --- a/specification/servicefabric/data-plane/readme.go.md +++ b/specification/servicefabric/data-plane/readme.go.md @@ -15,6 +15,7 @@ go: batch: - tag: "6.2" - tag: "6.3" + - tag: "6.4" ``` ### Tag: 6.2 and go @@ -30,6 +31,14 @@ output-folder: $(go-sdk-folder)/services/$(namespace)/6.2/$(namespace) These settings apply only when `--tag=6.3 --go` is specified on the command line. -``` yaml $(tag) == '6.2' && $(go) +``` yaml $(tag) == '6.3' && $(go) output-folder: $(go-sdk-folder)/services/$(namespace)/6.3/$(namespace) +``` + +### Tag: 6.4 and go + +These settings apply only when `--tag=6.4 --go` is specified on the command line. + +``` yaml $(tag) == '6.4' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/6.4/$(namespace) ``` \ No newline at end of file diff --git a/specification/servicefabric/data-plane/readme.md b/specification/servicefabric/data-plane/readme.md index 97964c4fd6ba..ad7e236a26e6 100644 --- a/specification/servicefabric/data-plane/readme.md +++ b/specification/servicefabric/data-plane/readme.md @@ -25,7 +25,7 @@ These are the global settings for the ServiceFabricClient API. ``` yaml openapi-type: data-plane -tag: '6.3' +tag: '6.4' ``` ### Suppression @@ -85,6 +85,16 @@ input-file: ``` +### Tag: 6.4 + +These settings apply only when `--tag=6.4` is specified on the command line. + +``` yaml $(tag) == '6.4' +input-file: +- Microsoft.ServiceFabric/stable/6.4/servicefabric.json + +``` + --- # Code Generation @@ -115,7 +125,7 @@ python: payload-flattening-threshold: 2 namespace: azure.servicefabric package-name: azure-servicefabric - package-version: 6.3.0.0 + package-version: 6.4.0.0 add-credentials: true clear-output-folder: true ``` From 8f54179bb0029496d83e96e84bf59a5d9fd05db2 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 01:56:47 -0500 Subject: [PATCH 325/464] typo: servicefabric/data-plane/Microsoft.ServiceFabric (#4778) - dataloss -> data loss - specificed -> specified - sucsessful -> successful --- .../6.2/examples/GetServiceTypeInfoByName-1.json | 2 +- .../stable/6.2/servicefabric.json | 4 ++-- .../6.3/examples/GetServiceTypeInfoByName-1.json | 2 +- .../stable/6.3/servicefabric.json | 10 +++++----- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json index 617b06fe7e3e..8fc70e01daf3 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetServiceTypeInfoByName-1.json @@ -1,6 +1,6 @@ { "operationId": "GetServiceTypeInfoByName", - "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specified service type is not found in the cluster.", "parameters": { "api-version": "6.0", "applicationTypeName": "Application2Type", diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json index 888add445d02..8c9ab8d94113 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -9644,7 +9644,7 @@ }, "DataLossVersion": { "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." } } }, @@ -9658,7 +9658,7 @@ }, "DataLossNumber": { "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." } } }, diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json index 617b06fe7e3e..8fc70e01daf3 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetServiceTypeInfoByName-1.json @@ -1,6 +1,6 @@ { "operationId": "GetServiceTypeInfoByName", - "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specificed service type is not found in the cluster.", + "description": "This example shows how to get information about a specific service type. A 204 response is returned if the specified service type is not found in the cluster.", "parameters": { "api-version": "6.0", "applicationTypeName": "Application2Type", diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json index 5da051674d5e..07659f1e22cb 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json @@ -5820,7 +5820,7 @@ ], "responses": { "200": { - "description": "A sucsessful operation returns 200 status code and updates the backup policy description." + "description": "A successful operation returns 200 status code and updates the backup policy description." }, "default": { "description": "The detailed error response.", @@ -10031,7 +10031,7 @@ }, "DataLossVersion": { "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." } } }, @@ -10045,7 +10045,7 @@ }, "DataLossNumber": { "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." } } }, @@ -10132,7 +10132,7 @@ "properties": { "Code": { "$ref": "#/definitions/FabricErrorCodes", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" }, "Message": { "type": "string", @@ -10145,7 +10145,7 @@ }, "FabricErrorCodes": { "type": "string", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", "enum": [ "FABRIC_E_INVALID_PARTITION_KEY", "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", From 0fc8a8f0b80cf0fedb37ab77b7d5c971afb8189c Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 01:57:32 -0500 Subject: [PATCH 326/464] typo: search/data-plane/Microsoft.Azure.Search.Service (#4756) - indentifies -> identifies - forstring -> for string - mintues -> minutes - Trim trailing space --- .../2015-02-28-preview/searchservice.json | 180 +++++++++--------- .../preview/2015-02-28/searchservice.json | 6 +- .../2016-09-01-preview/searchservice.json | 178 ++++++++--------- .../preview/2016-09-01/searchservice.json | 180 +++++++++--------- .../2017-11-11-preview/searchservice.json | 178 ++++++++--------- .../preview/2017-11-11/searchservice.json | 178 ++++++++--------- 6 files changed, 450 insertions(+), 450 deletions(-) diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28-preview/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28-preview/searchservice.json index 0f9b54607a9c..c1ab034caf9a 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28-preview/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28-preview/searchservice.json @@ -4,9 +4,9 @@ "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", "version": "2015-02-28-Preview", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true - } + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } }, "consumes": [ "application/json" @@ -1321,9 +1321,9 @@ "type": "string", "enum": [ "letter", - "digit", - "whitespace", - "punctuation", + "digit", + "whitespace", + "punctuation", "symbol" ], "x-ms-enum": { @@ -1408,52 +1408,52 @@ "description": "Emits the entire input as a single token.", "externalDocs": { "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" - } + } }, "MicrosoftTokenizerLanguage": { "type": "string", "enum": [ - "bangla", - "bulgarian", - "catalan", + "bangla", + "bulgarian", + "catalan", "chineseSimplified", - "chineseTraditional", - "croatian", - "czech", - "danish", - "dutch", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", "english", - "french", - "german", - "greek", - "gujarati", - "hindi", - "icelandic", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", "indonesian", - "italian", - "japanese", - "kannada", - "korean", - "malay", - "malayalam", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", "marathi", - "norwegianBokmaal", - "polish", - "portuguese", - "portugueseBrazilian", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", "punjabi", - "romanian", - "russian", - "serbianCyrillic", - "serbianLatin", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", "slovenian", - "spanish", - "swedish", - "tamil", - "telugu", - "thai", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", "ukrainian", - "urdu", + "urdu", "vietnamese" ], "x-ms-enum": { @@ -1492,22 +1492,22 @@ "MicrosoftStemmingTokenizerLanguage": { "type": "string", "enum": [ - "arabic", - "bangla", - "bulgarian", + "arabic", + "bangla", + "bulgarian", "catalan", - "croatian", + "croatian", "czech", "danish", "dutch", "english", "estonian", - "finnish", + "finnish", "french", "german", "greek", "gujarati", - "hebrew", + "hebrew", "hindi", "hungarian", "icelandic", @@ -1527,15 +1527,15 @@ "romanian", "russian", "serbianCyrillic", - "serbianLatin", + "serbianLatin", "slovak", "slovenian", "spanish", "swedish", - "tamil", - "telugu", + "tamil", + "telugu", "turkish", - "ukrainian", + "ukrainian", "urdu" ], "x-ms-enum": { @@ -1744,7 +1744,7 @@ "maxTokenLength": { "type": "integer", "format": "int32", - "default": 255, + "default": 255, "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split" } }, @@ -1841,7 +1841,7 @@ "katakana", "hangul" ], - "x-ms-enum": { + "x-ms-enum": { "name": "CjkBigramTokenFilterScripts", "modelAsString": false }, @@ -1965,7 +1965,7 @@ "front", "back" ], - "x-ms-enum": { + "x-ms-enum": { "name": "EdgeNGramTokenFilterSide", "modelAsString": false }, @@ -2282,8 +2282,8 @@ "PhoneticEncoder": { "type": "string", "enum": [ - "metaphone", - "doubleMetaphone", + "metaphone", + "doubleMetaphone", "soundex", "refinedSoundex", "caverphone1", @@ -2294,7 +2294,7 @@ "haasePhonetik", "beiderMorse" ], - "x-ms-enum": { + "x-ms-enum": { "name": "PhoneticEncoder", "modelAsString": false }, @@ -2379,23 +2379,23 @@ "armenian", "basque", "catalan", - "danish", - "dutch", - "english", + "danish", + "dutch", + "english", "finnish", - "french", - "german", - "german2", - "hungarian", + "french", + "german", + "german2", + "hungarian", "italian", "kp", - "lovins", + "lovins", "norwegian", "porter", "portuguese", "romanian", - "russian", - "spanish", + "russian", + "spanish", "swedish", "turkish" ], @@ -2429,59 +2429,59 @@ "StemmerTokenFilterLanguage": { "type": "string", "enum": [ - "arabic", - "armenian", - "basque", - "brazilian", + "arabic", + "armenian", + "basque", + "brazilian", "bulgarian", "catalan", "czech", - "danish", + "danish", "dutch", "dutchKp", "english", - "lightEnglish", + "lightEnglish", "minimalEnglish", "possessiveEnglish", "porter2", "lovins", - "finnish", + "finnish", "lightFinnish", "french", "lightFrench", "minimalFrench", - "galician", + "galician", "minimalGalician", "german", "german2", - "lightGerman", + "lightGerman", "minimalGerman", "greek", - "hindi", + "hindi", "hungarian", "lightHungarian", "indonesian", "irish", "italian", "lightItalian", - "sorani", - "latvian", + "sorani", + "latvian", "norwegian", "lightNorwegian", - "minimalNorwegian", + "minimalNorwegian", "lightNynorsk", "minimalNynorsk", "portuguese", - "lightPortuguese", + "lightPortuguese", "minimalPortuguese", "portugueseRslp", "romanian", "russian", "lightRussian", - "spanish", + "spanish", "lightSpanish", "swedish", - "lightSwedish", + "lightSwedish", "turkish" ], "x-ms-enum": { @@ -2554,13 +2554,13 @@ "german", "greek", "hindi", - "hungarian", + "hungarian", "indonesian", "irish", "italian", "latvian", - "norwegian", - "persian", + "norwegian", + "persian", "portuguese", "romanian", "russian", @@ -2568,7 +2568,7 @@ "spanish", "swedish", "thai", - "turkish" + "turkish" ], "x-ms-enum": { "name": "StopwordsList", @@ -2918,7 +2918,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "The marker value that indentifies an item as deleted." + "description": "The marker value that identifies an item as deleted." } } }, @@ -3322,7 +3322,7 @@ "searchable": { "x-ms-client-name": "isSearchable", "type": "boolean", - "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "x-ms-client-name": "isFilterable", @@ -3621,7 +3621,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28/searchservice.json index 560da839d41e..82229b7aa31b 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2015-02-28/searchservice.json @@ -941,7 +941,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "Gets or sets the marker value that indentifies an item as deleted." + "description": "Gets or sets the marker value that identifies an item as deleted." } } }, @@ -1232,7 +1232,7 @@ }, "searchable": { "type": "boolean", - "description": "Gets or sets a value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "Gets or sets a value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "type": "boolean", @@ -1530,7 +1530,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "Gets or sets the duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "Gets or sets the duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01-preview/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01-preview/searchservice.json index a7eec987031f..472fe4b6f6e3 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01-preview/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01-preview/searchservice.json @@ -4,8 +4,8 @@ "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", "version": "2016-09-01-Preview", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true + "x-ms-code-generation-settings": { + "useDateTimeOffset": true } }, "x-ms-parameterized-host": { @@ -1452,9 +1452,9 @@ "type": "string", "enum": [ "letter", - "digit", - "whitespace", - "punctuation", + "digit", + "whitespace", + "punctuation", "symbol" ], "x-ms-enum": { @@ -1539,52 +1539,52 @@ "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", "externalDocs": { "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" - } + } }, "MicrosoftTokenizerLanguage": { "type": "string", "enum": [ - "bangla", - "bulgarian", - "catalan", + "bangla", + "bulgarian", + "catalan", "chineseSimplified", - "chineseTraditional", - "croatian", - "czech", - "danish", - "dutch", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", "english", - "french", - "german", - "greek", - "gujarati", - "hindi", - "icelandic", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", "indonesian", - "italian", - "japanese", - "kannada", - "korean", - "malay", - "malayalam", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", "marathi", - "norwegianBokmaal", - "polish", - "portuguese", - "portugueseBrazilian", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", "punjabi", - "romanian", - "russian", - "serbianCyrillic", - "serbianLatin", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", "slovenian", - "spanish", - "swedish", - "tamil", - "telugu", - "thai", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", "ukrainian", - "urdu", + "urdu", "vietnamese" ], "x-ms-enum": { @@ -1623,22 +1623,22 @@ "MicrosoftStemmingTokenizerLanguage": { "type": "string", "enum": [ - "arabic", - "bangla", - "bulgarian", + "arabic", + "bangla", + "bulgarian", "catalan", - "croatian", + "croatian", "czech", "danish", "dutch", "english", "estonian", - "finnish", + "finnish", "french", "german", "greek", "gujarati", - "hebrew", + "hebrew", "hindi", "hungarian", "icelandic", @@ -1658,15 +1658,15 @@ "romanian", "russian", "serbianCyrillic", - "serbianLatin", + "serbianLatin", "slovak", "slovenian", "spanish", "swedish", - "tamil", - "telugu", + "tamil", + "telugu", "turkish", - "ukrainian", + "ukrainian", "urdu" ], "x-ms-enum": { @@ -1870,7 +1870,7 @@ "maxTokenLength": { "type": "integer", "format": "int32", - "default": 255, + "default": 255, "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." } }, @@ -1971,7 +1971,7 @@ "katakana", "hangul" ], - "x-ms-enum": { + "x-ms-enum": { "name": "CjkBigramTokenFilterScripts", "modelAsString": false }, @@ -2095,7 +2095,7 @@ "front", "back" ], - "x-ms-enum": { + "x-ms-enum": { "name": "EdgeNGramTokenFilterSide", "modelAsString": false }, @@ -2412,8 +2412,8 @@ "PhoneticEncoder": { "type": "string", "enum": [ - "metaphone", - "doubleMetaphone", + "metaphone", + "doubleMetaphone", "soundex", "refinedSoundex", "caverphone1", @@ -2424,7 +2424,7 @@ "haasePhonetik", "beiderMorse" ], - "x-ms-enum": { + "x-ms-enum": { "name": "PhoneticEncoder", "modelAsString": false }, @@ -2509,23 +2509,23 @@ "armenian", "basque", "catalan", - "danish", - "dutch", - "english", + "danish", + "dutch", + "english", "finnish", - "french", - "german", - "german2", - "hungarian", + "french", + "german", + "german2", + "hungarian", "italian", "kp", - "lovins", + "lovins", "norwegian", "porter", "portuguese", "romanian", - "russian", - "spanish", + "russian", + "spanish", "swedish", "turkish" ], @@ -2559,59 +2559,59 @@ "StemmerTokenFilterLanguage": { "type": "string", "enum": [ - "arabic", - "armenian", - "basque", - "brazilian", + "arabic", + "armenian", + "basque", + "brazilian", "bulgarian", "catalan", "czech", - "danish", + "danish", "dutch", "dutchKp", "english", - "lightEnglish", + "lightEnglish", "minimalEnglish", "possessiveEnglish", "porter2", "lovins", - "finnish", + "finnish", "lightFinnish", "french", "lightFrench", "minimalFrench", - "galician", + "galician", "minimalGalician", "german", "german2", - "lightGerman", + "lightGerman", "minimalGerman", "greek", - "hindi", + "hindi", "hungarian", "lightHungarian", "indonesian", "irish", "italian", "lightItalian", - "sorani", - "latvian", + "sorani", + "latvian", "norwegian", "lightNorwegian", - "minimalNorwegian", + "minimalNorwegian", "lightNynorsk", "minimalNynorsk", "portuguese", - "lightPortuguese", + "lightPortuguese", "minimalPortuguese", "portugueseRslp", "romanian", "russian", "lightRussian", - "spanish", + "spanish", "lightSpanish", "swedish", - "lightSwedish", + "lightSwedish", "turkish" ], "x-ms-enum": { @@ -2684,13 +2684,13 @@ "german", "greek", "hindi", - "hungarian", + "hungarian", "indonesian", "irish", "italian", "latvian", - "norwegian", - "persian", + "norwegian", + "persian", "portuguese", "romanian", "russian", @@ -2698,7 +2698,7 @@ "spanish", "swedish", "thai", - "turkish" + "turkish" ], "x-ms-enum": { "name": "StopwordsList", @@ -3052,7 +3052,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "The marker value that indentifies an item as deleted." + "description": "The marker value that identifies an item as deleted." } } }, @@ -3493,7 +3493,7 @@ "x-ms-client-name": "isSearchable", "type": "boolean", "x-nullable": false, - "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "x-ms-client-name": "isFilterable", @@ -3797,7 +3797,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01/searchservice.json index 562dad141280..51a9776801aa 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2016-09-01/searchservice.json @@ -4,9 +4,9 @@ "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", "version": "2016-09-01", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true - } + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } }, "consumes": [ "application/json" @@ -1328,9 +1328,9 @@ "type": "string", "enum": [ "letter", - "digit", - "whitespace", - "punctuation", + "digit", + "whitespace", + "punctuation", "symbol" ], "x-ms-enum": { @@ -1415,52 +1415,52 @@ "description": "Emits the entire input as a single token.", "externalDocs": { "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" - } + } }, "MicrosoftTokenizerLanguage": { "type": "string", "enum": [ - "bangla", - "bulgarian", - "catalan", + "bangla", + "bulgarian", + "catalan", "chineseSimplified", - "chineseTraditional", - "croatian", - "czech", - "danish", - "dutch", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", "english", - "french", - "german", - "greek", - "gujarati", - "hindi", - "icelandic", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", "indonesian", - "italian", - "japanese", - "kannada", - "korean", - "malay", - "malayalam", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", "marathi", - "norwegianBokmaal", - "polish", - "portuguese", - "portugueseBrazilian", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", "punjabi", - "romanian", - "russian", - "serbianCyrillic", - "serbianLatin", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", "slovenian", - "spanish", - "swedish", - "tamil", - "telugu", - "thai", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", "ukrainian", - "urdu", + "urdu", "vietnamese" ], "x-ms-enum": { @@ -1499,22 +1499,22 @@ "MicrosoftStemmingTokenizerLanguage": { "type": "string", "enum": [ - "arabic", - "bangla", - "bulgarian", + "arabic", + "bangla", + "bulgarian", "catalan", - "croatian", + "croatian", "czech", "danish", "dutch", "english", "estonian", - "finnish", + "finnish", "french", "german", "greek", "gujarati", - "hebrew", + "hebrew", "hindi", "hungarian", "icelandic", @@ -1534,15 +1534,15 @@ "romanian", "russian", "serbianCyrillic", - "serbianLatin", + "serbianLatin", "slovak", "slovenian", "spanish", "swedish", - "tamil", - "telugu", + "tamil", + "telugu", "turkish", - "ukrainian", + "ukrainian", "urdu" ], "x-ms-enum": { @@ -1751,7 +1751,7 @@ "maxTokenLength": { "type": "integer", "format": "int32", - "default": 255, + "default": 255, "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split" } }, @@ -1852,7 +1852,7 @@ "katakana", "hangul" ], - "x-ms-enum": { + "x-ms-enum": { "name": "CjkBigramTokenFilterScripts", "modelAsString": false }, @@ -1976,7 +1976,7 @@ "front", "back" ], - "x-ms-enum": { + "x-ms-enum": { "name": "EdgeNGramTokenFilterSide", "modelAsString": false }, @@ -2293,8 +2293,8 @@ "PhoneticEncoder": { "type": "string", "enum": [ - "metaphone", - "doubleMetaphone", + "metaphone", + "doubleMetaphone", "soundex", "refinedSoundex", "caverphone1", @@ -2305,7 +2305,7 @@ "haasePhonetik", "beiderMorse" ], - "x-ms-enum": { + "x-ms-enum": { "name": "PhoneticEncoder", "modelAsString": false }, @@ -2390,23 +2390,23 @@ "armenian", "basque", "catalan", - "danish", - "dutch", - "english", + "danish", + "dutch", + "english", "finnish", - "french", - "german", - "german2", - "hungarian", + "french", + "german", + "german2", + "hungarian", "italian", "kp", - "lovins", + "lovins", "norwegian", "porter", "portuguese", "romanian", - "russian", - "spanish", + "russian", + "spanish", "swedish", "turkish" ], @@ -2440,59 +2440,59 @@ "StemmerTokenFilterLanguage": { "type": "string", "enum": [ - "arabic", - "armenian", - "basque", - "brazilian", + "arabic", + "armenian", + "basque", + "brazilian", "bulgarian", "catalan", "czech", - "danish", + "danish", "dutch", "dutchKp", "english", - "lightEnglish", + "lightEnglish", "minimalEnglish", "possessiveEnglish", "porter2", "lovins", - "finnish", + "finnish", "lightFinnish", "french", "lightFrench", "minimalFrench", - "galician", + "galician", "minimalGalician", "german", "german2", - "lightGerman", + "lightGerman", "minimalGerman", "greek", - "hindi", + "hindi", "hungarian", "lightHungarian", "indonesian", "irish", "italian", "lightItalian", - "sorani", - "latvian", + "sorani", + "latvian", "norwegian", "lightNorwegian", - "minimalNorwegian", + "minimalNorwegian", "lightNynorsk", "minimalNynorsk", "portuguese", - "lightPortuguese", + "lightPortuguese", "minimalPortuguese", "portugueseRslp", "romanian", "russian", "lightRussian", - "spanish", + "spanish", "lightSpanish", "swedish", - "lightSwedish", + "lightSwedish", "turkish" ], "x-ms-enum": { @@ -2565,13 +2565,13 @@ "german", "greek", "hindi", - "hungarian", + "hungarian", "indonesian", "irish", "italian", "latvian", - "norwegian", - "persian", + "norwegian", + "persian", "portuguese", "romanian", "russian", @@ -2579,7 +2579,7 @@ "spanish", "swedish", "thai", - "turkish" + "turkish" ], "x-ms-enum": { "name": "StopwordsList", @@ -2933,7 +2933,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "The marker value that indentifies an item as deleted." + "description": "The marker value that identifies an item as deleted." } } }, @@ -3337,7 +3337,7 @@ "searchable": { "x-ms-client-name": "isSearchable", "type": "boolean", - "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "x-ms-client-name": "isFilterable", @@ -3636,7 +3636,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json index 2e8b5d10bcfd..8c97f972bc3b 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/searchservice.json @@ -4,8 +4,8 @@ "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", "version": "2017-11-11-Preview", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true + "x-ms-code-generation-settings": { + "useDateTimeOffset": true } }, "x-ms-parameterized-host": { @@ -1646,9 +1646,9 @@ "type": "string", "enum": [ "letter", - "digit", - "whitespace", - "punctuation", + "digit", + "whitespace", + "punctuation", "symbol" ], "x-ms-enum": { @@ -1733,52 +1733,52 @@ "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", "externalDocs": { "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" - } + } }, "MicrosoftTokenizerLanguage": { "type": "string", "enum": [ - "bangla", - "bulgarian", - "catalan", + "bangla", + "bulgarian", + "catalan", "chineseSimplified", - "chineseTraditional", - "croatian", - "czech", - "danish", - "dutch", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", "english", - "french", - "german", - "greek", - "gujarati", - "hindi", - "icelandic", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", "indonesian", - "italian", - "japanese", - "kannada", - "korean", - "malay", - "malayalam", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", "marathi", - "norwegianBokmaal", - "polish", - "portuguese", - "portugueseBrazilian", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", "punjabi", - "romanian", - "russian", - "serbianCyrillic", - "serbianLatin", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", "slovenian", - "spanish", - "swedish", - "tamil", - "telugu", - "thai", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", "ukrainian", - "urdu", + "urdu", "vietnamese" ], "x-ms-enum": { @@ -1817,22 +1817,22 @@ "MicrosoftStemmingTokenizerLanguage": { "type": "string", "enum": [ - "arabic", - "bangla", - "bulgarian", + "arabic", + "bangla", + "bulgarian", "catalan", - "croatian", + "croatian", "czech", "danish", "dutch", "english", "estonian", - "finnish", + "finnish", "french", "german", "greek", "gujarati", - "hebrew", + "hebrew", "hindi", "hungarian", "icelandic", @@ -1852,15 +1852,15 @@ "romanian", "russian", "serbianCyrillic", - "serbianLatin", + "serbianLatin", "slovak", "slovenian", "spanish", "swedish", - "tamil", - "telugu", + "tamil", + "telugu", "turkish", - "ukrainian", + "ukrainian", "urdu" ], "x-ms-enum": { @@ -2064,7 +2064,7 @@ "maxTokenLength": { "type": "integer", "format": "int32", - "default": 255, + "default": 255, "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." } }, @@ -2165,7 +2165,7 @@ "katakana", "hangul" ], - "x-ms-enum": { + "x-ms-enum": { "name": "CjkBigramTokenFilterScripts", "modelAsString": false }, @@ -2289,7 +2289,7 @@ "front", "back" ], - "x-ms-enum": { + "x-ms-enum": { "name": "EdgeNGramTokenFilterSide", "modelAsString": false }, @@ -2606,8 +2606,8 @@ "PhoneticEncoder": { "type": "string", "enum": [ - "metaphone", - "doubleMetaphone", + "metaphone", + "doubleMetaphone", "soundex", "refinedSoundex", "caverphone1", @@ -2618,7 +2618,7 @@ "haasePhonetik", "beiderMorse" ], - "x-ms-enum": { + "x-ms-enum": { "name": "PhoneticEncoder", "modelAsString": false }, @@ -2703,23 +2703,23 @@ "armenian", "basque", "catalan", - "danish", - "dutch", - "english", + "danish", + "dutch", + "english", "finnish", - "french", - "german", - "german2", - "hungarian", + "french", + "german", + "german2", + "hungarian", "italian", "kp", - "lovins", + "lovins", "norwegian", "porter", "portuguese", "romanian", - "russian", - "spanish", + "russian", + "spanish", "swedish", "turkish" ], @@ -2753,59 +2753,59 @@ "StemmerTokenFilterLanguage": { "type": "string", "enum": [ - "arabic", - "armenian", - "basque", - "brazilian", + "arabic", + "armenian", + "basque", + "brazilian", "bulgarian", "catalan", "czech", - "danish", + "danish", "dutch", "dutchKp", "english", - "lightEnglish", + "lightEnglish", "minimalEnglish", "possessiveEnglish", "porter2", "lovins", - "finnish", + "finnish", "lightFinnish", "french", "lightFrench", "minimalFrench", - "galician", + "galician", "minimalGalician", "german", "german2", - "lightGerman", + "lightGerman", "minimalGerman", "greek", - "hindi", + "hindi", "hungarian", "lightHungarian", "indonesian", "irish", "italian", "lightItalian", - "sorani", - "latvian", + "sorani", + "latvian", "norwegian", "lightNorwegian", - "minimalNorwegian", + "minimalNorwegian", "lightNynorsk", "minimalNynorsk", "portuguese", - "lightPortuguese", + "lightPortuguese", "minimalPortuguese", "portugueseRslp", "romanian", "russian", "lightRussian", - "spanish", + "spanish", "lightSpanish", "swedish", - "lightSwedish", + "lightSwedish", "turkish" ], "x-ms-enum": { @@ -2878,13 +2878,13 @@ "german", "greek", "hindi", - "hungarian", + "hungarian", "indonesian", "irish", "italian", "latvian", - "norwegian", - "persian", + "norwegian", + "persian", "portuguese", "romanian", "russian", @@ -2892,7 +2892,7 @@ "spanish", "swedish", "thai", - "turkish" + "turkish" ], "x-ms-enum": { "name": "StopwordsList", @@ -3246,7 +3246,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "The marker value that indentifies an item as deleted." + "description": "The marker value that identifies an item as deleted." } } }, @@ -3701,7 +3701,7 @@ "x-ms-client-name": "isSearchable", "type": "boolean", "x-nullable": false, - "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "x-ms-client-name": "isFilterable", @@ -4005,7 +4005,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json index 90f24f1737a3..ed73013a0227 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11/searchservice.json @@ -4,8 +4,8 @@ "title": "SearchServiceClient", "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on an Azure Search service.", "version": "2017-11-11", - "x-ms-code-generation-settings": { - "useDateTimeOffset": true + "x-ms-code-generation-settings": { + "useDateTimeOffset": true } }, "x-ms-parameterized-host": { @@ -1452,9 +1452,9 @@ "type": "string", "enum": [ "letter", - "digit", - "whitespace", - "punctuation", + "digit", + "whitespace", + "punctuation", "symbol" ], "x-ms-enum": { @@ -1539,52 +1539,52 @@ "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", "externalDocs": { "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" - } + } }, "MicrosoftTokenizerLanguage": { "type": "string", "enum": [ - "bangla", - "bulgarian", - "catalan", + "bangla", + "bulgarian", + "catalan", "chineseSimplified", - "chineseTraditional", - "croatian", - "czech", - "danish", - "dutch", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", "english", - "french", - "german", - "greek", - "gujarati", - "hindi", - "icelandic", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", "indonesian", - "italian", - "japanese", - "kannada", - "korean", - "malay", - "malayalam", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", "marathi", - "norwegianBokmaal", - "polish", - "portuguese", - "portugueseBrazilian", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", "punjabi", - "romanian", - "russian", - "serbianCyrillic", - "serbianLatin", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", "slovenian", - "spanish", - "swedish", - "tamil", - "telugu", - "thai", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", "ukrainian", - "urdu", + "urdu", "vietnamese" ], "x-ms-enum": { @@ -1623,22 +1623,22 @@ "MicrosoftStemmingTokenizerLanguage": { "type": "string", "enum": [ - "arabic", - "bangla", - "bulgarian", + "arabic", + "bangla", + "bulgarian", "catalan", - "croatian", + "croatian", "czech", "danish", "dutch", "english", "estonian", - "finnish", + "finnish", "french", "german", "greek", "gujarati", - "hebrew", + "hebrew", "hindi", "hungarian", "icelandic", @@ -1658,15 +1658,15 @@ "romanian", "russian", "serbianCyrillic", - "serbianLatin", + "serbianLatin", "slovak", "slovenian", "spanish", "swedish", - "tamil", - "telugu", + "tamil", + "telugu", "turkish", - "ukrainian", + "ukrainian", "urdu" ], "x-ms-enum": { @@ -1870,7 +1870,7 @@ "maxTokenLength": { "type": "integer", "format": "int32", - "default": 255, + "default": 255, "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." } }, @@ -1971,7 +1971,7 @@ "katakana", "hangul" ], - "x-ms-enum": { + "x-ms-enum": { "name": "CjkBigramTokenFilterScripts", "modelAsString": false }, @@ -2095,7 +2095,7 @@ "front", "back" ], - "x-ms-enum": { + "x-ms-enum": { "name": "EdgeNGramTokenFilterSide", "modelAsString": false }, @@ -2412,8 +2412,8 @@ "PhoneticEncoder": { "type": "string", "enum": [ - "metaphone", - "doubleMetaphone", + "metaphone", + "doubleMetaphone", "soundex", "refinedSoundex", "caverphone1", @@ -2424,7 +2424,7 @@ "haasePhonetik", "beiderMorse" ], - "x-ms-enum": { + "x-ms-enum": { "name": "PhoneticEncoder", "modelAsString": false }, @@ -2509,23 +2509,23 @@ "armenian", "basque", "catalan", - "danish", - "dutch", - "english", + "danish", + "dutch", + "english", "finnish", - "french", - "german", - "german2", - "hungarian", + "french", + "german", + "german2", + "hungarian", "italian", "kp", - "lovins", + "lovins", "norwegian", "porter", "portuguese", "romanian", - "russian", - "spanish", + "russian", + "spanish", "swedish", "turkish" ], @@ -2559,59 +2559,59 @@ "StemmerTokenFilterLanguage": { "type": "string", "enum": [ - "arabic", - "armenian", - "basque", - "brazilian", + "arabic", + "armenian", + "basque", + "brazilian", "bulgarian", "catalan", "czech", - "danish", + "danish", "dutch", "dutchKp", "english", - "lightEnglish", + "lightEnglish", "minimalEnglish", "possessiveEnglish", "porter2", "lovins", - "finnish", + "finnish", "lightFinnish", "french", "lightFrench", "minimalFrench", - "galician", + "galician", "minimalGalician", "german", "german2", - "lightGerman", + "lightGerman", "minimalGerman", "greek", - "hindi", + "hindi", "hungarian", "lightHungarian", "indonesian", "irish", "italian", "lightItalian", - "sorani", - "latvian", + "sorani", + "latvian", "norwegian", "lightNorwegian", - "minimalNorwegian", + "minimalNorwegian", "lightNynorsk", "minimalNynorsk", "portuguese", - "lightPortuguese", + "lightPortuguese", "minimalPortuguese", "portugueseRslp", "romanian", "russian", "lightRussian", - "spanish", + "spanish", "lightSpanish", "swedish", - "lightSwedish", + "lightSwedish", "turkish" ], "x-ms-enum": { @@ -2684,13 +2684,13 @@ "german", "greek", "hindi", - "hungarian", + "hungarian", "indonesian", "irish", "italian", "latvian", - "norwegian", - "persian", + "norwegian", + "persian", "portuguese", "romanian", "russian", @@ -2698,7 +2698,7 @@ "spanish", "swedish", "thai", - "turkish" + "turkish" ], "x-ms-enum": { "name": "StopwordsList", @@ -3052,7 +3052,7 @@ }, "softDeleteMarkerValue": { "type": "string", - "description": "The marker value that indentifies an item as deleted." + "description": "The marker value that identifies an item as deleted." } } }, @@ -3493,7 +3493,7 @@ "x-ms-client-name": "isSearchable", "type": "boolean", "x-nullable": false, - "description": "A value indicating whether the field is included in full-text searches. Valid only forstring or string collection fields. Default is false." + "description": "A value indicating whether the field is included in full-text searches. Valid only for string or string collection fields. Default is false." }, "filterable": { "x-ms-client-name": "isFilterable", @@ -3797,7 +3797,7 @@ "maxAgeInSeconds": { "type": "integer", "format": "int64", - "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 mintues." + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." } }, "required": [ From 87a216c0fdb71d19870c96a8cf7d64d63ae94377 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 05:59:48 -0500 Subject: [PATCH 327/464] typo: signalr/resource-manager/Microsoft.SignalRService (#4781) - excuting -> executing - SingalR -> SignalR - resouce -> resource - indentifier -> identifier --- .../preview/2018-03-01-preview/signalr.json | 16 ++++++++-------- .../stable/2018-10-01/signalr.json | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json index 5ef1352de2f8..6956340076d9 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json @@ -229,7 +229,7 @@ ], "responses": { "201": { - "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "description": "Created and an async operation is executing in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", "schema": { "$ref": "#/definitions/SignalRKeys" } @@ -266,7 +266,7 @@ ], "responses": { "200": { - "description": "Success. The response describe the corresponding SingalR service.", + "description": "Success. The response describe the corresponding SignalR service.", "schema": { "$ref": "#/definitions/SignalRResource" } @@ -315,7 +315,7 @@ } }, "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." } }, "x-ms-long-running-operation": true, @@ -391,13 +391,13 @@ ], "responses": { "200": { - "description": "Success. The response describes a SingalR service which is not up-to-date.", + "description": "Success. The response describes a SignalR service which is not up-to-date.", "schema": { "$ref": "#/definitions/SignalRResource" } }, "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." } }, "x-ms-long-running-operation": true, @@ -675,7 +675,7 @@ "readOnly": true }, "name": { - "description": "The name of the resouce.", + "description": "The name of the resource.", "type": "string", "readOnly": true }, @@ -727,7 +727,7 @@ "readOnly": true }, "name": { - "description": "The name of the resouce.", + "description": "The name of the resource.", "type": "string", "readOnly": true }, @@ -976,7 +976,7 @@ "type": "object", "properties": { "value": { - "description": "The indentifier of the usage.", + "description": "The identifier of the usage.", "type": "string" }, "localizedValue": { diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json index 6c2c47b394f5..e0f3ff03dc69 100644 --- a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2018-10-01/signalr.json @@ -229,7 +229,7 @@ ], "responses": { "201": { - "description": "Created and an async operation is excuting in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "description": "Created and an async operation is executing in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", "schema": { "$ref": "#/definitions/SignalRKeys" } @@ -266,7 +266,7 @@ ], "responses": { "200": { - "description": "Success. The response describe the corresponding SingalR service.", + "description": "Success. The response describe the corresponding SignalR service.", "schema": { "$ref": "#/definitions/SignalRResource" } @@ -315,7 +315,7 @@ } }, "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." } }, "x-ms-long-running-operation": true, @@ -391,13 +391,13 @@ ], "responses": { "200": { - "description": "Success. The response describes a SingalR service which is not up-to-date.", + "description": "Success. The response describes a SignalR service which is not up-to-date.", "schema": { "$ref": "#/definitions/SignalRResource" } }, "202": { - "description": "Accepted. The response indicates the exiting SingalR service is now updating and contains a Location header to query the operation result.." + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." } }, "x-ms-long-running-operation": true, @@ -675,7 +675,7 @@ "readOnly": true }, "name": { - "description": "The name of the resouce.", + "description": "The name of the resource.", "type": "string", "readOnly": true }, @@ -727,7 +727,7 @@ "readOnly": true }, "name": { - "description": "The name of the resouce.", + "description": "The name of the resource.", "type": "string", "readOnly": true }, @@ -976,7 +976,7 @@ "type": "object", "properties": { "value": { - "description": "The indentifier of the usage.", + "description": "The identifier of the usage.", "type": "string" }, "localizedValue": { From 1b6316659d2293d0dd11be5744a03b90cdbd6c5c Mon Sep 17 00:00:00 2001 From: Leonard Francis Date: Wed, 5 Dec 2018 11:43:21 +0000 Subject: [PATCH 328/464] Resource and property changes (#4766) * NFSAAS-1505 minor update and validation fixes * NFSAAS-1505 bring in line with RP Put (and patch) for snapshots. Service level definition changes. * NFSAAS-1505 correct resource reference and limits * NFSAAS-1505 resource and property changes Incorrect pool resource reference Name elements of property not required Correction to return status code * NFSAAS-1505 status codes * NFSAAS-1505 tidy up examples * NFSAAS-1505 tidy up examples --- .../examples/Accounts_CreateOrUpdate.json | 3 +- .../2017-08-15/examples/Accounts_Get.json | 1 - .../2017-08-15/examples/Accounts_List.json | 1 - .../2017-08-15/examples/Accounts_Update.json | 1 - .../2017-08-15/examples/MountTargets_Get.json | 1 - .../examples/MountTargets_List.json | 1 - .../examples/Pools_CreateOrUpdate.json | 7 +- .../2017-08-15/examples/Pools_Get.json | 3 +- .../2017-08-15/examples/Pools_List.json | 3 +- .../2017-08-15/examples/Pools_Update.json | 3 +- .../2017-08-15/examples/Snapshots_Create.json | 26 ++ .../2017-08-15/examples/Snapshots_Get.json | 1 - .../2017-08-15/examples/Snapshots_List.json | 1 - .../2017-08-15/examples/Snapshots_Update.json | 25 ++ .../examples/Volumes_CreateOrUpdate.json | 7 +- .../2017-08-15/examples/Volumes_Get.json | 5 +- .../2017-08-15/examples/Volumes_List.json | 5 +- .../2017-08-15/examples/Volumes_Update.json | 3 +- .../preview/2017-08-15/netapp.json | 248 +++++++++++------- 19 files changed, 217 insertions(+), 128 deletions(-) create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Create.json create mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Update.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_CreateOrUpdate.json index 927adc27928e..c60a0a23b150 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_CreateOrUpdate.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_CreateOrUpdate.json @@ -7,11 +7,10 @@ "body": {} }, "responses": { - "200": { + "201": { "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Get.json index 1a2a98020a18..5147ae612456 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Get.json @@ -10,7 +10,6 @@ "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_List.json index 84191dc2bc71..f1f7d17d6077 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_List.json @@ -11,7 +11,6 @@ { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Update.json index 157edf9f1627..c03d2dd45953 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Update.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Accounts_Update.json @@ -11,7 +11,6 @@ "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json index daed397cc47c..1571403b994d 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json @@ -15,7 +15,6 @@ "properties": { "endIp": "1.2.3.4", "mountTargetId": "9760acf5-4638-11e7-9bdb-020073ca3333", - "name": "mountTarget1", "startIp": "1.2.3.4", "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", "vlanId": 1337, diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_List.json index 8bc21a197dcd..bcd4a56f85b9 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_List.json @@ -16,7 +16,6 @@ "properties": { "endIp": "1.2.3.4", "mountTargetId": "9760acf5-4638-11e7-9bdb-020073ca3333", - "name": "mountTarget1", "startIp": "1.2.3.4", "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", "vlanId": 1337, diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json index c3b0ff61a100..10e856ed8e0a 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json @@ -8,18 +8,17 @@ "body": {} }, "responses": { - "200": { + "201": { "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created", "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", "serviceLevel": "Premium", - "size": 12345 + "size": 4398046511104 } } - }, + }, "202": {} } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Get.json index 326433caa272..25aed0d6e384 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Get.json @@ -11,11 +11,10 @@ "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created", "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", "serviceLevel": "Premium", - "size": 12345 + "size": 4398046511104 } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_List.json index e4dbb0624a0a..5bccee6836c3 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_List.json @@ -12,11 +12,10 @@ { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created", "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", "serviceLevel": "Premium", - "size": 12345 + "size": 4398046511104 } } ] diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Update.json index 2dfb6f0d7166..6a8308ab5fc0 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Update.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_Update.json @@ -12,11 +12,10 @@ "body": { "location": "eastus", "properties": { - "accountId": "9760acf5-4638-11e7-9bdb-020073ca7778", "provisioningState": "Created", "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", "serviceLevel": "Premium", - "size": 12345 + "size": 4398046511104 } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Create.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Create.json new file mode 100644 index 000000000000..8cc5b55490ed --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2017-08-15", + "body": {} + }, + "responses": { + "201": { + "body": { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + }, + "202": {} + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Get.json index 5c660d874a8a..1869ef8f13de 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Get.json @@ -16,7 +16,6 @@ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", "creationDate": "2017-08-15T13:23:33Z", - "name": "snapshot1", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_List.json index e71030ad44c2..61fc3f1f5ec0 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_List.json @@ -17,7 +17,6 @@ "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", "creationDate": "2017-08-15T13:23:33Z", - "name": "snapshot1", "provisioningState": "Created" } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Update.json new file mode 100644 index 000000000000..cfbb9f2dbff0 --- /dev/null +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Snapshots_Update.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroup": "resourceGroup", + "accountName": "accountName", + "poolName": "poolName", + "volumeName": "volumeName", + "snapshotName": "snapshotName", + "api-version": "2017-08-15", + "body": {} + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "snapshotId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", + "creationDate": "2017-08-15T13:23:33Z", + "provisioningState": "Created" + } + } + } + } +} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json index fd4a9a31e044..a33791786874 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json @@ -9,17 +9,16 @@ "body": {} }, "responses": { - "200": { + "201": { "body": { "location": "eastus", "properties": { "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", - "name": "myvolume", "creationToken": "some-amazing-filepath", - "usageThreshold": 101010, + "usageThreshold": 107374182400, "serviceLevel": "Premium", "provisioningState": "Created", - "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroup/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" } } }, diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Get.json index db4770e998c4..67bd0e2abbd3 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Get.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Get.json @@ -13,12 +13,11 @@ "location": "eastus", "properties": { "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", - "name": "myvolume", "creationToken": "some-amazing-filepath", - "usageThreshold": 101010, + "usageThreshold": 107374182400, "serviceLevel": "Premium", "provisioningState": "Created", - "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroup/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" } } } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_List.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_List.json index 73b7c041619e..152c8d088946 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_List.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_List.json @@ -14,12 +14,11 @@ "location": "eastus", "properties": { "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", - "name": "myvolume", "creationToken": "some-amazing-filepath", - "usageThreshold": 101010, + "usageThreshold": 107374182400, "serviceLevel": "Premium", "provisioningState": "Created", - "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroup/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" } } ] diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Update.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Update.json index 43e41f274568..98002937dd14 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Update.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_Update.json @@ -14,9 +14,8 @@ "location": "eastus", "properties": { "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", - "name": "myvolume", "creationToken": "some-amazing-filepath", - "usageThreshold": 101010, + "usageThreshold": 107374182400, "serviceLevel": "Premium", "provisioningState": "Created" } diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json index ce4eac947bfd..1bd7af70c77d 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json @@ -68,7 +68,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -110,7 +110,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -169,7 +169,7 @@ } ], "responses": { - "200": { + "201": { "description": "Account created", "schema": { "$ref": "#/definitions/netAppAccount" @@ -257,7 +257,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -302,7 +302,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroup/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -364,7 +364,7 @@ } ], "responses": { - "200": { + "201": { "description": "Pool created or updated", "schema": { "$ref": "#/definitions/capacityPool" @@ -452,7 +452,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -500,7 +500,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -565,7 +565,7 @@ } ], "responses": { - "200": { + "201": { "description": "Volume created or updated", "schema": { "$ref": "#/definitions/volume" @@ -653,7 +653,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}/mountTargets": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -704,7 +704,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}/mountTargets/{mountTargetName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets/{mountTargetName}": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -755,7 +755,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}/snapshots": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -806,7 +806,7 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/pools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}": { "parameters": [ { "$ref": "#/parameters/SubscriptionId" @@ -856,6 +856,84 @@ } } }, + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Create", + "description": "Create a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshot" + } + } + ], + "responses": { + "201": { + "description": "Snapshot created", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "202": { + "description": "Accepted -- Create request accepted; operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Snapshots_Create": { + "$ref": "examples/Snapshots_Create.json" + } + } + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "description": "Patch a snapshot", + "parameters": [ + { + "name": "body", + "description": "Snapshot object supplied in the body of the operation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/snapshotPatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/snapshot" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/error" + } + } + }, + "x-ms-examples": { + "Snapshots_Update": { + "$ref": "examples/Snapshots_Update.json" + } + } + }, "delete": { "tags": [ "Snapshots" @@ -1087,16 +1165,6 @@ "description": "NetApp account properties", "type": "object", "properties": { - "accountId": { - "title": "accountId", - "type": "string", - "readOnly": true, - "description": "UUID v4 used to identify the Account", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca7778" - }, "provisioningState": { "type": "string", "readOnly": true, @@ -1174,19 +1242,7 @@ "poolProperties": { "description": "Pool properties", "type": "object", - "required": [ - "accountId" - ], "properties": { - "accountId": { - "title": "accountId", - "type": "string", - "description": "UUID v4 used to identify the Account", - "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$", - "maxLength": 36, - "minLength": 36, - "example": "9760acf5-4638-11e7-9bdb-020073ca7778" - }, "poolId": { "title": "poolId", "type": "string", @@ -1200,27 +1256,25 @@ "size": { "title": "size", "type": "integer", - "description": "Provisioned size of the pool (in GB)", - "minimum": 4096, - "default": 4096 + "format": "int64", + "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).", + "minimum": 4398046511104, + "maximum": 549755813888000, + "default": 4398046511104 }, "serviceLevel": { "title": "serviceLevel", "type": "string", "description": "The service level of the file system", "enum": [ - "Basic", "Standard", - "Premium" + "Premium", + "Extreme" ], "x-ms-enum": { "name": "ServiceLevel", "modelAsString": true, "values": [ - { - "value": "Basic", - "description": "Basic service level" - }, { "value": "Standard", "description": "Standard service level" @@ -1228,11 +1282,15 @@ { "value": "Premium", "description": "Premium service level" + }, + { + "value": "Extreme", + "description": "Extreme service level" } ] }, - "example": "Premium", - "default": "Standard" + "example": "Extreme", + "default": "Premium" }, "provisioningState": { "type": "string", @@ -1319,12 +1377,6 @@ "minLength": 36, "example": "9760acf5-4638-11e7-9bdb-020073ca7778" }, - "name": { - "title": "FileSystem name", - "type": "string", - "description": "FileSystem name", - "example": "myvolume" - }, "creationToken": { "title": "Creation Token or File Path", "type": "string", @@ -1338,18 +1390,14 @@ "type": "string", "description": "The service level of the file system", "enum": [ - "Basic", "Standard", - "Premium" + "Premium", + "Extreme" ], "x-ms-enum": { "name": "ServiceLevel", "modelAsString": true, "values": [ - { - "value": "Basic", - "description": "Basic service level" - }, { "value": "Standard", "description": "Standard service level" @@ -1357,21 +1405,25 @@ { "value": "Premium", "description": "Premium service level" + }, + { + "value": "Extreme", + "description": "Extreme service level" } ] }, - "example": "Premium", - "default": "Standard" + "example": "Extreme", + "default": "Premium" }, "usageThreshold": { "title": "usageThreshold", "type": "integer", "format": "int64", - "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Upper limit is 100TB.", - "minimum": 0, + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", + "minimum": 107374182400, "maximum": 109951162777600, - "default": 0, - "example": 101010 + "default": 107374182400, + "example": 107374182400 }, "provisioningState": { "type": "string", @@ -1423,29 +1475,19 @@ "description": "Patchable volume properties", "type": "object", "properties": { - "name": { - "title": "FileSystem name", - "type": "string", - "description": "FileSystem name", - "example": "myvolume" - }, "serviceLevel": { "title": "serviceLevel", "type": "string", "description": "The service level of the file system", "enum": [ - "Basic", "Standard", - "Premium" + "Premium", + "Extreme" ], "x-ms-enum": { "name": "ServiceLevel", "modelAsString": true, "values": [ - { - "value": "Basic", - "description": "Basic service level" - }, { "value": "Standard", "description": "Standard service level" @@ -1453,21 +1495,25 @@ { "value": "Premium", "description": "Premium service level" + }, + { + "value": "Extreme", + "description": "Extreme service level" } ] }, - "example": "Premium", - "default": "Standard" + "example": "Extreme", + "default": "Premium" }, "usageThreshold": { "title": "usageThreshold", "type": "integer", "format": "int64", - "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Upper limit is 100TB.", - "minimum": 0, + "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB.", + "minimum": 107374182400, "maximum": 109951162777600, - "default": 0, - "example": 101010 + "default": 107374182400, + "example": 107374182400 } } }, @@ -1551,13 +1597,6 @@ "readOnly": true, "example": "1.2.3.4" }, - "name": { - "title": "name", - "type": "string", - "readOnly": true, - "description": "The name of the mount target", - "example": "mountTarget1" - }, "vlanId": { "title": "vlanid", "type": "integer", @@ -1611,6 +1650,7 @@ "snapshot": { "description": "Snapshot of a Volume", "type": "object", + "x-ms-azure-resource": true, "required": [ "location", "properties" @@ -1618,7 +1658,11 @@ "properties": { "location": { "type": "string", - "description": "Resource location" + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] }, "id": { "type": "string", @@ -1630,6 +1674,11 @@ "readOnly": true, "description": "Resource name" }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + }, "tags": { "description": "Resource tags", "$ref": "#/definitions/resourceTags", @@ -1642,6 +1691,18 @@ } } }, + "snapshotPatch": { + "description": "Snapshot patch", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "tags": { + "description": "Resource tags", + "$ref": "#/definitions/resourceTags", + "x-ms-client-flatten": true + } + } + }, "snapshotProperties": { "description": "Snapshot properties", "type": "object", @@ -1668,13 +1729,6 @@ "minLength": 36, "example": "9760acf5-4638-11e7-9bdb-020073ca3333" }, - "name": { - "title": "name", - "type": "string", - "readOnly": true, - "description": "The name of the snapshot", - "example": "snapshot1" - }, "creationDate": { "title": "name", "type": "string", From 8aca29b191e5ef3fdf76b4e549d233f0e3d0c44b Mon Sep 17 00:00:00 2001 From: DI QIU Date: Wed, 5 Dec 2018 09:38:48 -0800 Subject: [PATCH 329/464] MSI move 2018-11-30 in stable folder (#4768) --- .../{ => stable}/2018-11-30/ManagedIdentity.json | 0 .../{ => stable}/2018-11-30/examples/IdentityCreate.json | 0 .../{ => stable}/2018-11-30/examples/IdentityDelete.json | 0 .../{ => stable}/2018-11-30/examples/IdentityGet.json | 0 .../2018-11-30/examples/IdentityListByResourceGroup.json | 0 .../2018-11-30/examples/IdentityListBySubscription.json | 0 .../{ => stable}/2018-11-30/examples/IdentityUpdate.json | 0 .../{ => stable}/2018-11-30/examples/MsiOperationsList.json | 0 specification/msi/resource-manager/readme.md | 2 +- 9 files changed, 1 insertion(+), 1 deletion(-) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/ManagedIdentity.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityCreate.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityDelete.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityGet.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityListByResourceGroup.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityListBySubscription.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/IdentityUpdate.json (100%) rename specification/msi/resource-manager/Microsoft.ManagedIdentity/{ => stable}/2018-11-30/examples/MsiOperationsList.json (100%) diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityCreate.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityCreate.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityCreate.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityDelete.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityDelete.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityDelete.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityGet.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityGet.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityGet.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityListByResourceGroup.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListByResourceGroup.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityListByResourceGroup.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityListBySubscription.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityListBySubscription.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityListBySubscription.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityUpdate.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/IdentityUpdate.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/IdentityUpdate.json diff --git a/specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json b/specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/MsiOperationsList.json similarity index 100% rename from specification/msi/resource-manager/Microsoft.ManagedIdentity/2018-11-30/examples/MsiOperationsList.json rename to specification/msi/resource-manager/Microsoft.ManagedIdentity/stable/2018-11-30/examples/MsiOperationsList.json diff --git a/specification/msi/resource-manager/readme.md b/specification/msi/resource-manager/readme.md index 7e63c2f6d6c8..2dc170946d56 100644 --- a/specification/msi/resource-manager/readme.md +++ b/specification/msi/resource-manager/readme.md @@ -31,7 +31,7 @@ These settings apply only when `--tag=package-2018-11-30` is specified on the co ``` yaml $(tag) == 'package-2018-11-30' input-file: -- Microsoft.ManagedIdentity/2018-11-30/ManagedIdentity.json +- Microsoft.ManagedIdentity/stable/2018-11-30/ManagedIdentity.json ``` ### Tag: package-2015-08-31-preview From b1fdf28a40e4e141caabdf466e850ec365fb7ace Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 13:32:41 -0500 Subject: [PATCH 330/464] typo: storagesync/resource-manager/Microsoft.StorageSync (#4787) - Asynchronuous -> Asynchronous - serverendpoint -> server endpoint --- .../2017-06-05-preview/storagesync.json | 26 ++++++++-------- .../preview/2018-10-01/storagesync.json | 30 +++++++++---------- .../stable/2018-04-02/storagesync.json | 28 ++++++++--------- .../stable/2018-07-01/storagesync.json | 30 +++++++++---------- 4 files changed, 57 insertions(+), 57 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json index 8173b4765fea..cf1728014480 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json @@ -717,7 +717,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -876,7 +876,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1053,7 +1053,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1156,7 +1156,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1242,7 +1242,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1397,7 +1397,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1494,7 +1494,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1592,7 +1592,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1747,7 +1747,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1882,7 +1882,7 @@ "Actions" ], "operationId": "ServerEndpoints_Recall", - "description": "Recall a serverendpoint.", + "description": "Recall a server endpoint.", "x-ms-examples": { "ServerEndpoints_Recall": { "$ref": "./examples/ServerEndpoints_Recall.json" @@ -1903,7 +1903,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2113,7 +2113,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -2193,7 +2193,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json index 85109f747819..24d14b9204f9 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2018-10-01/storagesync.json @@ -698,7 +698,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -843,7 +843,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1006,7 +1006,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1101,7 +1101,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1179,7 +1179,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1319,7 +1319,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1408,7 +1408,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1498,7 +1498,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1639,7 +1639,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1769,7 +1769,7 @@ "Actions" ], "operationId": "ServerEndpoints_recallAction", - "description": "Recall a serverendpoint.", + "description": "Recall a server endpoint.", "x-ms-examples": { "ServerEndpoints_recallAction": { "$ref": "./examples/ServerEndpoints_Recall.json" @@ -1790,7 +1790,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1982,7 +1982,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -2056,7 +2056,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2140,7 +2140,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2668,7 +2668,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServerEndpointUpdateProperties", - "description": "The properties of the serverendpoint." + "description": "The properties of the server endpoint." } }, "description": "Parameters for updating an Server Endpoint." diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json index 35081af77fa1..8ac5a5e44017 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-04-02/storagesync.json @@ -762,7 +762,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -921,7 +921,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1098,7 +1098,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1201,7 +1201,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1287,7 +1287,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1442,7 +1442,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1539,7 +1539,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1637,7 +1637,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1792,7 +1792,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1936,7 +1936,7 @@ "Actions" ], "operationId": "ServerEndpoints_recallAction", - "description": "Recall a serverendpoint.", + "description": "Recall a server endpoint.", "x-ms-examples": { "ServerEndpoints_recallAction": { "$ref": "./examples/ServerEndpoints_Recall.json" @@ -1957,7 +1957,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2167,7 +2167,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -2247,7 +2247,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2751,7 +2751,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServerEndpointUpdateProperties", - "description": "The properties of the serverendpoint." + "description": "The properties of the server endpoint." } }, "description": "Parameters for updating an Server Endpoint." diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json index 6feff0373787..38cdc29d3f9e 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2018-07-01/storagesync.json @@ -698,7 +698,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -843,7 +843,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1006,7 +1006,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1101,7 +1101,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1179,7 +1179,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1319,7 +1319,7 @@ "description": "Ok" }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1408,7 +1408,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1498,7 +1498,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -1639,7 +1639,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1769,7 +1769,7 @@ "Actions" ], "operationId": "ServerEndpoints_recallAction", - "description": "Recall a serverendpoint.", + "description": "Recall a server endpoint.", "x-ms-examples": { "ServerEndpoints_recallAction": { "$ref": "./examples/ServerEndpoints_Recall.json" @@ -1790,7 +1790,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -1982,7 +1982,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Azure-AsyncOperation": { "description": "Operation Status Location URI", @@ -2056,7 +2056,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2140,7 +2140,7 @@ } }, "202": { - "description": "Asynchronuous Operation Status Location", + "description": "Asynchronous Operation Status Location", "headers": { "Location": { "description": "Operation Status Location URI", @@ -2660,7 +2660,7 @@ "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/ServerEndpointUpdateProperties", - "description": "The properties of the serverendpoint." + "description": "The properties of the server endpoint." } }, "description": "Parameters for updating an Server Endpoint." From 478a692ec00d5c2fddf7dad5ec1af5f7a8e6d19a Mon Sep 17 00:00:00 2001 From: Veronica Giaudrone Date: Wed, 5 Dec 2018 10:33:49 -0800 Subject: [PATCH 331/464] graphrbac - updating folder structure to be more consistent (#4776) * updating folder structure to be more consistent with the rest of the services * updating file due to not desired automatic formatting * updating to Microsoft.GraphRbac --- .../{ => Microsoft.GraphRbac}/stable/1.6/graphrbac.json | 0 specification/graphrbac/data-plane/readme.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename specification/graphrbac/data-plane/{ => Microsoft.GraphRbac}/stable/1.6/graphrbac.json (100%) diff --git a/specification/graphrbac/data-plane/stable/1.6/graphrbac.json b/specification/graphrbac/data-plane/Microsoft.GraphRbac/stable/1.6/graphrbac.json similarity index 100% rename from specification/graphrbac/data-plane/stable/1.6/graphrbac.json rename to specification/graphrbac/data-plane/Microsoft.GraphRbac/stable/1.6/graphrbac.json diff --git a/specification/graphrbac/data-plane/readme.md b/specification/graphrbac/data-plane/readme.md index fc06a3929da1..2f5731187931 100644 --- a/specification/graphrbac/data-plane/readme.md +++ b/specification/graphrbac/data-plane/readme.md @@ -36,7 +36,7 @@ These settings apply only when `--tag=1.6` is specified on the command line. ``` yaml $(tag) == '1.6' input-file: -- stable/1.6/graphrbac.json +- Microsoft.GraphRbac/stable/1.6/graphrbac.json ``` --- From 31cfb4bb47271f1c65f8f11ba5c78a6df8f7c253 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 13:34:49 -0500 Subject: [PATCH 332/464] typo: security/resource-manager/Microsoft.Security (#4763) - Double word "alert" - addess -> address - whos -> whose --- .../preview/2015-06-01-preview/security.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json index bd0b9f27ef39..9b3f52583b9e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2015-06-01-preview/security.json @@ -510,7 +510,7 @@ "tags": [ "Alerts" ], - "description": "List all the alerts alerts that are associated with the resource group", + "description": "List all the alerts that are associated with the resource group", "operationId": "Alerts_ListByResourceGroup", "parameters": [ { @@ -2522,7 +2522,7 @@ "type": "array", "description": "Mutually exclusive with the \"allowedSourceAddressPrefix\" parameter.", "items": { - "description": "IP addess or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\".", + "description": "IP address or CIDR, for example \"192.168.0.3\" or \"192.168.0.0/16\".", "type": "string" } }, @@ -2661,7 +2661,7 @@ }, "ExternalSecuritySolution": { "type": "object", - "description": "Represents a security solution external to Azure Security Center which sends information to an OMS workspace and whos data is displayed by Azure Security Center.", + "description": "Represents a security solution external to Azure Security Center which sends information to an OMS workspace and whose data is displayed by Azure Security Center.", "discriminator": "kind", "properties": {}, "allOf": [ From 5ba20f526d6965bc6f9284175a740bfd6b9c43df Mon Sep 17 00:00:00 2001 From: Laura Galbraith Date: Wed, 5 Dec 2018 10:51:12 -0800 Subject: [PATCH 333/464] Update HanaOnAzure Swagger to support new SKU: S96 (#4773) Update spec and validate examples - Make small correction to invalid HanaInstances_ListByResourceGroup example --- .../examples/HanaInstances_List.json | 30 +++++++++++++++++++ .../HanaInstances_ListByResourceGroup.json | 1 - .../2017-11-03-preview/hanaonazure.json | 1 + 3 files changed, 31 insertions(+), 1 deletion(-) diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json index 05b116de14da..11c30cc0a736 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_List.json @@ -102,6 +102,36 @@ "version": "12 SP1" } } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance4", + "name": "myHanaInstance4", + "type": "Microsoft.HanaOnAzure/hanaInstances", + "location": "westus", + "properties": { + "hanaInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "hanaInstanceSize": "S96" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.103" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup2/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.203" + }, + "osProfile": { + "computerName": "myComputerName4", + "osType": "SUSE", + "version": "12 SP1" + } + } } ] } diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json index 5ccbac5a8b4a..816eb6e01f9a 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_ListByResourceGroup.json @@ -46,7 +46,6 @@ "name": "myHanaInstance2", "type": "Microsoft.HanaOnAzure/hanaInstances", "location": "westus", - "powerState": "started", "tags": { "key": "value" }, diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index e68955be0e3c..25528e40009a 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -370,6 +370,7 @@ "S192", "S192m", "S192xm", + "S96", "S384", "S384m", "S384xm", From 910d752875445b21c5e400aa3070dc0b429a1b5b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 13:55:06 -0500 Subject: [PATCH 334/464] typo: service-map/resource-manager/Microsoft.OperationalInsights (#4764) - virtualizaton -> virtualization - sytem -> system - hostring -> hosting - indentifier -> identifier - Idendifier -> Identifier --- .../2015-11-01-preview/arm-service-map.json | 14 +++++++------- .../service-map/resource-manager/readme.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/service-map/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json b/specification/service-map/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json index 5830a62d4b10..2962a420069c 100644 --- a/specification/service-map/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json +++ b/specification/service-map/resource-manager/Microsoft.OperationalInsights/preview/2015-11-01-preview/arm-service-map.json @@ -2707,7 +2707,7 @@ } }, "VirtualMachineConfiguration": { - "description": "Describes the virtualizaton-related configuration of a machine.", + "description": "Describes the virtualization-related configuration of a machine.", "properties": { "virtualMachineType": { "$ref": "#/definitions/VirtualMachineType", @@ -2715,7 +2715,7 @@ }, "nativeMachineId": { "type": "string", - "description": "The unique identifier of the virtual machine as reported by the underlying virtualization sytem." + "description": "The unique identifier of the virtual machine as reported by the underlying virtualization system." }, "virtualMachineName": { "type": "string", @@ -2753,7 +2753,7 @@ }, "kind": { "type": "string", - "description": "Additional hostring configuration type qualifier.", + "description": "Additional hosting configuration type qualifier.", "enum": [ "provider:azure" ] @@ -2890,7 +2890,7 @@ }, "clusterId": { "type": "string", - "description": "Service Fabric cluster indentifier." + "description": "Service Fabric cluster identifier." } } }, @@ -2933,7 +2933,7 @@ "properties": { "persistentKey": { "type": "string", - "description": "A unique indentifier for a process, generally resilient to process restart, computed by Service Map." + "description": "A unique identifier for a process, generally resilient to process restart, computed by Service Map." }, "poolId": { "type": "integer", @@ -2943,7 +2943,7 @@ "firstPid": { "type": "integer", "format": "int32", - "description": "The Operating System Process Idendifier (PID) of the first process in this process pool." + "description": "The Operating System Process Identifier (PID) of the first process in this process pool." }, "description": { "type": "string", @@ -3020,7 +3020,7 @@ }, "kind": { "type": "string", - "description": "Additional hostring configuration type qualifier.", + "description": "Additional hosting configuration type qualifier.", "enum": [ "provider:azure" ] diff --git a/specification/service-map/resource-manager/readme.md b/specification/service-map/resource-manager/readme.md index bdbc83a80011..e297a5c289b6 100644 --- a/specification/service-map/resource-manager/readme.md +++ b/specification/service-map/resource-manager/readme.md @@ -24,7 +24,7 @@ Following are the settings for using this specification with [AutoRest](https:// Suppressed Rule | Reason ----------------|-------- -R3023 OperationsAPIImplementation | Service map is sharing RP with Log Analytics, so this operaration won't reach ServiceMap's service endpoint. Hence this rule is not applicable. +R3023 OperationsAPIImplementation | Service map is sharing RP with Log Analytics, so this operation won't reach ServiceMap's service endpoint. Hence this rule is not applicable. ```yaml model-validator: true From 94697e4be1a8a0903e3fd293273f7a17a3fafc59 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Wed, 5 Dec 2018 11:03:34 -0800 Subject: [PATCH 335/464] fix Go SDK codegen for devtestlabs package-2018-09 (#4794) --- specification/devtestlabs/resource-manager/readme.go.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/devtestlabs/resource-manager/readme.go.md b/specification/devtestlabs/resource-manager/readme.go.md index e5db00b37552..a8e7bc728d5d 100644 --- a/specification/devtestlabs/resource-manager/readme.go.md +++ b/specification/devtestlabs/resource-manager/readme.go.md @@ -23,8 +23,8 @@ batch: These settings apply only when `--tag=package-2018-09 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. -``` yaml $(tag) == 'package-2018-09-preview' && $(go) -output-folder: $(go-sdk-folder)/services/devtestlabs/mgmt/2015-09-15/$(namespace) +``` yaml $(tag) == 'package-2018-09' && $(go) +output-folder: $(go-sdk-folder)/services/devtestlabs/mgmt/2018-09-15/$(namespace) ``` ### Tag: package-2016-05 and go From d02b8b65bf8ce5d8322c92530bf6b2e6dd3b9aab Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 14:14:19 -0500 Subject: [PATCH 336/464] chore: Rename microsoft.insights to Microsoft.Insights (#4713) * chore: Rename microsoft.insights to Microsoft.Insights * fix: Casing on applicationinsights/resource-manager YAML metadata --- .../preview/2017-10-01/componentFeaturesAndPricing_API.json | 0 .../preview/2017-10-01/eaSubscriptionMigration_API.json | 0 .../2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json | 0 .../preview/2017-10-01/examples/CurrentPricingPlanGet.json | 0 .../preview/2017-10-01/examples/CurrentPricingPlanUpdate.json | 0 .../2017-10-01/examples/EASubscriptionListMigrationDate.json | 0 .../examples/EASubscriptionMigrateToNewPricingModelPost.json | 0 .../EASubscriptionRollbackToLegacyPricingModelPost.json | 0 .../stable/2015-05-01/analyticsItems_API.json | 0 .../stable/2015-05-01/examples/AnalyticsItemDelete.json | 0 .../stable/2015-05-01/examples/AnalyticsItemGet.json | 0 .../stable/2015-05-01/examples/AnalyticsItemList.json | 0 .../stable/2015-05-01/examples/AnalyticsItemPut.json | 0 specification/applicationinsights/resource-manager/readme.md | 2 +- 14 files changed, 1 insertion(+), 1 deletion(-) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/componentFeaturesAndPricing_API.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/eaSubscriptionMigration_API.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/CurrentPricingPlanGet.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/EASubscriptionListMigrationDate.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/EASubscriptionMigrateToNewPricingModelPost.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-10-01/examples/EASubscriptionRollbackToLegacyPricingModelPost.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-05-01/analyticsItems_API.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-05-01/examples/AnalyticsItemDelete.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-05-01/examples/AnalyticsItemGet.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-05-01/examples/AnalyticsItemList.json (100%) rename specification/applicationinsights/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-05-01/examples/AnalyticsItemPut.json (100%) diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/componentFeaturesAndPricing_API.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/componentFeaturesAndPricing_API.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/eaSubscriptionMigration_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/eaSubscriptionMigration_API.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/eaSubscriptionMigration_API.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/eaSubscriptionMigration_API.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanCreateAndUpdate.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanGet.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanGet.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanGet.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/CurrentPricingPlanUpdate.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionListMigrationDate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionListMigrationDate.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionListMigrationDate.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionListMigrationDate.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionMigrateToNewPricingModelPost.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionMigrateToNewPricingModelPost.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionMigrateToNewPricingModelPost.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionMigrateToNewPricingModelPost.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionRollbackToLegacyPricingModelPost.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionRollbackToLegacyPricingModelPost.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/preview/2017-10-01/examples/EASubscriptionRollbackToLegacyPricingModelPost.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2017-10-01/examples/EASubscriptionRollbackToLegacyPricingModelPost.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/analyticsItems_API.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemDelete.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemDelete.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemDelete.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemDelete.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemGet.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemGet.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemGet.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemList.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemList.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemList.json diff --git a/specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemPut.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemPut.json similarity index 100% rename from specification/applicationinsights/resource-manager/microsoft.insights/stable/2015-05-01/examples/AnalyticsItemPut.json rename to specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/AnalyticsItemPut.json diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index 8118aaee342a..b8f5fe7471f7 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -254,7 +254,7 @@ input-file: - Microsoft.Insights/stable/2015-05-01/favorites_API.json - Microsoft.Insights/stable/2015-05-01/webTestLocations_API.json - Microsoft.Insights/stable/2015-05-01/webTests_API.json -- microsoft.insights/stable/2015-05-01/analyticsItems_API.json +- Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json - Microsoft.Insights/stable/2015-05-01/workbooks_API.json ``` From aa4b03c93d7f51e8a712ce0a4628aa7e1bd724de Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 20:20:06 -0500 Subject: [PATCH 337/464] typo: servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh (#4779) - Double word "the" - deletd -> deleted - unecrypted -> unencrypted - hamdle -> handle - ReliableCollectionsRef capitalization --- .../preview/2018-09-01-preview/servicefabricmesh.json | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json index b9904d27b2c4..dee8fb7b1d56 100644 --- a/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json +++ b/specification/servicefabricmesh/resource-manager/Microsoft.ServiceFabricMesh/preview/2018-09-01-preview/servicefabricmesh.json @@ -456,7 +456,7 @@ "$ref": "./examples/secrets/values/list.json" } }, - "summary": "List names of all values of the the specified secret resource.", + "summary": "List names of all values of the specified secret resource.", "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", "parameters": [ { @@ -1732,7 +1732,7 @@ }, { "value": "Deleting", - "description": "Indicates the resource is being deletd. The value is 4." + "description": "Indicates the resource is being deleted. The value is 4." }, { "value": "Failed", @@ -2160,7 +2160,7 @@ ] }, "SecretValueResourceDescriptionList": { - "description": "A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unecrypted value.", + "description": "A pageable list of values of a secret resource. The information does not include only the name of the value and not the actual unencrypted value.", "type": "object", "properties": { "value": { @@ -2639,7 +2639,7 @@ }, "routes": { "type": "array", - "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can hamdle general cases.", + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.", "items": { "$ref": "#/definitions/HttpRouteConfig" } @@ -3296,7 +3296,7 @@ "description": "Reference to sinks in DiagnosticsDescription." }, "reliableCollectionsRefs": { - "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliablecollectionsRef for more details.", + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.", "type": "array", "items": { "$ref": "#/definitions/ReliableCollectionsRef" From 822d1c1a7ff3994a8fbe01d6fb1b0591182bf610 Mon Sep 17 00:00:00 2001 From: olrakovs <39234482+olrakovs@users.noreply.github.com> Date: Thu, 6 Dec 2018 03:24:02 +0200 Subject: [PATCH 338/464] Editing ReportConfigDefinition (#4790) --- .../preview/2018-12-01-preview/costmanagement.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json index b670354f6fd2..8beb3487b66c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-12-01-preview/costmanagement.json @@ -1241,9 +1241,7 @@ "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", "type": "string", "enum": [ - "Usage", - "Forecast", - "UsageAndForecast" + "Usage" ], "x-ms-enum": { "name": "ReportType", From 397de15012789a9b87f31b74d3ac970a4bdcb540 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 5 Dec 2018 23:20:01 -0500 Subject: [PATCH 339/464] chore: Enable whitespace trimming in JSON files (#4791) --- .editorconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.editorconfig b/.editorconfig index ec1feb2198c5..6461786ab6f9 100644 --- a/.editorconfig +++ b/.editorconfig @@ -6,4 +6,4 @@ root = true [*.json] indent_style = space indent_size = 2 -trim_trailing_whitespace = false +trim_trailing_whitespace = true From 4342342fca475d5098bcec806e7d87acaf191dc4 Mon Sep 17 00:00:00 2001 From: Suna Liu Date: Thu, 6 Dec 2018 12:21:23 +0800 Subject: [PATCH 340/464] Update database collation in examples for mysql and mariadb (#4801) --- .../2018-06-01-preview/examples/DatabaseCreate.json | 12 ++++++------ .../2018-06-01-preview/examples/DatabaseGet.json | 4 ++-- .../examples/DatabaseListByServer.json | 8 ++++---- .../2017-12-01-preview/examples/DatabaseCreate.json | 12 ++++++------ .../2017-12-01-preview/examples/DatabaseGet.json | 4 ++-- .../examples/DatabaseListByServer.json | 8 ++++---- .../stable/2017-12-01/examples/DatabaseCreate.json | 12 ++++++------ .../stable/2017-12-01/examples/DatabaseGet.json | 4 ++-- .../2017-12-01/examples/DatabaseListByServer.json | 8 ++++---- 9 files changed, 36 insertions(+), 36 deletions(-) diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseCreate.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseCreate.json index 25d57a285bdb..5cbd8be4c95c 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseCreate.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseCreate.json @@ -7,8 +7,8 @@ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { "properties":{ - "charset":"UTF8", - "collation":"English_United States.1252" + "charset":"utf8", + "collation":"utf8_general_ci" } } }, @@ -19,8 +19,8 @@ "name": "db1", "type": "Microsoft.DBforMariaDB/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, @@ -30,8 +30,8 @@ "name": "db1", "type": "Microsoft.DBforMariaDB/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseGet.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseGet.json index 1ce9661b470b..ad3e04ba91b0 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseGet.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseGet.json @@ -13,8 +13,8 @@ "name": "db1", "type": "Microsoft.DBforMariaDB/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } } diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseListByServer.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseListByServer.json index 2572b1f36c6c..433d9de6239e 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseListByServer.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/preview/2018-06-01-preview/examples/DatabaseListByServer.json @@ -14,8 +14,8 @@ "name": "db1", "type": "Microsoft.DBforMariaDB/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } }, { @@ -23,8 +23,8 @@ "name": "db2", "type": "Microsoft.DBforMariaDB/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } ] diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseCreate.json index c8bde488a376..5459c5080944 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseCreate.json @@ -7,8 +7,8 @@ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { "properties":{ - "charset":"UTF8", - "collation":"English_United States.1252" + "charset":"utf8", + "collation":"utf8_general_ci" } } }, @@ -19,8 +19,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, @@ -30,8 +30,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseGet.json index 98ee7be84291..e21c5cbef64e 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseGet.json @@ -13,8 +13,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } } diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseListByServer.json index 292e1ba8a674..6743dde8b79c 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseListByServer.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/preview/2017-12-01-preview/examples/DatabaseListByServer.json @@ -14,8 +14,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } }, { @@ -23,8 +23,8 @@ "name": "db2", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } ] diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseCreate.json index 7f6218487a35..73848f69214f 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseCreate.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseCreate.json @@ -7,8 +7,8 @@ "subscriptionId": "ffffffff-ffff-ffff-ffff-ffffffffffff", "parameters": { "properties":{ - "charset":"UTF8", - "collation":"English_United States.1252" + "charset":"utf8", + "collation":"utf8_general_ci" } } }, @@ -19,8 +19,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, @@ -30,8 +30,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } }, diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseGet.json index 24bd2a0616fb..cc7a8b270676 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseGet.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseGet.json @@ -13,8 +13,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } } diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseListByServer.json index 2dee8ad55cd9..c5563821a18e 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseListByServer.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/examples/DatabaseListByServer.json @@ -14,8 +14,8 @@ "name": "db1", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } }, { @@ -23,8 +23,8 @@ "name": "db2", "type": "Microsoft.DBforMySQL/servers/databases", "properties": { - "charset": "UTF8", - "collation": "English_United States.1252" + "charset": "utf8", + "collation": "utf8_general_ci" } } ] From 8c2199dd0c441ae030bb709bdafdff79456215e8 Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Thu, 6 Dec 2018 00:45:50 -0800 Subject: [PATCH 341/464] ServiceBus: 2018-preview - added new API for NetworkRuleSet (#4626) * added new API for NetworkRuleSet * Java readme section update for resolving duplicate type [ServiceBus.PremiumMessagingRegions] --- .../SBVirtualNetworkRuleSetCreate.json | 103 ++++++ .../SBVirtualNetworkRuleSetGet.json | 56 ++++ .../examples/SBOperations_List.json | 301 ++++++++++++++++++ .../servicebus-preview.json | 262 ++++++++++++++- .../servicebus/resource-manager/readme.md | 5 + 5 files changed, 726 insertions(+), 1 deletion(-) create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json create mode 100644 specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/SBOperations_List.json diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json new file mode 100644 index 000000000000..8a55ca34ebe7 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json new file mode 100644 index 000000000000..d62458a0be9f --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/Default-ServiceBus-AustraliaEast/providers/Microsoft.ServiceBus/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.ServiceBus/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/alitest/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/SBOperations_List.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/SBOperations_List.json new file mode 100644 index 000000000000..88fcc9192f96 --- /dev/null +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/examples/SBOperations_List.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "api-version": "2016-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceBus/checkNameAvailability/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Non Resource Operation", + "operation": "Get namespace availability." + } + }, + { + "name": "Microsoft.ServiceBus/register/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "ServiceBus Resource Provider", + "operation": "Registers the ServiceBus Resource Provider" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Create Or Update Namespace " + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Get Namespace Resource" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace", + "operation": "Delete Namespace" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Create or Update Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Delete Namespace Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Get Namespace Listkeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Create or Update Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Get Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue", + "operation": "Delete Queue" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Create or Update Queue Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": " Get Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Delete Queue Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "List Queue keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/queues/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Queue AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Create or Update Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Get Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic", + "operation": "Delete Topic" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Create or Update Topic Authorization Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": " Get Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Delete Topic Authorization Rules" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/listkeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "List Topic keys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/authorizationRules/regenerateKeys/action", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Topic AuthorizationRules", + "operation": "Resource Regeneratekeys" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Create or Update TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Get TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "TopicSubscription", + "operation": "Delete TopicSubscription" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Create or Update Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Get Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/topics/subscriptions/rules/Delete", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Rule", + "operation": "Delete Rule" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace metrics", + "operation": "Get Namespace metrics" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Get Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/diagnosticSettings/write", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace diagnostic settings", + "operation": "Create or Update Namespace diagnostic settings" + } + }, + { + "name": "Microsoft.ServiceBus/namespaces/logDefinitions/read", + "display": { + "provider": "Microsoft Azure ServiceBus", + "resource": "Namespace logs", + "operation": "Get Namespace logs" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json index 7eddf06473b9..689deaaf6251 100644 --- a/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json +++ b/specification/servicebus/resource-manager/Microsoft.ServiceBus/preview/2018-01-01-preview/servicebus-preview.json @@ -34,6 +34,40 @@ } }, "paths": { + "/providers/Microsoft.ServiceBus/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { "$ref": "./examples/SBOperations_List.json" } + }, + "description": "Lists all of the available ServiceBus REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceBus/namespaces": { "get": { "tags": [ @@ -324,7 +358,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/ipfilterrules": { "get": { "tags": [ @@ -694,6 +728,97 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/networkruleset/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleSetget": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/SBVirtualNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/NamespaceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } } }, "definitions": { @@ -902,6 +1027,55 @@ ], "description": "SKU of the namespace." }, + "OperationListResult": { + "description": "Result of the request to list ServiceBus operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "List of ServiceBus operations supported by the Microsoft.ServiceBus resource provider.", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "A ServiceBus REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.ServiceBus" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + }, "ErrorResponse": { "description": "Error reponse indicates ServiceBus service is not able to process the incoming request. The reason is provided in the error message.", "type": "object", @@ -1003,6 +1177,92 @@ } }, "description": "The response from the List namespace operation." + }, + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + } + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of topic resource." } }, "parameters": { diff --git a/specification/servicebus/resource-manager/readme.md b/specification/servicebus/resource-manager/readme.md index 0f15a7226ca9..12890c9ccf01 100644 --- a/specification/servicebus/resource-manager/readme.md +++ b/specification/servicebus/resource-manager/readme.md @@ -142,6 +142,11 @@ namespace: com.microsoft.azure.management.servicebus license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-servicebus +directive: + rename-model: + from: PremiumMessagingRegions + to: PremiumMessagingRegion + ``` ### Java multi-api From 8e9ff040f926096656f0a9e7422600f3e2066cff Mon Sep 17 00:00:00 2001 From: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com> Date: Thu, 6 Dec 2018 16:47:06 +0800 Subject: [PATCH 342/464] Refactor delete activity payload (#4747) * Enable delete activity * Enable delete activity. * Update * Refactor delete activity content * Update --- .../2018-06-01/entityTypes/Pipeline.json | 35 ++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) 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 14d232b10bfb..8a44e1e8c452 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 @@ -1455,6 +1455,26 @@ "modelAsString": true } }, + "LogStorageSettings": { + "description": "Log storage settings.", + "type": "object", + "properties": { + "linkedServiceName": { + "description": "Log storage linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "path": { + "type": "object", + "description": "The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string)." + } + }, + "additionalProperties": { + "type": "object" + }, + "required": [ + "linkedServiceName" + ] + }, "StagingSettings": { "description": "Staging settings.", "type": "object", @@ -2348,7 +2368,20 @@ "properties": { "recursive": { "type": "object", - "description": "If true, files under the folder path will be deleted recursively. Default is true. Type: boolean (or Expression with resultType boolean)." + "description": "If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean)." + }, + "maxConcurrentConnections":{ + "type": "integer", + "minimum": 1, + "description": "The max concurrent connections to connect data source at the same time." + }, + "enableLogging":{ + "type":"object", + "description": "Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean)." + }, + "logStorageSettings":{ + "description": "Log storage settings customer need to provide when enableLogging is true.", + "$ref": "#/definitions/LogStorageSettings" }, "dataset": { "description": "Delete activity dataset reference.", From 017ce6b82e44e7c25381d39d90d7faa51fe835a2 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 6 Dec 2018 03:53:30 -0500 Subject: [PATCH 343/464] typo: timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights (#4810) - asynchroneous -> asynchronous - synchroneously -> synchronously - avaliable -> available - programatically -> programmatically - asynchroneously -> asynchronously - Trim trailing spaces --- .../timeseriesinsights.json | 12 ++++---- .../timeseriesinsights.json | 14 ++++----- .../stable/2017-11-15/timeseriesinsights.json | 30 +++++++++---------- 3 files changed, 28 insertions(+), 28 deletions(-) diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json index 36be21775197..deb20e0cfa77 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json @@ -111,7 +111,7 @@ } }, "201": { - "description": "The environment create request was accepted. Environment provisioning is an asynchroneous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "description": "The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -200,7 +200,7 @@ ], "responses": { "200": { - "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchroneously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchroneously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchronously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -1267,7 +1267,7 @@ "$ref": "#/definitions/TrackedResource" } ], - "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource." + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource." }, "EnvironmentCreationProperties": { "properties": { @@ -1649,7 +1649,7 @@ "type": "object", "properties": { "format": { - "description": "An enum that represents the format of the local timestamp property that needs to be set.", + "description": "An enum that represents the format of the local timestamp property that needs to be set.", "type": "string", "enum": [ "Embedded", @@ -1667,7 +1667,7 @@ "properties": { "propertyName": { "type": "string", - "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" + "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" } } } @@ -1941,7 +1941,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases." + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." }, "message": { "type": "string", diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json index 9e8f3dc6aeda..144e5b06a0e7 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json @@ -111,7 +111,7 @@ } }, "201": { - "description": "The environment create request was accepted. Environment provisioning is an asynchroneous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "description": "The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -203,7 +203,7 @@ ], "responses": { "200": { - "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchroneously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchroneously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchronous, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -1420,7 +1420,7 @@ "$ref": "#/definitions/TrackedResource" } ], - "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource." + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource." }, "StandardEnvironmentResource": { "x-ms-discriminator-value": "Standard", @@ -1438,7 +1438,7 @@ "$ref": "#/definitions/EnvironmentResource" } ], - "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource. Standard environments have data retention limits." + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Standard environments have data retention limits." }, "LongTermEnvironmentResource": { "x-ms-discriminator-value": "LongTerm", @@ -1456,7 +1456,7 @@ "$ref": "#/definitions/EnvironmentResource" } ], - "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource. LongTerm environments do not have set data retention limits." + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. LongTerm environments do not have set data retention limits." }, "StandardEnvironmentCreationProperties": { "properties": { @@ -1685,7 +1685,7 @@ "properties": { "code": { "type": "string", - "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programatically handle specific cases." + "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases." }, "message": { "type": "string", @@ -2313,7 +2313,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases." + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." }, "message": { "type": "string", diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json index 3171601e55a5..147d1e1d718d 100644 --- a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json @@ -111,7 +111,7 @@ } }, "201": { - "description": "The environment create request was accepted. Environment provisioning is an asynchroneous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "description": "The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -203,7 +203,7 @@ ], "responses": { "200": { - "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchroneously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchroneously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchronously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", "schema": { "$ref": "#/definitions/EnvironmentResource" } @@ -1293,7 +1293,7 @@ "$ref": "#/definitions/TrackedResource" } ], - "description": "An environment is a set of time-series data avaliable for query, and is the top level Azure Time Series Insights resource." + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource." }, "EnvironmentCreationProperties": { "properties": { @@ -1339,7 +1339,7 @@ }, "status": { "$ref": "#/definitions/EnvironmentStatus", - "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service." + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service." } }, "allOf": [ @@ -1421,12 +1421,12 @@ "state": { "type": "string", "description": "This string represents the state of ingress operations on an environment. It can be \"Disabled\", \"Ready\", \"Running\", \"Paused\" or \"Unknown\"", - "enum": [ - "Disabled", - "Ready", - "Running", - "Paused", - "Unknown" + "enum": [ + "Disabled", + "Ready", + "Running", + "Paused", + "Unknown" ], "x-ms-enum": { "name": "IngressState", @@ -1446,7 +1446,7 @@ "properties":{ "code": { "type": "string", - "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programatically handle specific cases." + "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases." }, "message": { "type": "string", @@ -1774,7 +1774,7 @@ "type": "object", "properties": { "format": { - "description": "An enum that represents the format of the local timestamp property that needs to be set.", + "description": "An enum that represents the format of the local timestamp property that needs to be set.", "type": "string", "enum": [ "Embedded", @@ -1792,7 +1792,7 @@ "properties": { "propertyName": { "type": "string", - "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" + "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" } } } @@ -1808,7 +1808,7 @@ }, "localTimestamp": { "$ref": "#/definitions/LocalTimestamp", - "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." } } }, @@ -2074,7 +2074,7 @@ "properties": { "code": { "type": "string", - "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programatically handle specific error cases." + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." }, "message": { "type": "string", From 663db620e3202116bfa581b5a62ca61a472ce5e9 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 6 Dec 2018 09:47:19 -0500 Subject: [PATCH 344/464] typo: web/resource-manager/Microsoft.CertificateRegistration (#4813) - certitificateorder -> certificate order --- .../stable/2015-08-01/AppServiceCertificateOrders.json | 2 +- .../stable/2018-02-01/AppServiceCertificateOrders.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json index 5aadb60b62bf..dcaf549a0fd3 100644 --- a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2015-08-01/AppServiceCertificateOrders.json @@ -867,7 +867,7 @@ } }, "AppServiceCertificateCollection": { - "description": "Collection of certitificateorder certificates.", + "description": "Collection of certificate order certificates.", "required": [ "value" ], diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json index 8952bfecc6d5..cfe50dee347c 100644 --- a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json +++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2018-02-01/AppServiceCertificateOrders.json @@ -939,7 +939,7 @@ } }, "AppServiceCertificateCollection": { - "description": "Collection of certitificateorder certificates.", + "description": "Collection of certificate order certificates.", "required": [ "value" ], From e068db7aace4d29ff30edc0078cef9e5186d66da Mon Sep 17 00:00:00 2001 From: ninishaha Date: Thu, 6 Dec 2018 22:48:50 +0800 Subject: [PATCH 345/464] Add support for HDIinsight cluster with Enterprise Serurity Package (#4780) --- .../stable/2018-06-01/entityTypes/LinkedService.json | 4 ++++ .../stable/2018-06-01/entityTypes/Pipeline.json | 12 ++++++++++++ 2 files changed, 16 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index d9995df91fee..70ec6c7fa6bd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -571,6 +571,10 @@ "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." + }, + "isEspEnabled": { + "type": "object", + "description": "Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean." } }, "required": [ 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 8a44e1e8c452..45224d1ec626 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 @@ -1739,6 +1739,18 @@ "type": "object", "description": "Type: string (or Expression with resultType string)." } + }, + "variables": { + "description": "User specified arguments under hivevar namespace.", + "type": "array", + "items": { + "type": "object", + "description": "Type: string (or Expression with resultType string)." + } + }, + "queryTimeout": { + "type": "integer", + "description": "Query timeout value (in minutes). Effective when the HDInsight culster is with ESP (Enterprise Security Package)" } } }, From c63ccbb73882bd1ad0d91ef576927e99a5956add Mon Sep 17 00:00:00 2001 From: SamhitaK6 <44000399+SamhitaK6@users.noreply.github.com> Date: Thu, 6 Dec 2018 09:16:27 -0800 Subject: [PATCH 346/464] Microsoft.Billing: Rolling back the incorrect version merged in master branch. (#4798) * Microsoft.Billing: Gtm ImportRequest swagger * Taking CR comments. * Taking CR comments. * [Microsoft.Billing]: Updating swagger with rename changes required. * Rolling back the incorrect version merged. --- .../preview/2018-08-01-preview/billing.json | 1381 ----------------- .../examples/AcceptTransfer.json | 55 - .../examples/BillingPeriodsGet.json | 24 - .../examples/BillingPeriodsList.json | 27 - .../examples/CancelTransfer.json | 29 - .../examples/DeclineTransfer.json | 29 - .../examples/EnrollmentAccountsGet.json | 18 - .../examples/EnrollmentAccountsList.json | 29 - .../examples/GetRecipientTransfer.json | 41 - .../examples/GetTransfer.json | 40 - .../examples/InitiateTransfer.json | 34 - .../examples/InvoicesExpand.json | 34 - .../examples/InvoicesGet.json | 28 - .../examples/InvoicesGetLatest.json | 27 - .../examples/InvoicesList.json | 27 - .../examples/ListRecipientTransfers.json | 44 - .../examples/ListTransfers.json | 43 - 17 files changed, 1910 deletions(-) delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json delete mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json deleted file mode 100644 index 494e02ab35e3..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/billing.json +++ /dev/null @@ -1,1381 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-08-01-preview", - "title": "BillingManagementClient", - "description": "Billing client provides access to billing resources for Azure subscriptions." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.Billing/enrollmentAccounts": { - "get": { - "tags": [ - "EnrollmentAccounts" - ], - "x-ms-examples": { - "EnrollmentAccountsList": { - "$ref": "./examples/EnrollmentAccountsList.json" - } - }, - "operationId": "EnrollmentAccounts_List", - "description": "Lists the enrollment accounts the caller has access to.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccountListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/enrollmentAccounts/{name}": { - "get": { - "tags": [ - "EnrollmentAccounts" - ], - "x-ms-examples": { - "EnrollmentAccountsGet": { - "$ref": "./examples/EnrollmentAccountsGet.json" - } - }, - "operationId": "EnrollmentAccounts_Get", - "description": "Gets a enrollment account by name.", - "parameters": [ - { - "name": "name", - "in": "path", - "description": "Enrollment Account name.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/EnrollmentAccount" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods": { - "get": { - "tags": [ - "BillingPeriods" - ], - "operationId": "BillingPeriods_List", - "description": "Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", - "externalDocs": { - "url": "https://go.microsoft.com/fwlink/?linkid=844490" - }, - "x-ms-examples": { - "BillingPeriodsList": { - "$ref": "./examples/BillingPeriodsList.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$filter", - "description": "May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$skiptoken", - "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N billing periods.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 100 - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BillingPeriodsListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}": { - "get": { - "tags": [ - "BillingPeriods" - ], - "operationId": "BillingPeriods_Get", - "description": "Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", - "x-ms-examples": { - "BillingPeriodsGet": { - "$ref": "./examples/BillingPeriodsGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "billingPeriodName", - "description": "The name of a BillingPeriod resource.", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/BillingPeriod" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices": { - "get": { - "tags": [ - "Invoices" - ], - "operationId": "Invoices_List", - "description": "Lists the available invoices for a subscription in reverse chronological order beginning with the most recent invoice. In preview, invoices are available via this API only for invoice periods which end December 1, 2016 or later. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", - "externalDocs": { - "url": "https://go.microsoft.com/fwlink/?linkid=842057" - }, - "x-ms-examples": { - "InvoicesList": { - "$ref": "./examples/InvoicesList.json" - }, - "InvoicesExpand": { - "$ref": "./examples/InvoicesExpand.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "$expand", - "description": "May be used to expand the downloadUrl property within a list of invoices. This enables download links to be generated for multiple invoices at once. By default, downloadURLs are not included when listing invoices.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$filter", - "description": "May be used to filter invoices by invoicePeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$skiptoken", - "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "string" - }, - { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N invoices.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 100 - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/InvoicesListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}": { - "get": { - "tags": [ - "Invoices" - ], - "operationId": "Invoices_Get", - "description": "Gets a named invoice resource. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", - "x-ms-examples": { - "InvoicesGet": { - "$ref": "./examples/InvoicesGet.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "invoiceName", - "description": "The name of an invoice resource.", - "in": "path", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Invoice" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/latest": { - "get": { - "tags": [ - "Invoices" - ], - "operationId": "Invoices_GetLatest", - "description": "Gets the most recent invoice. When getting a single invoice, the downloadUrl property is expanded automatically. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", - "x-ms-examples": { - "InvoicesGetLatest": { - "$ref": "./examples/InvoicesGetLatest.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/Invoice" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "description": "Lists all of the available billing REST API operations.", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/initiateTransfer": { - "post": { - "description": "Initiates the request to transfer the GTM or legacy subscriptions or RIs to GTM.", - "operationId": "Transfer_Initiate", - "x-ms-examples": { - "InitiateTransfer": { - "$ref": "./examples/InitiateTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BillingAccountIdParameter" - }, - { - "$ref": "#/parameters/InvoiceSectionIdParameter" - }, - { - "$ref": "#/parameters/InitiateTransferRequestParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Initiated transfer details.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers/{transferId}": { - "get": { - "description": "Gets the transfer details for given transfer Id.", - "operationId": "Transfer_Get", - "x-ms-examples": { - "TransferGet": { - "$ref": "./examples/GetTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BillingAccountIdParameter" - }, - { - "$ref": "#/parameters/InvoiceSectionIdParameter" - }, - { - "$ref": "#/parameters/TransferIdParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Details of transfer.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "description": "Cancels the transfer for given transfer Id.", - "operationId": "Transfer_Cancel", - "x-ms-examples": { - "TransferCancel": { - "$ref": "./examples/CancelTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BillingAccountIdParameter" - }, - { - "$ref": "#/parameters/InvoiceSectionIdParameter" - }, - { - "$ref": "#/parameters/TransferIdParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Details of canceled transfer.", - "schema": { - "$ref": "#/definitions/TransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}/transfers": { - "get": { - "description": "Lists all transfer's details initiated from given invoice section.", - "operationId": "Transfers_List", - "x-ms-examples": { - "TransfersList": { - "$ref": "./examples/ListTransfers.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/BillingAccountIdParameter" - }, - { - "$ref": "#/parameters/InvoiceSectionIdParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "List of transfers initiated from this invoice section.", - "schema": { - "$ref": "#/definitions/TransferDetailsListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferId}/acceptTransfer": { - "post": { - "summary": "Accepts the transfer with given transfer Id.", - "operationId": "Transfer_Accept", - "x-ms-examples": { - "AcceptTransfer": { - "$ref": "./examples/AcceptTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/TransferIdParameter" - }, - { - "$ref": "#/parameters/AcceptTransferRequestParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Details of the accepted transfer.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferId}/declineTransfer": { - "post": { - "summary": "Declines the transfer with given transfer Id.", - "operationId": "Transfer_Decline", - "x-ms-examples": { - "DeclineTransfer": { - "$ref": "./examples/DeclineTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/TransferIdParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Details of the declined transfer.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers/{transferId}/": { - "get": { - "summary": "Gets the transfer with given transfer Id.", - "operationId": "RecipientTransfer_Get", - "x-ms-examples": { - "RecipientTransferGet": { - "$ref": "./examples/GetRecipientTransfer.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/TransferIdParameter" - } - ], - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "Details of the transfers with given Id.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/providers/Microsoft.Billing/transfers": { - "get": { - "summary": "Lists the transfers received by caller.", - "operationId": "RecipientTransfer_List", - "x-ms-examples": { - "RecipientTransfersList": { - "$ref": "./examples/ListRecipientTransfers.json" - } - }, - "tags": [ - "AIPController" - ], - "responses": { - "200": { - "description": "List of transfers received by caller.", - "schema": { - "$ref": "#/definitions/RecipientTransferDetailsListResult" - } - }, - "default": { - "description": "Unexpected error.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - } - }, - "definitions": { - "EnrollmentAccount": { - "description": "An enrollment account resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "An enrollment account.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/EnrollmentAccountProperties" - } - } - }, - "EnrollmentAccountListResult": { - "description": "Result of listing enrollment accounts.", - "properties": { - "value": { - "description": "The list of enrollment accounts.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/EnrollmentAccount" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "EnrollmentAccountProperties": { - "description": "The properties of the enrollment account.", - "properties": { - "principalName": { - "description": "The account owner's principal name.", - "type": "string", - "readOnly": true - } - } - }, - "BillingPeriod": { - "description": "A billing period resource.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "A billing period.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/BillingPeriodProperties" - } - } - }, - "BillingPeriodsListResult": { - "description": "Result of listing billing periods. It contains a list of available billing periods in reverse chronological order.", - "properties": { - "value": { - "description": "The list of billing periods.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/BillingPeriod" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "BillingPeriodProperties": { - "description": "The properties of the billing period.", - "properties": { - "billingPeriodStartDate": { - "description": "The start of the date range covered by the billing period.", - "type": "string", - "format": "date", - "readOnly": true - }, - "billingPeriodEndDate": { - "description": "The end of the date range covered by the billing period.", - "type": "string", - "format": "date", - "readOnly": true - }, - "invoiceIds": { - "description": "Array of invoice ids that associated with.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - } - } - }, - "DownloadUrl": { - "description": "A secure URL that can be used to download a PDF invoice until the URL expires.", - "properties": { - "expiryTime": { - "description": "The time in UTC at which this download URL will expire.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "url": { - "description": "The URL to the PDF file.", - "type": "string", - "readOnly": true - } - } - }, - "ErrorDetails": { - "description": "The details of the error.", - "properties": { - "code": { - "description": "Error code.", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string", - "readOnly": true - }, - "target": { - "description": "The target of the particular error.", - "type": "string", - "readOnly": true - } - } - }, - "ErrorResponse": { - "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "error": { - "description": "The details of the error.", - "$ref": "#/definitions/ErrorDetails" - } - } - }, - "Invoice": { - "description": "An invoice resource can be used download a PDF version of an invoice.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "An invoice.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/InvoiceProperties" - } - } - }, - "InvoicesListResult": { - "description": "Result of listing invoices. It contains a list of available invoices in reverse chronological order.", - "properties": { - "value": { - "description": "The list of invoices.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Invoice" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "InvoiceProperties": { - "description": "The properties of the invoice.", - "properties": { - "downloadUrl": { - "description": "A secure link to download the PDF version of an invoice. The link will cease to work after its expiry time is reached.", - "$ref": "#/definitions/DownloadUrl" - }, - "invoicePeriodStartDate": { - "description": "The start of the date range covered by the invoice.", - "type": "string", - "format": "date", - "readOnly": true - }, - "invoicePeriodEndDate": { - "description": "The end of the date range covered by the invoice.", - "type": "string", - "format": "date", - "readOnly": true - }, - "billingPeriodIds": { - "description": "Array of billing period ids that the invoice is attributed to.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - } - } - }, - "Operation": { - "description": "A Billing REST API operation.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string", - "readOnly": true - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Billing.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource on which the operation is performed: Invoice, etc.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Operation type: Read, write, delete, etc.", - "type": "string", - "readOnly": true - } - } - } - } - }, - "OperationListResult": { - "description": "Result listing billing operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of billing operations supported by the Microsoft.Billing resource provider.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string", - "readOnly": true - } - } - }, - "Resource": { - "description": "The Resource model definition.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id." - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name." - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type." - } - }, - "x-ms-azure-resource": true - }, - "InitiateTransferRequest": { - "type": "object", - "description": "Request parameters to initiate transfer.", - "properties": { - "properties": { - "description": "Request parameters to initiate transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/InitiateTransferProperties" - } - } - }, - "InitiateTransferProperties": { - "type": "object", - "description": "Request parameters to initiate transfer.", - "properties": { - "billingProfileId": { - "type": "string", - "description": "Target Usage context for devTest subscriptions." - }, - "recipientEmailId": { - "type": "string", - "description": "Email Id of recipient for transfer." - } - } - }, - "AcceptTransferRequest": { - "type": "object", - "description": "Request parameters to accept transfer.", - "properties": { - "properties": { - "description": "Request parameters to accept transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/AcceptTransferProperties" - } - } - }, - "AcceptTransferProperties": { - "type": "object", - "description": "Request parameters to accept transfer.", - "properties": { - "productDetails": { - "description": "Request parameters to accept transfer.", - "type": "array", - "items": { - "$ref": "#/definitions/ProductDetails" - } - } - } - }, - "ProductDetails": { - "type": "object", - "description": "Details of the product to be transferred.", - "properties": { - "productType": { - "description": "Type of the product to be transferred.", - "$ref": "#/definitions/ProductType" - }, - "productId": { - "type": "string", - "description": "Id of product to be transferred." - } - } - }, - "ProductType": { - "type": "string", - "description": "Type of the product to be transferred.", - "enum": [ - "AzureSubscription", - "AzureReservation" - ], - "x-ms-enum": { - "name": "productType", - "modelAsString": true - } - }, - "TransferDetails": { - "type": "object", - "description": "Details of the transfer.", - "properties": { - "properties": { - "description": "Details of the transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/TransferProperties" - } - } - }, - "RecipientTransferDetails": { - "type": "object", - "description": "Details of the transfer.", - "properties": { - "properties": { - "description": "Details of the transfer.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/RecipientTransferProperties" - } - } - }, - "DetailedTransferStatus": { - "type": "object", - "description": "Detailed transfer status.", - "properties": { - "productType": { - "type": "string", - "$ref": "#/definitions/ProductType", - "readOnly": true, - "description": "Type of product being transferred." - }, - "productId": { - "type": "string", - "readOnly": true, - "description": "Id of product being transferred." - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/ProductTransferStatus", - "readOnly": true, - "description": "Transfer status." - }, - "errorDetails": { - "description": "Error details for transfer execution.", - "$ref": "#/definitions/Error" - } - } - }, - "Error": { - "description": "Error details for transfer execution.", - "properties": { - "errorCode": { - "type": "string", - "readOnly": true, - "description": "Error code." - }, - "errorMessage": { - "type": "string", - "readOnly": true, - "description": "Error message." - } - } - }, - "EligibleProductType": { - "type": "string", - "description": "Type of the products that can be transferred.", - "enum": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "x-ms-enum": { - "name": "eligibleProductType", - "modelAsString": true - } - }, - "TransferProperties": { - "description": "Transfer details", - "type": "object", - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Transfer creation time.", - "readOnly": true - }, - "expirationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Transfer expiration time." - }, - "invoiceSectionId": { - "type": "string", - "description": "Target invoice section Id.", - "readOnly": true - }, - "billingAccountId": { - "type": "string", - "description": "Target billing account Id.", - "readOnly": true - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/TransferStatus", - "description": "Overall transfer status.", - "readOnly": true - }, - "recipientEmailId": { - "type": "string", - "readOnly": true, - "description": "Email Id of recipient of transfer." - }, - "initiatorEmailId": { - "type": "string", - "readOnly": true, - "description": "Email Id of initiator of transfer." - }, - "canceledBy": { - "type": "string", - "readOnly": true, - "description": "Email Id who user canceled the transfer." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Transfer last modification time." - }, - "detailedTransferStatus": { - "type": "array", - "readOnly": true, - "description": "Detailed transfer status.", - "items": { - "$ref": "#/definitions/DetailedTransferStatus" - } - } - } - }, - "RecipientTransferProperties": { - "description": "Transfer Details.", - "type": "object", - "properties": { - "creationTime": { - "type": "string", - "format": "date-time", - "description": "Transfer creation time.", - "readOnly": true - }, - "expirationTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Transfer expiration time." - }, - "allowedProductType": { - "type": "array", - "readOnly": true, - "description": "Type of subscriptions that can be transferred.", - "items": { - "$ref": "#/definitions/EligibleProductType" - } - }, - "transferStatus": { - "type": "string", - "$ref": "#/definitions/TransferStatus", - "description": "Overall transfer status.", - "readOnly": true - }, - "recipientEmailId": { - "type": "string", - "readOnly": true, - "description": "Email Id of recipient of transfer." - }, - "initiatorEmailId": { - "type": "string", - "readOnly": true, - "description": "Email Id of initiator of transfer." - }, - "canceledBy": { - "type": "string", - "readOnly": true, - "description": "Email Id who user canceled the transfer." - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "readOnly": true, - "description": "Transfer last modification time." - }, - "detailedTransferStatus": { - "type": "array", - "readOnly": true, - "description": "Detailed transfer status.", - "items": { - "$ref": "#/definitions/DetailedTransferStatus" - } - } - } - }, - "TransferStatus": { - "type": "string", - "description": "Possible transfer status.", - "enum": [ - "Pending", - "InProgress", - "Completed", - "CompletedWithErrors", - "Failed", - "Canceled", - "Declined" - ], - "x-ms-enum": { - "name": "transferStatus", - "modelAsString": true - } - }, - "ProductTransferStatus": { - "type": "string", - "description": "Possible transfer status.", - "enum": [ - "NotStarted", - "InProgress", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "productTransferStatus", - "modelAsString": true - } - }, - "RecipientTransferDetailsListResult": { - "description": "Result of listing details of the transfer received by caller.", - "properties": { - "value": { - "description": "The list of transfers received by caller.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/RecipientTransferDetails" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "TransferDetailsListResult": { - "description": "Result of listing details of the transfer initiated by caller.", - "properties": { - "value": { - "description": "The list of transfers initiated by caller.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/TransferDetails" - } - }, - "nextLink": { - "description": "The link (url) to the next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." - }, - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Azure Subscription ID.", - "required": true, - "type": "string" - }, - "BillingAccountIdParameter": { - "name": "billingAccountId", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "Billing account Id." - }, - "InvoiceSectionIdParameter": { - "name": "invoiceSectionId", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "Invoice section Id." - }, - "TransferIdParameter": { - "name": "transferId", - "x-ms-parameter-location": "method", - "in": "path", - "required": true, - "type": "string", - "description": "Transfer Id." - }, - "InitiateTransferRequestParameter": { - "name": "body", - "x-ms-parameter-location": "method", - "in": "body", - "required": true, - "description": "Initiate transfer parameters.", - "schema": { - "$ref": "#/definitions/InitiateTransferRequest" - } - }, - "AcceptTransferRequestParameter": { - "name": "body", - "x-ms-parameter-location": "method", - "in": "body", - "required": true, - "description": "Accept transfer parameters.", - "schema": { - "$ref": "#/definitions/AcceptTransferRequest" - } - } - }, - "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" - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json deleted file mode 100644 index c7de2db09d4e..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/AcceptTransfer.json +++ /dev/null @@ -1,55 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "transferId": "transferId", - "body": { - "properties": { - "value": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId" - }, - { - "productType": "AzureReservation", - "productId": "reservedInstanceId" - } - ] - } - } - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "allowedSubscriptionType": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM", - "detailedTransferStatus": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId", - "transferStatus": "InProgress" - }, - { - "productType": "AzureReservation", - "productId": "reservedInstanceId", - "transferStatus": "InProgress" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json deleted file mode 100644 index 7bd4d0157469..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsGet.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid", - "billingPeriodName": "201702-1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "name": "201702-1", - "type": "Microsoft.Billing/billingPeriods", - "properties": { - "billingPeriodStartDate": "2017-01-01", - "billingPeriodEndDate": "2017-02-01", - "invoiceIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" - ] - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json deleted file mode 100644 index 1c79897ad719..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/BillingPeriodsList.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "name": "201702-1", - "type": "Microsoft.Billing/billingPeriods", - "properties": { - "billingPeriodStartDate": "2017-01-01", - "billingPeriodEndDate": "2017-02-01", - "invoiceIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-01-05-987654321" - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json deleted file mode 100644 index 35e4c74bc9d2..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/CancelTransfer.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "billingAccountId": "billingAccountId", - "invoiceSectionId": "invoiceSectionId", - "transferId": "transferId" - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "invoiceSectionId": "invoiceSectionId", - "billingAccountId": "billingAccountId", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "canceledBy": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM" - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json deleted file mode 100644 index 664f9e7aec38..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/DeclineTransfer.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "transferId": "transferId" - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "allowedSubscriptionType": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "transferStatus": "Declined", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM" - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json deleted file mode 100644 index 3d7117536c2d..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsGet.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556" - }, - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", - "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", - "type": "Microsoft.Billing/enrollmentAccounts", - "properties": { - "principalName": "kathy@contoso.com" - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json deleted file mode 100644 index 56cd2ddd35b9..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/EnrollmentAccountsList.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/providers/Microsoft.Billing/enrollmentAccounts/e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", - "name": "e1bf1c8c-5ac6-44a0-bdcd-aa7c1cf60556", - "type": "Microsoft.Billing/enrollmentAccounts", - "properties": { - "principalName": "kathy@contoso.com" - } - }, - { - "id": "/providers/Microsoft.Billing/enrollmentAccounts/edd24053-07cd-4ed4-aa5b-326160a6680d", - "name": "edd24053-07cd-4ed4-aa5b-326160a6680d", - "type": "Microsoft.Billing/enrollmentAccounts", - "properties": { - "principalName": "dan@contoso.com" - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json deleted file mode 100644 index 26c89a52c1e1..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetRecipientTransfer.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "transferId": "transferId" - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "allowedSubscriptionType": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM", - "detailedTransferStatus": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId", - "transferStatus": "InProgress" - }, - { - "productType": "AzureReservation", - "productId": "reservedInstanceId", - "transferStatus": "InProgress" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json deleted file mode 100644 index c31bc82a761a..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/GetTransfer.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "billingAccountId": "billingAccountId", - "invoiceSectionId": "invoiceSectionId", - "transferId": "transferId" - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "invoiceSectionId": "invoiceSectionId", - "billingAccountId": "billingAccountId", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM", - "detailedTransferStatus": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId", - "transferStatus": "InProgress" - }, - { - "productType": "AzureReservation", - "productId": "reservedInstanceId", - "transferStatus": "InProgress" - } - ] - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json deleted file mode 100644 index f8e0699f82d1..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InitiateTransfer.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "billingAccountId": "billingAccountId", - "invoiceSectionId": "invoiceSectionId", - "body": { - "properties": { - "billingProfileId": "billingProfileId", - "recipientEmailId": "user@contoso.com" - - } - } - }, - - "responses": { - "200": { - "body": { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "invoiceSectionId": "invoiceSectionId", - "billingAccountId": "billingAccountId", - "transferStatus": "Pending", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:40:01 PM" - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json deleted file mode 100644 index 03fdb36b8f91..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesExpand.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid", - "$top": 1, - "$filter": "invoicePeriodStartDate le 2017-02-01", - "$expand": "downloadUrl" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "name": "2017-02-05-123456789", - "type": "Microsoft.Billing/invoices", - "properties": { - "invoicePeriodStartDate": "2017-01-01", - "invoicePeriodEndDate": "2017-02-01", - "billingPeriodIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" - ], - "downloadUrl": { - "expiryTime": "2017-02-13T20:46:30Z", - "url": "https://microsoft.com" - } - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json deleted file mode 100644 index f8e64db95d4f..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGet.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid", - "invoiceName": "2017-02-05-123456789" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "name": "2017-02-05-123456789", - "type": "Microsoft.Billing/invoices", - "properties": { - "invoicePeriodStartDate": "2017-01-01", - "invoicePeriodEndDate": "2017-02-01", - "billingPeriodIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" - ], - "downloadUrl": { - "expiryTime": "2017-02-13T20:46:30Z", - "url": "https://microsoft.com" - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json deleted file mode 100644 index c6ab612cee50..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesGetLatest.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "name": "2017-02-05-123456789", - "type": "Microsoft.Billing/invoices", - "properties": { - "invoicePeriodStartDate": "2017-01-01", - "invoicePeriodEndDate": "2017-02-01", - "billingPeriodIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" - ], - "downloadUrl": { - "expiryTime": "2017-02-13T20:46:30Z", - "url": "https://microsoft.com" - } - } - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json deleted file mode 100644 index 0d02496eef91..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/InvoicesList.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/subid/providers/Microsoft.Billing/invoices/2017-02-05-123456789", - "name": "2017-02-05-123456789", - "type": "Microsoft.Billing/invoices", - "properties": { - "invoicePeriodStartDate": "2017-01-01", - "invoicePeriodEndDate": "2017-02-01", - "billingPeriodIds": [ - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", - "/subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201701-1" - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json deleted file mode 100644 index b0f3ab3baba4..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListRecipientTransfers.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview" - }, - - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/providers/Microsoft.Billing/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "allowedSubscriptionType": [ - "DevTestAzureSubscription", - "StandardAzureSubscription", - "AzureReservation" - ], - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM", - "detailedTransferStatus": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId", - "transferStatus": "InProgress" - }, - { - "productType": "ReservedInstance", - "productId": "reservedInstanceId", - "transferStatus": "InProgress" - } - ] - } - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json deleted file mode 100644 index 7fa4f88a1dc1..000000000000 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-08-01-preview/examples/ListTransfers.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2018-08-01-preview", - "billingAccountId": "billingAccountId", - "invoiceSectionId": "invoiceSectionId" - }, - - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/providers/Microsoft.Billing/billingAccounts/billingAccountId/invoiceSections/invoiceSectionId/transfers/transferId", - "type": "Microsoft.Billing/transfers", - "name": "transferId", - "properties": { - "creationTime": "10/10/2018 9:40:01 PM", - "expirationTime": "11/5/2018 4:47:08 AM", - "invoiceSectionId": "invoiceSectionId", - "billingAccountId": "billingAccountId", - "transferStatus": "InProgress", - "recipientEmailId": "user@contoso.com", - "initiatorEmailId": "user@contoso.com", - "lastModifiedTime": "10/10/2018 9:45:01 PM", - "detailedTransferStatus": [ - { - "productType": "AzureSubscription", - "productId": "subscriptionId", - "transferStatus": "InProgress" - }, - { - "productType": "AzureReservation", - "productId": "reservedInstanceId", - "transferStatus": "InProgress" - } - ] - } - } - ] - } - } - } -} \ No newline at end of file From 33c292cfb1f52eca4e11a98b1797f7af18545e7a Mon Sep 17 00:00:00 2001 From: Yadi Reyes <36422356+yareyes@users.noreply.github.com> Date: Thu, 6 Dec 2018 10:08:06 -0800 Subject: [PATCH 347/464] [Portal Generated] Review request for Microsoft.SqlVirtualMachine to add version 2017-03-01-preview (#4740) * Updating the swagger * Updating error message * Updating error messages * Adding the example that was missing * Moving property to the end of the object --- .../CreateOrUpdateSqlVirtualMachineMAX.json | 1 + .../preview/2017-03-01-preview/sqlvm.json | 40 +++++++++---------- 2 files changed, 20 insertions(+), 21 deletions(-) diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json index eb165d5d9f3b..488040166394 100644 --- a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/examples/CreateOrUpdateSqlVirtualMachineMAX.json @@ -18,6 +18,7 @@ }, "SQLStorageUpdateSettings": { "DiskCount": 1, + "StartingDeviceId": 2, "DiskConfigurationType": "NEW" }, "SQLWorkloadTypeUpdateSettings": { diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json index 48070b1972ca..5e5e51fc6068 100644 --- a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json @@ -56,7 +56,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." } }, "x-ms-examples": { @@ -113,7 +113,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." }, "201": { "description": "Successfully created the availability group listener.", @@ -165,7 +165,7 @@ "description": "Successfully deleted the availability group listener." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - Atleast one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 DifferentSubSqlVmList - All SQL virtual machines should be under same subscription.\n\n * 400 OnlyStandardPublicIp - Every virtual machine should have standard public IP.\n\n * 400 ListenerNameTooLong - Listener name should not exceed 15 characters.\n\n * 400 InvalidListenerName - Invalid listener name.\n\n * 400 InvalidLBResourceIdParameterValue - Load balancer resource id is invalid.\n\n * 400 InvalidPublicIpResourceIdParameterValue - Public IP resource id is invalid.\n\n * 400 InvalidSubnetIdParameterValue - Invalid resource id provided for subnet parameter.\n\n * 400 VmNicVnetMismatch - Virtual machine NIC VNet mismatch.\n\n * 400 InvalidPrivateIpParameterValue - Invalid address given for private IP address.\n\n * 400 NoAvailabilitySet - Vm is not associated with any availability set.\n\n * 400 AvailabilitySetMismatch - Availability set of virtual machines does not match.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 AgDoesNotExist - Availability group does not exist.\n\n * 400 AgListDoesNotMatch - SQL Availability group list does not match the list of virtual machines in SQL Virtual machine group.\n\n * 400 NoIpProvided - At least one IP needs to be provided.\n\n * 400 MoreIpProvided - Only one IP needs to be provided.\n\n * 400 SqlVmGroupDoesNotHaveAGListener - SQL virtual machine group does not have the AG listener.\n\n * 400 AgListenerUpdateNotAllowed - Only handful properties of availability group listener can be updated.\n\n * 400 SqlVmNotInGroup - SQL virtual machine is not part of the group.\n\n * 400 SqlVmListCannotBeEmpty - SQL virtual machines list cannot be empty.\n\n * 400 PublicIpNotIPv4 - Public IP must be IPv4 address.\n\n * 400 PublicIPDynamicAllocation - Public IP allocation mode must be static\n\n * 400 PublicLBInvalid - Load balancer specified is not public.\n\n * 400 SubnetMissingFromPrivateIP - Subnet must be provided with private IP.\n\n * 400 NoIpAvailable - No available IP.\n\n * 400 IPNotInSubnet - IP not part of subnet.\n\n * 400 MultipleListenerSameAG - Multiple availability group listeners for same availability group are not allowed.\n\n * 400 AgListenerNotEmpty - Availability group listener not empty.\n\n * 400 AgListenerVnetMismatch - Provided VNet for Availability group listener does not match Vnet of internal load balancer.\n\n * 400 InternalLBInvalid - Load balancer specified is not internal.\n\n * 400 InvalidSqlVmResourceIdParameterValue - SQL virtual machine resource id provided is invalid.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 SqlVmGroupIsBusy - SQL virtual machine group is busy." }, "202": { "description": "Deleting the availability group listener." @@ -294,7 +294,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." } }, "x-ms-examples": { @@ -344,7 +344,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." }, "201": { "description": "Successfully created the SQL virtual machine group.", @@ -389,7 +389,7 @@ "description": "Successfully deleted the SQL virtual machine group." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." }, "202": { "description": "Deleting the SQL virtual machine group." @@ -446,7 +446,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 SqlVmGroupUpdateFailVmAttached - SQL virtual machine group cannot be updated as it has attached a SQL virtual machine.\n\n * 400 InvalidSqlImageOffer - Provided SQL image offer is invalid.\n\n * 400 InvalidSqlSku - Provided SQL sku is invalid.\n\n * 400 OuPathAndDomainMismatch - OU path is not within the domain provided.\n\n * 400 InvalidAccountNameFormat - Account name format is invalid.\n\n * 400 CloudWitnessUnsupported - For Windows Server 2012R2 setup cloud witness is not allowed.\n\n * 400 FileShareWitnessDisAllowed - For Windows Server 2016 and beyond setup, file share witness is not allowed.\n\n * 400 InvalidStorageAccountUrl - Invalid storage account url.\n\n * 400 SqlVmGroupNameTooLong - SQL virtual machine group name cannot exceed 15 characters.\n\n * 400 InvalidSqlVmGroupName - Invalid SQL virtual machine group name.\n\n * 400 SqlVmGroupNotEmpty - SQL virtual machine group is not empty.\n\n * 400 SqlVmGroupUpdateNotAllowed - Update to SQL virtual machine group is not allowed.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." } }, "x-ms-long-running-operation": true, @@ -572,7 +572,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." } }, "x-ms-examples": { @@ -622,7 +622,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." }, "201": { "description": "Successfully created the SQL virtual machine.", @@ -673,7 +673,7 @@ "description": "Successfully deleted the SQL virtual machine." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." }, "202": { "description": "Deleting the SQL virtual machine." @@ -730,7 +730,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL kku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OSversion mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyvaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtnNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccured - Unexpected error occured.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." + "description": "*** Error Responses: ***\n\n * 400 InvalidVmResourceIdChange - Virtual machine resource id property cannot be updated.\n\n * 400 SqlVmAlreadyIncludedInGroup - SQL virtual machine cannot be moved from one group to another in same operation.\n\n * 400 SqlVmCannotRemoveFromGroup - SQL virtual machine cannot be removed from group.\n\n * 400 VmLocationMismatch - VM location does not match that of SQL virtual machine.\n\n * 400 SqlSkuMismatchWithGroup - SQL sku set on the SQL virtual machine group does not match that of the SQL virtual machine.\n\n * 400 VmLoadBalancerAssociated - LB already associated with the NIC.\n\n * 400 VmInsufficientPermission - Insufficient permission to Vm.\n\n * 400 VmPublisherNotSql - Publisher of VM image is not SQLServer.\n\n * 400 SingleNicOnVmAllowed - Only Single NIC virtual machines are allowed.\n\n * 400 InvalidSqlVmGroupResourceIdParameterValue - SQL virtual machine group resource id is not in correct format.\n\n * 400 MismatchVmGroupSubscription - Subscription id for SQL virtual machine and SQL virtual machine group are different.\n\n * 400 IncompleteDomainCredentialsProperty - Incomplete input provided for domain credentials property.\n\n * 400 InvalidVmResourceIdParameterValue - Provided virtual machine resource id is not valid.\n\n * 400 MismatchInSqlVmAndVmResourceIdSubscription - Mismatch in subscription id for SQL virtual machine and virtual machine resource id property.\n\n * 400 MismatchSqlVmAndVmName - SQL virtual machine name is not same as the virtual machine name provided on VirtualMachineResourceId property.\n\n * 400 MismatchSqlVmAndVmRgName - SQL virtual machine resource group name is not same as the virtual machine resource group name provided on VirtualMachineResourceId property.\n\n * 400 NotSupportedSqlVmOSVersion - Virtual machine OS type is not Windows. Only Windows OS versions are supported\n\n * 400 SqlVersionMismatchWithGroup - SQL version mismatch with SQL virtual machine group.\n\n * 400 VmOSVersionMismatchWithGroup - OS version mismatch with group.\n\n * 400 AutoBackupEncryptionPasswordNotSpecified - Password not provided when enabling encryption as auto backup setting.\n\n * 400 BackupScheduleTypeNotSet - Backup schedule type needs to be set.\n\n * 400 BackupStorageCredentialsNotSpecified - Backup storage credentials are not specified.\n\n * 400 KeyVaultCredentialsNotSpecified - Key vault credentials not specified.\n\n * 400 SqlCredentialsNotSpecified - SQL Server credentials are not specified.\n\n * 400 IncompleteAutoPatchingSettings - Incomplete auto patching settings specified.\n\n * 400 IncompleteAutoBackupSettings - Incomplete auto backup settings specified.\n\n * 400 IncompleteSqlStorageSettings - Incomplete SQL storage settings specified.\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 403 AccessDenied - Access denied.\n\n * 404 SubscriptionDoesNotHaveSqlVMGroupInResourceGroup - Subscription does not have SQL virtual machine group in resource group.\n\n * 404 SubscriptionDoesNotHaveSqlVMInResourceGroup - Subscription does not have SQL virtual machine Instance in resource group.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider." } }, "x-ms-long-running-operation": true, @@ -862,7 +862,7 @@ "type": "string" }, "loadBalancerResourceId": { - "description": "Subnet used to include private IP.", + "description": "Resource id of the load balancer.", "type": "string" }, "probePort": { @@ -1064,14 +1064,11 @@ "description": "SQL image sku.", "enum": [ "Developer", - "Express", - "Standard", - "Enterprise", - "Web" + "Enterprise" ], "type": "string", "x-ms-enum": { - "name": "SqlImageSku", + "name": "SqlVmGroupImageSku", "modelAsString": true }, "x-ms-mutability": [ @@ -1651,6 +1648,11 @@ "name": "DiskConfigurationType", "modelAsString": true } + }, + "startingDeviceId": { + "format": "int32", + "description": "Device id of the first disk to be updated.", + "type": "integer" } } }, @@ -1661,10 +1663,6 @@ "isRServicesEnabled": { "description": "Enable or disable R services (SQL 2016 onwards).", "type": "boolean" - }, - "backupPermissionsForAzureBackupSvc": { - "description": "Enable or disable Azure Backup service.", - "type": "boolean" } } }, From ddbabbfc41f9d0f29eb1823b5abc412d11becbde Mon Sep 17 00:00:00 2001 From: Ian Hays Date: Thu, 6 Dec 2018 10:29:23 -0800 Subject: [PATCH 348/464] [LabServices] Fix typo, remove required from optional param (#4797) --- .../Microsoft.LabServices/stable/2018-10-15/ML.json | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json index 22df8e02e8c8..1ad5db20bab3 100644 --- a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json +++ b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json @@ -152,11 +152,11 @@ "type": "string" }, { - "name": "personalPerferencesOperationsPayload", + "name": "personalPreferencesOperationsPayload", "in": "body", "description": "Represents payload for any Environment operations like get, start, stop, connect", "required": true, - "schema": { "$ref": "#/definitions/PersonalPerferencesOperationsPayload" } + "schema": { "$ref": "#/definitions/PersonalPreferencesOperationsPayload" } }, { "$ref": "#/parameters/api-version" } ], @@ -2505,7 +2505,6 @@ }, "Environment": { "description": "Represents an environment instance", - "required": [ "properties" ], "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { @@ -2677,7 +2676,6 @@ }, "EnvironmentSetting": { "description": "Represents settings of an environment, from which environment instances would be created", - "required": [ "properties" ], "type": "object", "allOf": [ { "$ref": "#/definitions/Resource" } ], "properties": { @@ -3615,7 +3613,7 @@ } } }, - "PersonalPerferencesOperationsPayload": { + "PersonalPreferencesOperationsPayload": { "description": "Represents payload for any Environment operations like get, start, stop, connect", "type": "object", "properties": { From 9d27274e4423776cdededd114380b7fd23e0e022 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Thu, 6 Dec 2018 14:10:42 -0800 Subject: [PATCH 349/464] Remove override-client-name from several cognitive service Node.js and TypeScript readme configurations (#4821) --- .../cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md | 1 - .../data-plane/AutoSuggest/readme.typescript.md | 1 - .../data-plane/CustomImageSearch/readme.nodejs.md | 1 - .../data-plane/CustomImageSearch/readme.typescript.md | 1 - .../data-plane/CustomWebSearch/readme.nodejs.md | 1 - .../data-plane/CustomWebSearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/EntitySearch/readme.nodejs.md | 1 - .../data-plane/EntitySearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/ImageSearch/readme.nodejs.md | 1 - .../data-plane/ImageSearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/NewsSearch/readme.nodejs.md | 1 - .../cognitiveservices/data-plane/NewsSearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/SpellCheck/readme.nodejs.md | 1 - .../cognitiveservices/data-plane/SpellCheck/readme.typescript.md | 1 - .../cognitiveservices/data-plane/VideoSearch/readme.nodejs.md | 1 - .../data-plane/VideoSearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/VisualSearch/readme.nodejs.md | 1 - .../data-plane/VisualSearch/readme.typescript.md | 1 - .../cognitiveservices/data-plane/WebSearch/readme.nodejs.md | 1 - .../cognitiveservices/data-plane/WebSearch/readme.typescript.md | 1 - 20 files changed, 20 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md b/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md index ff162926e95b..334a007c05a6 100644 --- a/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md +++ b/specification/cognitiveservices/data-plane/AutoSuggest/readme.nodejs.md @@ -7,7 +7,6 @@ Please also specify `--node-sdks-folder= Date: Thu, 6 Dec 2018 17:45:34 -0500 Subject: [PATCH 350/464] typo: subscription/resource-manager/Microsoft.Subscription (#4809) - defintion -> definition --- .../preview/2017-11-01-preview/subscriptionDefinitions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json index a0f6f342c90b..d6c9273d676e 100644 --- a/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json +++ b/specification/subscription/resource-manager/Microsoft.Subscription/preview/2017-11-01-preview/subscriptionDefinitions.json @@ -260,7 +260,7 @@ "readOnly": true }, "properties": { - "description": "the subscription definiton properties", + "description": "the subscription definition properties", "x-ms-client-flatten": true, "$ref": "#/definitions/SubscriptionDefinitionProperties" } From 6ff29f0aa976b9cd029a255e120e60ff26169615 Mon Sep 17 00:00:00 2001 From: jureid <44306969+jureid@users.noreply.github.com> Date: Thu, 6 Dec 2018 15:23:35 -0800 Subject: [PATCH 351/464] Change invoicePeriodStartDate to invoicePeriodEndDate for $filter (#4822) $filter may be used to filter invoices by invoicePeriodEndDate, not by invoicePeriodStartDate. A customer copied the InvoiceExpand sample request from this doc: https://docs.microsoft.com/en-us/rest/api/billing/invoices/list and got an error. --- .../preview/2018-03-01-preview/examples/InvoicesExpand.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/InvoicesExpand.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/InvoicesExpand.json index edc75d2c4c91..41ae9f6f541a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/InvoicesExpand.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/examples/InvoicesExpand.json @@ -3,7 +3,7 @@ "api-version": "2018-03-01-preview", "subscriptionId": "subid", "$top": 1, - "$filter": "invoicePeriodStartDate le 2017-02-01", + "$filter": "invoicePeriodEndDate le 2017-02-01", "$expand": "downloadUrl" }, "responses": { @@ -31,4 +31,4 @@ } } } -} \ No newline at end of file +} From b011d6c7727dfb9889c81490b9e0b27eb1d79f86 Mon Sep 17 00:00:00 2001 From: Sirajudeen Sahul Hameed Date: Fri, 7 Dec 2018 10:02:00 -0800 Subject: [PATCH 352/464] Adding provisionAfterExtensions property for extension sequencing (#4306) --- .../Microsoft.Compute/stable/2018-06-01/compute.json | 7 +++++++ .../Microsoft.Compute/stable/2018-10-01/compute.json | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index ed951d06a3cd..e43aead20e3a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -7139,6 +7139,13 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index f39b5734dff2..12aeabee2a5a 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -7154,6 +7154,13 @@ "readOnly": true, "type": "string", "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." } }, "description": "Describes the properties of a Virtual Machine Scale Set Extension." From eab63347477291d1cb2062ed88d0f88e99f3dcff Mon Sep 17 00:00:00 2001 From: refortie <37600290+refortie@users.noreply.github.com> Date: Fri, 7 Dec 2018 10:40:27 -0800 Subject: [PATCH 353/464] [LogicApp] Bugfix for swagger/sdk not matching the underlying service API (#4769) * Bugfix for swagger/sdk not matching the underlying service API * Add in approved override --- .../IntegrationAccountAgreements_List.json | 16 +++++----- .../preview/2018-07-01-preview/logic.json | 32 +++++++++---------- .../logic/resource-manager/readme.md | 32 ++++++++++++++----- 3 files changed, 48 insertions(+), 32 deletions(-) diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/IntegrationAccountAgreements_List.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/IntegrationAccountAgreements_List.json index 9cc013b65b7d..b846b64a0dcd 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/IntegrationAccountAgreements_List.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/examples/IntegrationAccountAgreements_List.json @@ -32,8 +32,8 @@ "interchangeControlNumberValidityDays": 30, "checkDuplicateGroupControlNumber": false, "checkDuplicateTransactionSetControlNumber": false, - "validateEdiTypes": true, - "validateXsdTypes": false, + "validateEDITypes": true, + "validateXSDTypes": false, "allowLeadingAndTrailingSpacesAndZeroes": false, "trimLeadingAndTrailingSpacesAndZeroes": false, "trailingSeparatorPolicy": "NotAllowed" @@ -117,8 +117,8 @@ "interchangeControlNumberValidityDays": 30, "checkDuplicateGroupControlNumber": false, "checkDuplicateTransactionSetControlNumber": false, - "validateEdiTypes": true, - "validateXsdTypes": false, + "validateEDITypes": true, + "validateXSDTypes": false, "allowLeadingAndTrailingSpacesAndZeroes": false, "trimLeadingAndTrailingSpacesAndZeroes": false, "trailingSeparatorPolicy": "NotAllowed" @@ -387,8 +387,8 @@ "interchangeControlNumberValidityDays": 30, "checkDuplicateGroupControlNumber": true, "checkDuplicateTransactionSetControlNumber": true, - "validateEdiTypes": true, - "validateXsdTypes": true, + "validateEDITypes": true, + "validateXSDTypes": true, "trimLeadingAndTrailingSpacesAndZeroes": true, "allowLeadingAndTrailingSpacesAndZeroes": true, "trailingSeparatorPolicy": "Optional" @@ -488,8 +488,8 @@ "interchangeControlNumberValidityDays": 30, "checkDuplicateGroupControlNumber": true, "checkDuplicateTransactionSetControlNumber": true, - "validateEdiTypes": true, - "validateXsdTypes": true, + "validateEDITypes": true, + "validateXSDTypes": true, "trimLeadingAndTrailingSpacesAndZeroes": true, "allowLeadingAndTrailingSpacesAndZeroes": true, "trailingSeparatorPolicy": "Optional" diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json index 81db69c569cb..bbd8edc6bc61 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2018-07-01-preview/logic.json @@ -7481,8 +7481,8 @@ "interchangeControlNumberValidityDays", "checkDuplicateGroupControlNumber", "checkDuplicateTransactionSetControlNumber", - "validateEdiTypes", - "validateXsdTypes", + "validateEDITypes", + "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trimLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy" @@ -7509,11 +7509,11 @@ "type": "boolean", "description": "The value indicating whether to check for duplicate transaction set control number." }, - "validateEdiTypes": { + "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate EDI types." }, - "validateXsdTypes": { + "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate XSD types." }, @@ -7930,8 +7930,8 @@ "type": "object", "required": [ "messageId", - "validateEdiTypes", - "validateXsdTypes", + "validateEDITypes", + "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "validateCharacterSet", "trimLeadingAndTrailingSpacesAndZeroes", @@ -7942,11 +7942,11 @@ "type": "string", "description": "The message id on which the validation settings has to be applied." }, - "validateEdiTypes": { + "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to validate EDI types." }, - "validateXsdTypes": { + "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to validate XSD types." }, @@ -8324,8 +8324,8 @@ "interchangeControlNumberValidityDays", "checkDuplicateGroupControlNumber", "checkDuplicateTransactionSetControlNumber", - "validateEdiTypes", - "validateXsdTypes", + "validateEDITypes", + "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trimLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy" @@ -8352,11 +8352,11 @@ "type": "boolean", "description": "The value indicating whether to check for duplicate transaction set control number." }, - "validateEdiTypes": { + "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate EDI types." }, - "validateXsdTypes": { + "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to Whether to validate XSD types." }, @@ -8867,8 +8867,8 @@ "required": [ "messageId", "enforceCharacterSet", - "validateEdiTypes", - "validateXsdTypes", + "validateEDITypes", + "validateXSDTypes", "allowLeadingAndTrailingSpacesAndZeroes", "trailingSeparatorPolicy", "trimLeadingAndTrailingSpacesAndZeroes" @@ -8882,11 +8882,11 @@ "type": "boolean", "description": "The value indicating whether to validate character Set." }, - "validateEdiTypes": { + "validateEDITypes": { "type": "boolean", "description": "The value indicating whether to validate EDI types." }, - "validateXsdTypes": { + "validateXSDTypes": { "type": "boolean", "description": "The value indicating whether to validate XSD types." }, diff --git a/specification/logic/resource-manager/readme.md b/specification/logic/resource-manager/readme.md index 996d46b4c37d..a054d77930f1 100644 --- a/specification/logic/resource-manager/readme.md +++ b/specification/logic/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Logic. - - --- + ## Getting Started + To build the SDK for Logic, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -19,9 +19,8 @@ To see additional help and options, run: ## Configuration - - ### Basic Information + These are the global settings for the Logic API. ``` yaml @@ -40,7 +39,6 @@ directive: ``` - ### Tag: package-2018-07-preview These settings apply only when `--package-2018-07-preview` is specified on the command line. @@ -50,6 +48,24 @@ input-file: - Microsoft.Logic/preview/2018-07-01-preview/logic.json ``` +## Suppression + +``` yaml +directive: + - suppress: R3016 + reason: Existing properties, can't be changed without breaking API. + #where: + # - $.definitions.EdifactValidationSettings.properties.validateEDITypes + # - $.definitions.EdifactValidationSettings.properties.validateXSDTypes + # - $.definitions.EdifactValidationOverride.properties.validateEDITypes + # - $.definitions.EdifactValidationOverride.properties.validateXSDTypes + # - $.definitions.X12ValidationSettings.properties.validateEDITypes + # - $.definitions.X12ValidationSettings.properties.validateXSDTypes + # - $.definitions.X12ValidationOverride.properties.validateEDITypes + # - $.definitions.X12ValidationOverride.properties.validateXSDTypes + +``` + ### Tag: package-2016-06 These settings apply only when `--tag=package-2016-06` is specified on the command line. @@ -77,10 +93,9 @@ input-file: - Microsoft.Logic/preview/2015-02-01-preview/logic.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -99,7 +114,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_logic'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -130,11 +144,13 @@ python: package-name: azure-mgmt-logic clear-output-folder: true ``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/azure-mgmt-logic/azure/mgmt/logic ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true From 9af8596acc0615c2bb3e9c4fdae68d65fe4fd893 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 7 Dec 2018 17:47:24 -0500 Subject: [PATCH 354/464] typo: workloadmonitor/resource-manager/Microsoft.WorkloadMonitor (#4816) - updation -> updating - Treshold -> Threshold - theshold -> threshold --- .../2018-08-31-preview/Microsoft.WorkloadMonitor.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json index e664776c4327..9e5ea17e4b56 100644 --- a/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json +++ b/specification/workloadmonitor/resource-manager/Microsoft.WorkloadMonitor/preview/2018-08-31-preview/Microsoft.WorkloadMonitor.json @@ -1074,7 +1074,7 @@ } }, "criteria": { - "description": "Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updation.", + "description": "Collection of MonitorCriteria. For PATCH calls, instead of partial list, complete list of expected criteria should be passed for proper updating.", "type": "array", "items": { "$ref": "#/definitions/MonitorCriteria" @@ -1145,12 +1145,12 @@ }, "threshold": { "format": "double", - "description": "Treshold value for this criteria", + "description": "Threshold value for this criteria", "type": "number", "readOnly": true }, "comparisonOperator": { - "description": "Comparison enum on theshold of this criteria", + "description": "Comparison enum on threshold of this criteria", "enum": [ "Equals", "GreaterThan", From 8cf66308c2444b759dc933277058fa937bcfbf91 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 7 Dec 2018 17:48:34 -0500 Subject: [PATCH 355/464] typo: storsimple8000series/resource-manager/Microsoft.StorSimple (#4807) - StorSimple capitalization - failoversets -> failover sets - atleast -> at least - schdule -> schedule - datacontainers -> data containers --- .../stable/2017-06-01/storsimple.json | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/storsimple.json b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/storsimple.json index 8475dac3c2f8..ecbb6d852729 100644 --- a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/storsimple.json +++ b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/storsimple.json @@ -20,7 +20,7 @@ "tags": [ "Operations" ], - "description": "Lists all of the available REST API operations of the Microsoft.Storsimple provider", + "description": "Lists all of the available REST API operations of the Microsoft.StorSimple provider", "operationId": "Operations_List", "consumes": [ "application/json" @@ -2476,7 +2476,7 @@ ], "responses": { "200": { - "description": "Returns the list of failoversets on the given device.", + "description": "Returns the list of failover sets on the given device.", "schema": { "$ref": "#/definitions/FailoverSetsList" } @@ -4995,7 +4995,7 @@ }, "occurences": { "format": "int32", - "description": "The number of occurences", + "description": "The number of occurrences", "type": "integer" } } @@ -5544,7 +5544,7 @@ "readOnly": true }, "scheduledBackupStatus": { - "description": "Indicates whether atleast one of the schedules in the backup policy is active or not.", + "description": "Indicates whether at least one of the schedules in the backup policy is active or not.", "enum": [ "Disabled", "Enabled" @@ -5763,7 +5763,7 @@ "properties": { "start": { "$ref": "#/definitions/Time", - "description": "The start time of the schdule." + "description": "The start time of the schedule." }, "stop": { "$ref": "#/definitions/Time", @@ -6765,7 +6765,7 @@ }, "dataContainersCount": { "format": "int32", - "description": "The count of datacontainers on the device.", + "description": "The count of data containers on the device.", "type": "integer" }, "volumesCount": { @@ -7321,7 +7321,7 @@ } }, "ManagerIntrinsicSettings": { - "description": "Intrinsic settings which refers to the type of the Storsimple Manager.", + "description": "Intrinsic settings which refers to the type of the StorSimple Manager.", "required": [ "type" ], @@ -7349,7 +7349,7 @@ "type": "object", "properties": { "value": { - "description": "The list of storsimple managers.", + "description": "The list of StorSimple managers.", "type": "array", "items": { "$ref": "#/definitions/Manager" From 68b2a8eccaec8ec1c5be720aede5d234f79bba2d Mon Sep 17 00:00:00 2001 From: Filiz Topatan Date: Fri, 7 Dec 2018 14:49:52 -0800 Subject: [PATCH 356/464] Fix typo (#4792) --- .../preview/2017-11-11-preview/blueprintDefinition.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json index cc7b0701efd8..44030843ec48 100644 --- a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2017-11-11-preview/blueprintDefinition.json @@ -147,7 +147,7 @@ "Blueprint" ], "operationId": "Blueprints_List", - "description": "Create or update blueprint definition.", + "description": "List Blueprint definitions within a Management Group.", "x-ms-examples": { "Blueprint": { "$ref": "./examples/Blueprint_List.json" From 26dcfaab8910c1fc9f9d8eaa6a8eb1d7f7b57e96 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 7 Dec 2018 17:50:48 -0500 Subject: [PATCH 357/464] typo: storage/resource-manager/Microsoft.Storage (#4786) - availabity -> availability --- .../stable/2015-06-15/storage.json | 2 +- .../2018-07-01/examples/BlobServicesPut.json | 186 +++++++++--------- 2 files changed, 93 insertions(+), 95 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json index 382109caa9af..632499206027 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json @@ -422,7 +422,7 @@ "required": [ "name" ], - "description": "The parameters used to check the availabity of the storage account name." + "description": "The parameters used to check the availability of the storage account name." }, "CheckNameAvailabilityResult": { "properties": { diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json index cc0c86e362ab..326e4bd06a8e 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/examples/BlobServicesPut.json @@ -9,65 +9,64 @@ "parameters": { "properties": { "cors": { - "corsRules": [ - { - "allowedOrigins": [ - "http://www.contoso.com", - "http://www.fabrikam.com" - ], - "allowedMethods": [ - "GET", - "HEAD", - "POST", - "OPTIONS", - "MERGE", - "PUT" - ], - "maxAgeInSeconds": 100, - "exposedHeaders": [ - "x-ms-meta-*" - ], - "allowedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x-ms-meta-target*" - ] - }, - { - "allowedOrigins": [ - "*" - ], - "allowedMethods": [ - "GET" - ], - "maxAgeInSeconds": 2, - "exposedHeaders": [ - "*" - ], - "allowedHeaders": [ - "*" - ] - }, - { - "allowedOrigins": [ - "http://www.abc23.com", - "https://www.fabrikam.com/*" - ], - "allowedMethods": [ - "GET", - "PUT" - ], - "maxAgeInSeconds": 2000, - "exposedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x -ms-meta-target*" - ], - "allowedHeaders": [ - "x-ms-meta-12345675754564*" - ] - } - ] + "corsRules": [{ + "allowedOrigins": [ + "http://www.contoso.com", + "http://www.fabrikam.com" + ], + "allowedMethods": [ + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" + ], + "maxAgeInSeconds": 100, + "exposedHeaders": [ + "x-ms-meta-*" + ], + "allowedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] + }, + { + "allowedOrigins": [ + "*" + ], + "allowedMethods": [ + "GET" + ], + "maxAgeInSeconds": 2, + "exposedHeaders": [ + "*" + ], + "allowedHeaders": [ + "*" + ] + }, + { + "allowedOrigins": [ + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], + "allowedMethods": [ + "GET", + "PUT" + ], + "maxAgeInSeconds": 2000, + "exposedHeaders": [ + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], + "allowedHeaders": [ + "x-ms-meta-12345675754564*" + ] + } + ] }, "defaultServiceVersion": "2017-07-29", "deleteRetentionPolicy": { @@ -85,63 +84,62 @@ "type": "Microsoft.Storage/storageAccounts/blobServices", "properties": { "cors": { - "corsRules": [ - { + "corsRules": [{ "allowedOrigins": [ - "http://www.contoso.com", - "http://www.fabrikam.com" - ], + "http://www.contoso.com", + "http://www.fabrikam.com" + ], "allowedMethods": [ - "GET", - "HEAD", - "POST", - "OPTIONS", - "MERGE", - "PUT" + "GET", + "HEAD", + "POST", + "OPTIONS", + "MERGE", + "PUT" ], "maxAgeInSeconds": 100, "exposedHeaders": [ - "x-ms-meta-*" - ], + "x-ms-meta-*" + ], "allowedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x-ms-meta-target*" - ] + "x-ms-meta-abc", + "x-ms-meta-data*", + "x-ms-meta-target*" + ] }, { "allowedOrigins": [ - "*" - ], + "*" + ], "allowedMethods": [ - "GET" + "GET" ], "maxAgeInSeconds": 2, "exposedHeaders": [ - "*" - ], + "*" + ], "allowedHeaders": [ - "*" - ] + "*" + ] }, { "allowedOrigins": [ - "http://www.abc23.com", - "https://www.fabrikam.com/*" - ], + "http://www.abc23.com", + "https://www.fabrikam.com/*" + ], "allowedMethods": [ - "GET", - "PUT" + "GET", + "PUT" ], "maxAgeInSeconds": 2000, "exposedHeaders": [ - "x-ms-meta-abc", - "x-ms-meta-data*", - "x -ms-meta-target*" - ], + "x-ms-meta-abc", + "x-ms-meta-data*", + "x -ms-meta-target*" + ], "allowedHeaders": [ - "x-ms-meta-12345675754564*" - ] + "x-ms-meta-12345675754564*" + ] } ] }, From 647e70d5209fff803ac2400df0922726e02c89fd Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 7 Dec 2018 17:58:11 -0500 Subject: [PATCH 358/464] typo: machinelearning/resource-manager/Microsoft.MachineLearning (#4705) - capabilites -> capabilities - Definiton -> Definition - asets -> assets - Delere -> Delete - paramater -> parameter --- .../2016-05-01-preview/commitmentPlans.json | 2 +- .../preview/2016-05-01-preview/webservices.json | 16 ++++++++-------- .../stable/2016-04-01/workspaces.json | 4 ++-- .../stable/2017-01-01/webservices.json | 16 ++++++++-------- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json index ec77974e4a35..0ee4e7187d89 100644 --- a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json +++ b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/commitmentPlans.json @@ -548,7 +548,7 @@ }, "SkuCapability": { "type": "object", - "description": "Describes The SKU capabilites object.", + "description": "Describes The SKU capabilities object.", "properties": { "name": { "type": "string", diff --git a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json index 563903d16da3..a9c65d0acf1f 100644 --- a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json +++ b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/preview/2016-05-01-preview/webservices.json @@ -40,7 +40,7 @@ "schema": { "$ref": "#/definitions/WebService" } - }, + }, { "$ref": "#/parameters/APIVersionParameter" }, @@ -69,7 +69,7 @@ "WebServices" ], "operationId": "WebServices_Get", - "description": "Gets the Web Service Definiton as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys.", + "description": "Gets the Web Service Definition as specified by a subscription, resource group, and name. Note that the storage credentials and web service keys are not returned by this call. To get the web service access keys, call List Keys.", "parameters": [ { "$ref": "#/parameters/ResourceGroupNameParameter" @@ -79,7 +79,7 @@ }, { "$ref": "#/parameters/APIVersionParameter" - }, + }, { "$ref": "#/parameters/SubscriptionIdParameter" } @@ -147,7 +147,7 @@ }, { "$ref": "#/parameters/APIVersionParameter" - }, + }, { "$ref": "#/parameters/SubscriptionIdParameter" } @@ -266,7 +266,7 @@ } } } - } + } }, "parameters": { "SubscriptionIdParameter": { @@ -463,7 +463,7 @@ "description": "Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.", "enum": [ "Graph" - ] + ] } } }, @@ -589,7 +589,7 @@ } }, "required": [ - "id" + "id" ] }, "ServiceInputOutputSpecification": { @@ -815,7 +815,7 @@ "properties": { "uri": { "type": "string", - "description": "The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user asets", + "description": "The URI where the asset is accessible from, (e.g. aml://abc for system assets or https://xyz for user assets", "format": "url" }, "credentials": { diff --git a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json index 7e5aa1ff2f35..d6b488c17ac1 100644 --- a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json +++ b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2016-04-01/workspaces.json @@ -176,7 +176,7 @@ } ], "x-ms-examples": { - "WorkspaceDelere": { + "WorkspaceDelete": { "$ref": "./examples/DeleteWorkspace.json" } }, @@ -244,7 +244,7 @@ } } } - }, + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearning/workspaces/{workspaceName}/resyncStorageKeys": { "post": { "tags": [ diff --git a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json index 3ba010f766a7..2c4df49dcdfd 100644 --- a/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json +++ b/specification/machinelearning/resource-manager/Microsoft.MachineLearning/stable/2017-01-01/webservices.json @@ -63,7 +63,7 @@ "schema": { "$ref": "#/definitions/WebService" } - }, + }, { "$ref": "#/parameters/APIVersionParameter" }, @@ -111,7 +111,7 @@ "type": "string", "description": "The region for which encrypted credential parameters are valid.", "required": false - }, + }, { "$ref": "#/parameters/APIVersionParameter" }, @@ -192,7 +192,7 @@ }, { "$ref": "#/parameters/APIVersionParameter" - }, + }, { "$ref": "#/parameters/SubscriptionIdParameter" } @@ -233,7 +233,7 @@ "type": "string", "description": "The region for which encrypted credential parameters are created.", "required": true - }, + }, { "$ref": "#/parameters/APIVersionParameter" }, @@ -373,7 +373,7 @@ } } } - } + } }, "parameters": { "SubscriptionIdParameter": { @@ -572,7 +572,7 @@ "description": "Specifies the package type. Valid values are Graph (Specifies a web service published through the Machine Learning Studio) and Code (Specifies a web service published using code such as Python). Note: Code is not supported at this time.", "enum": [ "Graph" - ] + ] }, "payloadsInBlobStorage": { "type": "boolean", @@ -580,7 +580,7 @@ }, "payloadsLocation": { "$ref": "#/definitions/BlobLocation", - "description": "The URI of the payload blob. This paramater contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null." + "description": "The URI of the payload blob. This parameter contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null." } } }, @@ -706,7 +706,7 @@ } }, "required": [ - "id" + "id" ] }, "ServiceInputOutputSpecification": { From 78e8a4782397b62033139381169eb45bd87e1743 Mon Sep 17 00:00:00 2001 From: Jeffrey Robinson Date: Fri, 7 Dec 2018 14:59:30 -0800 Subject: [PATCH 359/464] [Azure Stack] Removed Operations endpoint (#4628) * Removed Operations endpoint * Removed Operations example --- .../preview/2015-11-01/Subscriptions.json | 88 +------------------ .../examples/Subscriptions/Operations.json | 13 --- .../user-subscriptions/readme.md | 11 ++- 3 files changed, 10 insertions(+), 102 deletions(-) delete mode 100644 specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json index c8e9139bf124..63860ec10b28 100644 --- a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json +++ b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/Subscriptions.json @@ -137,7 +137,7 @@ }, "204": { "description": "No Content" - } + } }, "produces": [ "application/json" @@ -146,33 +146,6 @@ "application/json" ] } - }, - "/providers/Microsoft.Subscriptions/operations": { - "get": { - "x-ms-examples": { - "Get the list of Operations.": { - "$ref": "./examples/Subscriptions/Operations.json" - } - }, - "description": "Get the list of Operations.", - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationList" - } - } - } - } } }, "definitions": { @@ -271,62 +244,7 @@ "name": "SubscriptionState", "modelAsString": true } - }, - "Operation": { - "description": "Supported REST operation.", - "type": "object", - "properties": { - "display": { - "description": "Display information for the operation.", - "type": "object", - "properties": { - "description": { - "description": "Description for the operation.", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Display name of the operation.", - "type": "string", - "readOnly": true - }, - "provider": { - "description": "Resource provider display name.", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Resource type display name related to the operation.", - "type": "string", - "readOnly": true - } - } - }, - "name": { - "description": "Name of the operation being performed on an object.", - "type": "string", - "readOnly": true - }, - "origin": { - "description": "Origin for the operation.", - "type": "string", - "readOnly": true - } - } - }, - "OperationList": { - "description": "List of supported operations.", - "type": "object", - "properties": { - "value": { - "description": "List of supported operations.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - } - } - } - } + } }, "parameters": { "ApiVersionParameter": { @@ -344,7 +262,7 @@ "type": "string", "description": "Id of the subscription.", "x-ms-parameter-location": "method" - }, + }, "NewSubscriptionParameter": { "description": "Subscription parameter.", "name": "newSubscription", diff --git a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json b/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json deleted file mode 100644 index 53f2ca37206c..000000000000 --- a/specification/azsadmin/resource-manager/user-subscriptions/Microsoft.Subscriptions/preview/2015-11-01/examples/Subscriptions/Operations.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", - "location": "local", - "api-version": "2015-11-01" - }, - "responses": { - "200": { - "body": { - } - } - } -} \ No newline at end of file diff --git a/specification/azsadmin/resource-manager/user-subscriptions/readme.md b/specification/azsadmin/resource-manager/user-subscriptions/readme.md index 24dd9dfdc541..864cf4abba65 100644 --- a/specification/azsadmin/resource-manager/user-subscriptions/readme.md +++ b/specification/azsadmin/resource-manager/user-subscriptions/readme.md @@ -1,11 +1,11 @@ # Subscriptions Admin - + > see https://aka.ms/autorest This is the AutoRest configuration file for Subscriptions Admin. --- -## Getting Started +## Getting Started To build the SDK for Subscriptions Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -17,7 +17,7 @@ To see additional help and options, run: ## Configuration -### Basic Information +### Basic Information These are the global settings for the Subscriptions API. ``` yaml @@ -35,6 +35,9 @@ directive: where: - $.paths["/subscriptions/{subscriptionId}"].put + - suppress: R3023 + reason: No operations endpoint as not ARM resource provider. + - suppress: SubscriptionIdParameterInOperations reason: Subscription is the main resource in the API spec and it should not be masked in global parameters. where: @@ -67,7 +70,7 @@ input-file: --- # Code Generation -## C# +## C# ``` yaml $(csharp) csharp: From 1d18cfd80b020c1dd9f26f65a8fec591ccf2532e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Fri, 7 Dec 2018 22:40:14 -0500 Subject: [PATCH 360/464] fix: Trailing comma causing JSON_PARSING_ERROR (#4815) --- .../stable/2018-11-19/examples/amlComputeListNodes.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json index 8d3f4773138c..83082c26ba6e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/amlComputeListNodes.json @@ -22,7 +22,7 @@ "port": 50001 } ], - "nextLink": "nextLink", + "nextLink": "nextLink" } } } From bff1f6c451ed7751154672e92f9c67218235a723 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sat, 8 Dec 2018 03:50:51 -0500 Subject: [PATCH 361/464] typo: cognitiveservices/data-plane/Face (#4828) - persisited -> persisted --- .../cognitiveservices/data-plane/Face/stable/v1.0/Face.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index 47b3ed9f0245..f90629180b8b 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -150,7 +150,7 @@ } }, "x-ms-examples": { - "Identiy example": { + "Identify example": { "$ref": "./examples/Identify.json" } } @@ -924,7 +924,7 @@ }, "/facelists/{faceListId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete an existing face from a face list (given by a persisitedFaceId and a faceListId). Persisted image related to the face will also be deleted.", + "description": "Delete an existing face from a face list (given by a persistedFaceId and a faceListId). Persisted image related to the face will also be deleted.", "operationId": "FaceList_DeleteFace", "parameters": [ { @@ -1934,7 +1934,7 @@ }, "/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}": { "delete": { - "description": "Delete an existing face from a large face list (given by a persisitedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.", + "description": "Delete an existing face from a large face list (given by a persistedFaceId and a largeFaceListId). Persisted image related to the face will also be deleted.", "operationId": "LargeFaceList_DeleteFace", "parameters": [ { From 38d3165ded5041b49a5b7be20c2e32b5178ed999 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sun, 9 Dec 2018 23:11:08 -0500 Subject: [PATCH 362/464] typo: batch/data-plane/Microsoft.Batch (#4835) - upto -> up to - pre-empted -> preempted - visibile -> visible - comptue -> compute --- .../stable/2017-01-01.4.0/BatchService.json | 2 +- .../stable/2017-05-01.5.0/BatchService.json | 2 +- .../stable/2017-06-01.5.1/BatchService.json | 4 ++-- .../stable/2017-09-01.6.0/BatchService.json | 10 +++++----- .../stable/2018-03-01.6.1/BatchService.json | 10 +++++----- .../stable/2018-08-01.7.0/BatchService.json | 10 +++++----- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json index e22497216879..af327c849ccd 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/BatchService.json @@ -12340,7 +12340,7 @@ "type": "string" }, "title": "The collection of Virtual Hard Disk (VHD) URIs.", - "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve upto 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." + "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve up to 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." }, "caching": { "type": "string", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json index a7d0272f4233..9afeb9d464e9 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/BatchService.json @@ -12401,7 +12401,7 @@ "type": "string" }, "title": "The collection of Virtual Hard Disk (VHD) URIs.", - "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve upto 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." + "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve up to 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." }, "caching": { "type": "string", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json index 75d807361e01..823c8d6bcec3 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/BatchService.json @@ -12554,7 +12554,7 @@ "type": "string" }, "title": "The collection of Virtual Hard Disk (VHD) URIs.", - "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve upto 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." + "description": "All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve up to 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the 'targetDedicated' property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur." }, "caching": { "type": "string", @@ -13712,7 +13712,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "Values are:\n\n idle - The node is not currently running a task.\n rebooting - The node is rebooting.\n reimaging - The node is reimaging.\n running - The node is running one or more tasks (other than a start task).\n unusable - The node cannot be used for task execution due to errors.\n creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool.\n starting - the Batch service is starting on the underlying virtual machine.\n waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.\n starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.\n unknown - The Batch service has lost contact with the node, and does not know its true state.\n leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.\n offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled.\n preempted - The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "Values are:\n\n idle - The node is not currently running a task.\n rebooting - The node is rebooting.\n reimaging - The node is reimaging.\n running - The node is running one or more tasks (other than a start task).\n unusable - The node cannot be used for task execution due to errors.\n creating - The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool.\n starting - the Batch service is starting on the underlying virtual machine.\n waitingforstarttask - The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.\n starttaskfailed - The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.\n unknown - The Batch service has lost contact with the node, and does not know its true state.\n leavingpool - The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.\n offline - The node is not currently running a task, and scheduling of new tasks to the node is disabled.\n preempted - The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json index d4fd9d4145c2..f8e8f0bdbaf6 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/BatchService.json @@ -11571,11 +11571,11 @@ }, { "value": "task", - "description": "The certificate should be visibile to the user accounts under which job tasks are run." + "description": "The certificate should be visible to the user accounts under which job tasks are run." }, { "value": "remoteuser", - "description": "The certificate should be visibile to the user accounts under which users remotely access the node.", + "description": "The certificate should be visible to the user accounts under which users remotely access the node.", "name": "remoteUser" } ] @@ -12888,7 +12888,7 @@ "items": { "$ref": "#/definitions/DataDisk" }, - "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "title": "The configuration for data disks attached to the compute nodes in the pool.", "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { @@ -14145,7 +14145,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -14218,7 +14218,7 @@ }, { "value": "preempted", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available." } ] } diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json index 7e79e6181dcf..0cced72aa042 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-03-01.6.1/BatchService.json @@ -11851,11 +11851,11 @@ }, { "value": "task", - "description": "The certificate should be visibile to the user accounts under which job tasks are run." + "description": "The certificate should be visible to the user accounts under which job tasks are run." }, { "value": "remoteuser", - "description": "The certificate should be visibile to the user accounts under which users remotely access the node.", + "description": "The certificate should be visible to the user accounts under which users remotely access the node.", "name": "remoteUser" } ] @@ -13168,7 +13168,7 @@ "items": { "$ref": "#/definitions/DataDisk" }, - "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "title": "The configuration for data disks attached to the compute nodes in the pool.", "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { @@ -14427,7 +14427,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -14500,7 +14500,7 @@ }, { "value": "preempted", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available." } ] } diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json index 59f829847444..d642e24b6a04 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json @@ -11854,11 +11854,11 @@ }, { "value": "task", - "description": "The certificate should be visibile to the user accounts under which job tasks are run." + "description": "The certificate should be visible to the user accounts under which job tasks are run." }, { "value": "remoteuser", - "description": "The certificate should be visibile to the user accounts under which users remotely access the node.", + "description": "The certificate should be visible to the user accounts under which users remotely access the node.", "name": "remoteUser" } ] @@ -13149,7 +13149,7 @@ "items": { "$ref": "#/definitions/DataDisk" }, - "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "title": "The configuration for data disks attached to the compute nodes in the pool.", "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { @@ -14426,7 +14426,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -14499,7 +14499,7 @@ }, { "value": "preempted", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available." } ] } From 4a6ce95def0ea9855ff045a1d19e11f54d02a265 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Sun, 9 Dec 2018 23:12:19 -0500 Subject: [PATCH 363/464] fix: Example consumption\resource-manager\Microsoft.Consumption (#4850) - $top is an integer --- .../preview/2017-04-24-preview/examples/UsageDetailsExpand.json | 2 +- .../stable/2017-11-30/examples/UsageDetailsExpand.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/examples/UsageDetailsExpand.json index 416ac0c7c919..10e258e3c848 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/examples/UsageDetailsExpand.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/preview/2017-04-24-preview/examples/UsageDetailsExpand.json @@ -4,7 +4,7 @@ "scope": "subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702-1", "$expand": "meterDetails,additionalProperties", "$filter": "usageEnd le 2017-02-14T00:00:00Z", - "$top": "1" + "$top": 1 }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/examples/UsageDetailsExpand.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/examples/UsageDetailsExpand.json index 3cb354ad1d20..4aec71a705ff 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/examples/UsageDetailsExpand.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2017-11-30/examples/UsageDetailsExpand.json @@ -4,7 +4,7 @@ "scope": "subscriptions/subid/providers/Microsoft.Billing/billingPeriods/201702", "$expand": "meterDetails,additionalProperties", "$filter": "usageEnd le 2017-02-14T00:00:00Z", - "$top": "1" + "$top": 1 }, "responses": { "200": { From 70039807b1a161304a6cf9c7c7bb61275bffcd0d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 12:00:28 -0500 Subject: [PATCH 364/464] typo: resourcehealth/resource-manager/Microsoft.ResourceHealth (#4830) - Availabilitystatuses -> AvailabilityStatuses --- ...abilitystatuses_List.json => AvailabilityStatuses_List.json} | 0 .../stable/2015-01-01/resourcehealth.json | 2 +- ...abilitystatuses_List.json => AvailabilityStatuses_List.json} | 0 .../stable/2017-07-01/resourcehealth.json | 2 +- 4 files changed, 2 insertions(+), 2 deletions(-) rename specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/{Availabilitystatuses_List.json => AvailabilityStatuses_List.json} (100%) rename specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/{Availabilitystatuses_List.json => AvailabilityStatuses_List.json} (100%) diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_List.json similarity index 100% rename from specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/Availabilitystatuses_List.json rename to specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/AvailabilityStatuses_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json index 090c5f8fba93..65286861885f 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json @@ -216,7 +216,7 @@ }, "x-ms-examples": { "GetHealthHistoryByResource": { - "$ref": "./examples/Availabilitystatuses_List.json" + "$ref": "./examples/AvailabilityStatuses_List.json" } } } diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_List.json similarity index 100% rename from specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/Availabilitystatuses_List.json rename to specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/AvailabilityStatuses_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json index a0a6f61a5449..51cbc405f81f 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json @@ -216,7 +216,7 @@ }, "x-ms-examples": { "GetHealthHistoryByResource": { - "$ref": "./examples/Availabilitystatuses_List.json" + "$ref": "./examples/AvailabilityStatuses_List.json" } } } From 130a02a01ff5b91fb48477a79cf4841f3a8d10b7 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 12:01:56 -0500 Subject: [PATCH 365/464] fix: Examples in batch\data-plane\Microsoft.Batch (#4847) - recursive is boolean --- .../stable/2017-01-01.4.0/examples/FileDeleteFromNode.json | 2 +- .../stable/2017-01-01.4.0/examples/FileDeleteFromTask.json | 2 +- .../stable/2017-01-01.4.0/examples/FileListFromNode.json | 2 +- .../stable/2017-01-01.4.0/examples/FileListFromTask.json | 2 +- .../stable/2017-05-01.5.0/examples/FileDeleteFromNode.json | 2 +- .../stable/2017-05-01.5.0/examples/FileDeleteFromTask.json | 2 +- .../stable/2017-05-01.5.0/examples/FileListFromNode.json | 2 +- .../stable/2017-05-01.5.0/examples/FileListFromTask.json | 2 +- .../stable/2017-06-01.5.1/examples/FileDeleteFromNode.json | 2 +- .../stable/2017-06-01.5.1/examples/FileDeleteFromTask.json | 2 +- .../stable/2017-06-01.5.1/examples/FileListFromNode.json | 2 +- .../stable/2017-06-01.5.1/examples/FileListFromTask.json | 2 +- .../stable/2017-09-01.6.0/examples/FileDeleteFromNode.json | 2 +- .../stable/2017-09-01.6.0/examples/FileDeleteFromTask.json | 2 +- .../stable/2017-09-01.6.0/examples/FileListFromNode.json | 2 +- .../stable/2017-09-01.6.0/examples/FileListFromTask.json | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromNode.json index b1668e5564b5..aa2ec6062bd5 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromNode.json @@ -6,7 +6,7 @@ "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromTask.json index e67cbc7be155..7d14815da786 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileDeleteFromTask.json @@ -6,7 +6,7 @@ "filePath": "wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromNode.json index 85905beb9b46..1496110130ea 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromNode.json @@ -5,7 +5,7 @@ "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromTask.json index ae08f6ee4c87..94fd190468af 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-01-01.4.0/examples/FileListFromTask.json @@ -5,7 +5,7 @@ "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromNode.json index b1668e5564b5..aa2ec6062bd5 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromNode.json @@ -6,7 +6,7 @@ "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromTask.json index e67cbc7be155..7d14815da786 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileDeleteFromTask.json @@ -6,7 +6,7 @@ "filePath": "wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromNode.json index 85905beb9b46..1496110130ea 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromNode.json @@ -5,7 +5,7 @@ "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromTask.json index ae08f6ee4c87..94fd190468af 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-05-01.5.0/examples/FileListFromTask.json @@ -5,7 +5,7 @@ "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromNode.json index 69ce7c009d16..1a710342cb40 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromNode.json @@ -6,7 +6,7 @@ "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromTask.json index 8d3e3920db5f..fe4baac39883 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileDeleteFromTask.json @@ -6,7 +6,7 @@ "filePath": "wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromNode.json index 77e11014f331..34c99a065c8a 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromNode.json @@ -5,7 +5,7 @@ "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromTask.json index ed3300898bb7..b17abfd7614d 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-06-01.5.1/examples/FileListFromTask.json @@ -5,7 +5,7 @@ "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromNode.json index f5640dc0b635..fdcf42097bce 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromNode.json @@ -6,7 +6,7 @@ "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromTask.json index dad74fb23766..5b4d1332fb79 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileDeleteFromTask.json @@ -6,7 +6,7 @@ "filePath": "wd\\testFile.txt", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromNode.json index c2c189c41140..02c28a2d0fda 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromNode.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromNode.json @@ -5,7 +5,7 @@ "nodeId": "tvm-1695681911_1-20161122t193202z", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromTask.json index 5e2300134d89..0de368bafc18 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromTask.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2017-09-01.6.0/examples/FileListFromTask.json @@ -5,7 +5,7 @@ "taskId": "taskId", "client-request-id": "00000000-0000-0000-0000-000000000000", "ocp-data": "Fri, 17 Feb 2017 00:00:00 GMT", - "recursive": "false" + "recursive": false }, "responses": { "200": { From 8dc9b4bd430d7df5bfb8da3d9324674406231048 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 12:02:28 -0500 Subject: [PATCH 366/464] fix: Example compute\resource-manager\Microsoft.Compute (#4851) - $top is an integer --- .../stable/2017-03-30/examples/VirtualMachineRunCommand.json | 2 +- .../stable/2017-12-01/examples/VirtualMachineRunCommand.json | 2 +- .../stable/2018-04-01/examples/VirtualMachineRunCommand.json | 2 +- .../stable/2018-06-01/examples/VirtualMachineRunCommand.json | 2 +- .../stable/2018-10-01/examples/VirtualMachineRunCommand.json | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/VirtualMachineRunCommand.json index 74a1d7fb1f25..d06614d49a0d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/VirtualMachineRunCommand.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/VirtualMachineRunCommand.json @@ -3,7 +3,7 @@ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", "resourceGroupName": "crptestar98131", "vmName": "vm3036", - "$top": "1", + "$top": 1, "api-version": "2017-03-30", "monitor": "true", "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/VirtualMachineRunCommand.json index f958a102f4e5..10175f347d3e 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/VirtualMachineRunCommand.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/VirtualMachineRunCommand.json @@ -3,7 +3,7 @@ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", "resourceGroupName": "crptestar98131", "vmName": "vm3036", - "$top": "1", + "$top": 1, "api-version": "2017-12-01", "monitor": "true", "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json index 18067848da32..92ad7fb460a2 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/VirtualMachineRunCommand.json @@ -3,7 +3,7 @@ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", "resourceGroupName": "crptestar98131", "vmName": "vm3036", - "$top": "1", + "$top": 1, "api-version": "2018-04-01", "monitor": "true", "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json index f2d8da4631c6..f0ab1e1d4a79 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/VirtualMachineRunCommand.json @@ -3,7 +3,7 @@ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", "resourceGroupName": "crptestar98131", "vmName": "vm3036", - "$top": "1", + "$top": 1, "api-version": "2018-06-01", "monitor": "true", "parameters": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommand.json index 2e857a94d437..f0400897c0dd 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommand.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/VirtualMachineRunCommand.json @@ -3,7 +3,7 @@ "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", "resourceGroupName": "crptestar98131", "vmName": "vm3036", - "$top": "1", + "$top": 1, "api-version": "2018-10-01", "monitor": "true", "parameters": { From 38f53a1b2e556413c5373aca071a29b9e878847b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 12:03:24 -0500 Subject: [PATCH 367/464] fix: Example search/data-plane/Microsoft.Azure.Search.Data (#4859) - searchFields is an array - top is an integer - categories is an array --- .../examples/SearchIndexGetAutocomplete.json | 4 ++-- .../examples/SearchIndexPostAutocomplete.json | 4 ++-- .../examples/SearchServiceCreateOrUpdateSkillset.json | 6 +++--- .../examples/SearchServiceCreateSkillset.json | 4 ++-- .../examples/SearchServiceGetSkillset.json | 2 +- .../examples/SearchServiceListSkillsets.json | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json index 2ddae016840d..1ce59bf94eec 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexGetAutocomplete.json @@ -11,8 +11,8 @@ "highlightPostTag": "", "highlightPreTag": "", "minimumCoverage": 80, - "searchFields": "title,description", - "top": "10" + "searchFields": ["title", "description"], + "top": 10 }, "responses": { "200": { diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json index 41d9263200f6..9bf10af1cee4 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexPostAutocomplete.json @@ -11,8 +11,8 @@ "highlightPostTag": "", "highlightPreTag": "", "minimumCoverage": 80, - "searchFields": "title,description", - "top": "10" + "searchFields": ["title", "description"], + "top": 10 } }, "responses": { diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json index ce0b62936272..d9a5fe8227b1 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -10,7 +10,7 @@ "description": "Extract entities, detect language and extract key-phrases", "skills": [{ "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "inputs": [{ "name": "text", @@ -84,7 +84,7 @@ "name": "organizations", "targetName": "organizations" }], - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "minimumPrecision": null }, @@ -158,7 +158,7 @@ "name": "organizations", "targetName": "organizations" }], - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "minimumPrecision": null }, diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json index e2951cd7aa66..dc5420495b7a 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceCreateSkillset.json @@ -10,7 +10,7 @@ "description": "Extract entities, detect language and extract key-phrases", "skills": [{ "@odata.type": "#Microsoft.Skills.Text.NamedEntityRecognitionSkill", - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "inputs": [{ "name": "text", @@ -84,7 +84,7 @@ "name": "organizations", "targetName": "organizations" }], - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "minimumPrecision": null }, diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json index b48455bbe283..814addbe919e 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceGetSkillset.json @@ -22,7 +22,7 @@ "name": "organizations", "targetName": "organizations" }], - "categories": ["Organization"], + "categories": ["organization"], "defaultLanguageCode": "en", "minimumPrecision": null }, diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json index 6b9395e2b503..df8d00743ab8 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Service/preview/2017-11-11-preview/examples/SearchServiceListSkillsets.json @@ -28,7 +28,7 @@ "targetName": "organizations" } ], - "categories": [ "Organization" ], + "categories": [ "organization" ], "defaultLanguageCode": "en", "minimumPrecision": null }, From f13e9228ca45f4d3e375ce84d3154dbb7881a800 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Mon, 10 Dec 2018 09:16:56 -0800 Subject: [PATCH 368/464] add Go SDK codegen for cognitive services localsearch (#4863) --- .../data-plane/LocalSearch/readme.go.md | 26 +++++++++++++++++++ .../data-plane/LocalSearch/readme.md | 9 ++++++- 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/readme.go.md diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.go.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.go.md new file mode 100644 index 000000000000..89b2d8281c88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: localsearch + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: release_1_0 +``` + +### Tag: release_1_0 and go + +These settings apply only when `--tag=release_1_0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0/$(namespace) +``` diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.md index ef1492082453..8dd3f9bc781f 100644 --- a/specification/cognitiveservices/data-plane/LocalSearch/readme.md +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.md @@ -26,6 +26,10 @@ input-file: stable/v1.0/LocalSearch.json This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-go +``` ## CSharp Settings These settings apply only when `--csharp` is specified on the command line. @@ -35,6 +39,9 @@ csharp: output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Search/BingLocalSearch/BingLocalSearch/Generated/LocalSearch ``` +## Go + +See configuration in [readme.go.md](./readme.go.md) ## Suppressions Suppressing errors due to API design: @@ -42,4 +49,4 @@ Suppressing errors due to API design: directive: - suppress: R3016 reason: _type is a polymorphic discriminator that can't be changed. -``` \ No newline at end of file +``` From 3a0278ee2f92ca2fbb5c6bedf54607133bd4f8be Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 12:22:37 -0500 Subject: [PATCH 369/464] typo: resources/resource-manager/Microsoft.Authorization (#4831) - assigment -> assignment - reponse -> response --- .../preview/2015-10-01-preview/policy.json | 6 +++--- .../preview/2017-06-01-preview/policyAssignments.json | 8 ++++---- .../preview/2017-06-01-preview/policySetDefinitions.json | 2 +- .../Microsoft.Authorization/stable/2016-04-01/policy.json | 6 +++--- .../stable/2016-12-01/policyAssignments.json | 6 +++--- .../stable/2018-03-01/policyAssignments.json | 2 +- .../stable/2018-03-01/policySetDefinitions.json | 2 +- .../stable/2018-05-01/policyAssignments.json | 2 +- .../stable/2018-05-01/policySetDefinitions.json | 2 +- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json b/specification/resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json index aaa8b67601aa..587f762a03d7 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/preview/2015-10-01-preview/policy.json @@ -318,7 +318,7 @@ ], "operationId": "PolicyAssignments_DeleteById", "summary": "Deletes a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -347,7 +347,7 @@ ], "operationId": "PolicyAssignments_CreateById", "summary": "Creates a policy assignment by ID.", - "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -385,7 +385,7 @@ ], "operationId": "PolicyAssignments_GetById", "summary": "Gets a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json index ef5fd87cfde7..0be0da5f5b0e 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policyAssignments.json @@ -373,7 +373,7 @@ ], "operationId": "PolicyAssignments_DeleteById", "summary": "Deletes a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -408,7 +408,7 @@ ], "operationId": "PolicyAssignments_CreateById", "summary": "Creates a policy assignment by ID.", - "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -452,7 +452,7 @@ ], "operationId": "PolicyAssignments_GetById", "summary": "Gets a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -583,7 +583,7 @@ "description": "List of policy assignments." }, "ErrorResponse": { - "description": "Error reponse indicates ARM is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates ARM is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json index fa30a26b6402..39cf5669a1d3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/preview/2017-06-01-preview/policySetDefinitions.json @@ -562,7 +562,7 @@ "description": "List of policy set definitions." }, "ErrorResponse": { - "description": "Error reponse indicates ARM is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates ARM is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-04-01/policy.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-04-01/policy.json index 3fd1b0bc6b43..5248ffe973b2 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-04-01/policy.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-04-01/policy.json @@ -318,7 +318,7 @@ ], "operationId": "PolicyAssignments_DeleteById", "summary": "Deletes a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -347,7 +347,7 @@ ], "operationId": "PolicyAssignments_CreateById", "summary": "Creates a policy assignment by ID.", - "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -385,7 +385,7 @@ ], "operationId": "PolicyAssignments_GetById", "summary": "Gets a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json index 181ee40089b4..a41808b639d4 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2016-12-01/policyAssignments.json @@ -322,7 +322,7 @@ ], "operationId": "PolicyAssignments_DeleteById", "summary": "Deletes a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -351,7 +351,7 @@ ], "operationId": "PolicyAssignments_CreateById", "summary": "Creates a policy assignment by ID.", - "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "Policy assignments are inherited by child resources. For example, when you apply a policy to a resource group that policy is assigned to all resources in the group. When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", @@ -389,7 +389,7 @@ ], "operationId": "PolicyAssignments_GetById", "summary": "Gets a policy assignment by ID.", - "description": "When providing a scope for the assigment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", + "description": "When providing a scope for the assignment, use '/subscriptions/{subscription-id}/' for subscriptions, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for resource groups, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider-namespace}/{resource-type}/{resource-name}' for resources.", "parameters": [ { "name": "policyAssignmentId", diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json index 3c0f48fd9c84..0d592a937fac 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policyAssignments.json @@ -619,7 +619,7 @@ "description": "List of policy assignments." }, "ErrorResponse": { - "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json index eff8c9ba5d31..8a13671ca796 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-03-01/policySetDefinitions.json @@ -580,7 +580,7 @@ "description": "List of policy set definitions." }, "ErrorResponse": { - "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json index 8d97569274b6..548222aa58f3 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policyAssignments.json @@ -666,7 +666,7 @@ "description": "Identity for the resource." }, "ErrorResponse": { - "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json index e3758819e5bc..13a467325aa8 100644 --- a/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json +++ b/specification/resources/resource-manager/Microsoft.Authorization/stable/2018-05-01/policySetDefinitions.json @@ -580,7 +580,7 @@ "description": "List of policy set definitions." }, "ErrorResponse": { - "description": "Error reponse indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { From 7f217c7706217105d6b2867a60af23500d2642f1 Mon Sep 17 00:00:00 2001 From: Dan Schulte Date: Mon, 10 Dec 2018 10:37:15 -0800 Subject: [PATCH 370/464] Add Node.js and JavaScript configurations for LocalSearch (#4864) --- .../data-plane/LocalSearch/readme.md | 10 ++++++++++ .../data-plane/LocalSearch/readme.nodejs.md | 14 ++++++++++++++ .../data-plane/LocalSearch/readme.typescript.md | 12 ++++++++++++ 3 files changed, 36 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/readme.nodejs.md create mode 100644 specification/cognitiveservices/data-plane/LocalSearch/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.md index 8dd3f9bc781f..3edd5d921bbd 100644 --- a/specification/cognitiveservices/data-plane/LocalSearch/readme.md +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.md @@ -29,6 +29,8 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node ``` ## CSharp Settings @@ -43,6 +45,14 @@ csharp: See configuration in [readme.go.md](./readme.go.md) +## JavaScript/TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## Node.js + +See configuration in [readme.nodejs.md](./readme.nodejs.md) + ## Suppressions Suppressing errors due to API design: ``` yaml diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.nodejs.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.nodejs.md new file mode 100644 index 000000000000..3be80c6618ca --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-cognitiveservices-localsearch + output-folder: $(node-sdks-folder)/lib/services/cognitiveServicesLocalSearch + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/LocalSearch/readme.typescript.md b/specification/cognitiveservices/data-plane/LocalSearch/readme.typescript.md new file mode 100644 index 000000000000..9b2db9dccc55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LocalSearch/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-localsearch" + output-folder: "$(typescript-sdks-folder)/packages/@azure/cognitiveservices-localsearch" + azure-arm: false + generate-metadata: true +``` From d1e7e7e60c499f8feaa54a32352461007461cd9d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 14:25:04 -0500 Subject: [PATCH 371/464] fix: Example containerinstance\resource-manager\Microsoft.ContainerInstance (#4855) - tail is an integer --- .../preview/2017-08-01-preview/examples/ContainerLogsList.json | 2 +- .../preview/2017-10-01-preview/examples/ContainerLogsList.json | 2 +- .../preview/2017-12-01-preview/examples/ContainerLogsList.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerLogsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerLogsList.json index 04180edc7526..c5865fd5e792 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerLogsList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-08-01-preview/examples/ContainerLogsList.json @@ -5,7 +5,7 @@ "resourceGroupName": "demo", "containerGroupName": "demo1", "containerName": "container1", - "tail": "10" + "tail": 10 }, "responses": { "200": { diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-10-01-preview/examples/ContainerLogsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-10-01-preview/examples/ContainerLogsList.json index 2c6dab0f4509..a1d0a8929d6d 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-10-01-preview/examples/ContainerLogsList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-10-01-preview/examples/ContainerLogsList.json @@ -5,7 +5,7 @@ "resourceGroupName": "demo", "containerGroupName": "demo1", "containerName": "container1", - "tail": "10" + "tail": 10 }, "responses": { "200": { diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-12-01-preview/examples/ContainerLogsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-12-01-preview/examples/ContainerLogsList.json index c7709ea4dd00..2bdac88aeb28 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-12-01-preview/examples/ContainerLogsList.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/preview/2017-12-01-preview/examples/ContainerLogsList.json @@ -5,7 +5,7 @@ "resourceGroupName": "demo", "containerGroupName": "demo1", "containerName": "container1", - "tail": "10" + "tail": 10 }, "responses": { "200": { From 0d141ec2af35f63dda899092ff83e35c0dd5292b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 14:25:55 -0500 Subject: [PATCH 372/464] fix: Example cdn\resource-manager\Microsoft.Cdn (#4848) - Enum value has a casing issue till #4839 is resolved --- .../stable/2017-04-02/examples/CustomDomains_Create.json | 4 ++-- .../stable/2017-10-12/examples/CustomDomains_Create.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/examples/CustomDomains_Create.json index 2f24d4eecc2b..2f11ee897f83 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/examples/CustomDomains_Create.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-04-02/examples/CustomDomains_Create.json @@ -21,9 +21,9 @@ "resourceState": "Active", "hostName": "www.someDomain.net", "customHttpsProvisioningState": "Enabling", - "customHttpsProvisioningSubstate": "PendingDomainControlValidationRequestApproval", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", "validationData": null - } + } } } } diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CustomDomains_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CustomDomains_Create.json index abb7e984c3db..e00af894725f 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CustomDomains_Create.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2017-10-12/examples/CustomDomains_Create.json @@ -21,9 +21,9 @@ "resourceState": "Active", "hostName": "www.someDomain.net", "customHttpsProvisioningState": "Enabling", - "customHttpsProvisioningSubstate": "PendingDomainControlValidationRequestApproval", + "customHttpsProvisioningSubstate": "PendingDomainControlValidationREquestApproval", "validationData": null - } + } } } } From 2ab7bb8776766566d9771a8f9141617ccd742927 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 14:27:02 -0500 Subject: [PATCH 373/464] typo: web/resource-manager/Microsoft.DomainRegistration (#4814) - Succesfully -> Successfully - identifider -> identifier - availablility -> availability --- .../stable/2015-04-01/Domains.json | 8 ++++---- .../stable/2015-04-01/examples/ListOperations.json | 4 ++-- .../stable/2018-02-01/Domains.json | 8 ++++---- .../stable/2018-02-01/examples/ListOperations.json | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json index 3a33566b95a0..ec768049c2c8 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/Domains.json @@ -294,7 +294,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain." + "description": "Successfully deleted domain." }, "204": { "description": "Domain does not exist in Azure database probably because it has already been deleted" @@ -517,10 +517,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -916,7 +916,7 @@ } }, "DomainAvailablilityCheckResult": { - "description": "Domain availablility check result.", + "description": "Domain availability check result.", "type": "object", "properties": { "name": { diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/examples/ListOperations.json index a40364452f86..669b6a6dc1e2 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/examples/ListOperations.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2015-04-01/examples/ListOperations.json @@ -71,8 +71,8 @@ "name": "Microsoft.DomainRegistration/checkDomainAvailability/Action", "display": { "provider": "Microsoft Domains", - "resource": "Domain Availablity Result", - "operation": "Check Domain Availablity", + "resource": "Domain Availability Result", + "operation": "Check Domain Availability", "description": "Check if a domain is available for purchase" }, "origin": "user,system" diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json index 0fc57054d2f0..4510c3098001 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/Domains.json @@ -336,7 +336,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain." + "description": "Successfully deleted domain." }, "204": { "description": "Domain does not exist in Azure database probably because it has already been deleted" @@ -583,10 +583,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -983,7 +983,7 @@ } }, "DomainAvailablilityCheckResult": { - "description": "Domain availablility check result.", + "description": "Domain availability check result.", "type": "object", "properties": { "name": { diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/examples/ListOperations.json index ee7179e8d149..28a72da606b5 100644 --- a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/examples/ListOperations.json +++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2018-02-01/examples/ListOperations.json @@ -71,8 +71,8 @@ "name": "Microsoft.DomainRegistration/checkDomainAvailability/Action", "display": { "provider": "Microsoft Domains", - "resource": "Domain Availablity Result", - "operation": "Check Domain Availablity", + "resource": "Domain Availability Result", + "operation": "Check Domain Availability", "description": "Check if a domain is available for purchase" }, "origin": "user,system" From d002e975438b42cd70bdf173aedcc5366178e419 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 15:55:48 -0500 Subject: [PATCH 374/464] fix: Example servicefabric/data-plane/Microsoft.ServiceFabric (#4861) - ExcludeApplicationParameters is a boolean - Previous is a boolean - IncludeHealthState is a boolean --- .../stable/6.2/examples/GetApplicationTypeInfoList-3.json | 2 +- .../stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json | 2 +- .../stable/6.2/examples/GetDeployedApplicationInfoByName-1.json | 2 +- .../stable/6.2/examples/GetDeployedApplicationInfoList-3.json | 2 +- .../stable/6.3/examples/GetApplicationTypeInfoList-3.json | 2 +- .../stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json | 2 +- .../stable/6.3/examples/GetDeployedApplicationInfoByName-1.json | 2 +- .../stable/6.3/examples/GetDeployedApplicationInfoList-3.json | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json index 123e89fa4520..c7d613655e79 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetApplicationTypeInfoList-3.json @@ -3,7 +3,7 @@ "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", "parameters": { "api-version": "6.0", - "ExcludeApplicationParameters": "true" + "ExcludeApplicationParameters": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json index d188271fdf4f..745dbf2a5c35 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetContainerLogsDeployedOnNode-3.json @@ -7,7 +7,7 @@ "applicationId": "SimpleHttpServerApp", "ServiceManifestName": "SimpleHttpServerSvcPkg", "CodePackageName": "Code", - "Previous": "true" + "Previous": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json index 954cf260b781..60eccd40779d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoByName-1.json @@ -5,7 +5,7 @@ "api-version": "6.1", "nodeName": "_Node_0", "applicationId": "samples~CalculatorApp", - "IncludeHealthState": "true" + "IncludeHealthState": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json index a3b2da108c3a..d222c7f9550e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/examples/GetDeployedApplicationInfoList-3.json @@ -4,7 +4,7 @@ "parameters": { "api-version": "6.1", "nodeName": "_Node_0", - "IncludeHealthState": "true" + "IncludeHealthState": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json index 123e89fa4520..c7d613655e79 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetApplicationTypeInfoList-3.json @@ -3,7 +3,7 @@ "description": "This example shows how to exclude application parameter in the result when getting the information about application types that are provisioned or being provisioned in the cluster.", "parameters": { "api-version": "6.0", - "ExcludeApplicationParameters": "true" + "ExcludeApplicationParameters": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json index d188271fdf4f..745dbf2a5c35 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetContainerLogsDeployedOnNode-3.json @@ -7,7 +7,7 @@ "applicationId": "SimpleHttpServerApp", "ServiceManifestName": "SimpleHttpServerSvcPkg", "CodePackageName": "Code", - "Previous": "true" + "Previous": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json index 954cf260b781..60eccd40779d 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoByName-1.json @@ -5,7 +5,7 @@ "api-version": "6.1", "nodeName": "_Node_0", "applicationId": "samples~CalculatorApp", - "IncludeHealthState": "true" + "IncludeHealthState": true }, "responses": { "200": { diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json index a3b2da108c3a..d222c7f9550e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/examples/GetDeployedApplicationInfoList-3.json @@ -4,7 +4,7 @@ "parameters": { "api-version": "6.1", "nodeName": "_Node_0", - "IncludeHealthState": "true" + "IncludeHealthState": true }, "responses": { "200": { From 0c44353a42c05c83d06d5e5854d96c4879e6f172 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 15:57:59 -0500 Subject: [PATCH 375/464] fix: Example recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices (#4858) - polyType enum value is capitalized --- .../ProtectionPolicies_CreateOrUpdate_Complex.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json index 787d14953a62..e2228c79b624 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2016-12-01/examples/AzureWorkload/ProtectionPolicies_CreateOrUpdate_Complex.json @@ -15,7 +15,7 @@ }, "subProtectionPolicy": [ { - "policyType": "full", + "policyType": "Full", "schedulePolicy": { "schedulePolicyType": "SimpleSchedulePolicy", "scheduleRunFrequency": "Weekly", From db23eed181f2d1be9a736d7e5bfe6729a2d30b25 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 16:02:12 -0500 Subject: [PATCH 376/464] typo: servicefabric/data-plane/Microsoft.ServiceFabric (#4834) - Double word "the" - ABRIC -> FABRIC - dataloss -> data loss - valus -> value - indentifying -> identifying - deletd -> deleted - hamdle -> handle - ReliablecollectionsRef -> ReliableCollectionsRef - URI's -> URIs --- .../stable/6.2/servicefabric.json | 6 ++--- .../stable/6.3/servicefabric.json | 6 ++--- .../stable/6.4/servicefabric.json | 24 +++++++++---------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json index 8c9ab8d94113..c3ac806afb72 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -14500,7 +14500,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Running", @@ -14529,7 +14529,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Stopped", @@ -15017,7 +15017,7 @@ }, "ApplicationInclusionList": { "type": "array", - "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "description": "A list of application URIs to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/ApplicationName" } diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json index 07659f1e22cb..41fa3e280d3e 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json @@ -14911,7 +14911,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Running", @@ -14940,7 +14940,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Stopped", @@ -15428,7 +15428,7 @@ }, "ApplicationInclusionList": { "type": "array", - "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "description": "A list of application URIs to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/ApplicationName" } diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json index 8917ab7afaa1..d41f58cbe3ee 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json @@ -8251,7 +8251,7 @@ "$ref": "./examples/Resources/Secrets/values/list.json" } }, - "summary": "List names of all values of the the specified secret resource.", + "summary": "List names of all values of the specified secret resource.", "description": "Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.", "parameters": [ { @@ -9197,7 +9197,7 @@ }, "FabricErrorCodes": { "type": "string", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"", "enum": [ "FABRIC_E_INVALID_PARTITION_KEY", "FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR", @@ -9560,7 +9560,7 @@ "properties": { "Code": { "$ref": "#/definitions/FabricErrorCodes", - "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"ABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" + "description": "Defines the fabric error codes that be returned as part of the error object in response to Service Fabric API operations that are not successful. Following are the error code values that can be returned for a specific HTTP status code.\n\n - Possible values of the error code for HTTP status code 400 (Bad Request)\n - \"FABRIC_E_INVALID_PARTITION_KEY\"\n - \"FABRIC_E_IMAGEBUILDER_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_ADDRESS\"\n - \"FABRIC_E_APPLICATION_NOT_UPGRADING\"\n - \"FABRIC_E_APPLICATION_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_FABRIC_NOT_UPGRADING\"\n - \"FABRIC_E_FABRIC_UPGRADE_VALIDATION_ERROR\"\n - \"FABRIC_E_INVALID_CONFIGURATION\"\n - \"FABRIC_E_INVALID_NAME_URI\"\n - \"FABRIC_E_PATH_TOO_LONG\"\n - \"FABRIC_E_KEY_TOO_LARGE\"\n - \"FABRIC_E_SERVICE_AFFINITY_CHAIN_NOT_SUPPORTED\"\n - \"FABRIC_E_INVALID_ATOMIC_GROUP\"\n - \"FABRIC_E_VALUE_EMPTY\"\n - \"FABRIC_E_BACKUP_IS_ENABLED\"\n - \"FABRIC_E_RESTORE_SOURCE_TARGET_PARTITION_MISMATCH\"\n - \"FABRIC_E_INVALID_FOR_STATELESS_SERVICES\"\n - \"FABRIC_E_INVALID_SERVICE_SCALING_POLICY\"\n - \"E_INVALIDARG\"\n\n - Possible values of the error code for HTTP status code 404 (Not Found)\n - \"FABRIC_E_NODE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_TYPE_NOT_FOUND\"\n - \"FABRIC_E_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_TYPE_NOT_FOUND\"\n - \"FABRIC_E_SERVICE_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_TYPE_TEMPLATE_NOT_FOUND\"\n - \"FABRIC_E_CONFIGURATION_SECTION_NOT_FOUND\"\n - \"FABRIC_E_PARTITION_NOT_FOUND\"\n - \"FABRIC_E_REPLICA_DOES_NOT_EXIST\"\n - \"FABRIC_E_SERVICE_GROUP_DOES_NOT_EXIST\"\n - \"FABRIC_E_CONFIGURATION_PARAMETER_NOT_FOUND\"\n - \"FABRIC_E_DIRECTORY_NOT_FOUND\"\n - \"FABRIC_E_FABRIC_VERSION_NOT_FOUND\"\n - \"FABRIC_E_FILE_NOT_FOUND\"\n - \"FABRIC_E_NAME_DOES_NOT_EXIST\"\n - \"FABRIC_E_PROPERTY_DOES_NOT_EXIST\"\n - \"FABRIC_E_ENUMERATION_COMPLETED\"\n - \"FABRIC_E_SERVICE_MANIFEST_NOT_FOUND\"\n - \"FABRIC_E_KEY_NOT_FOUND\"\n - \"FABRIC_E_HEALTH_ENTITY_NOT_FOUND\"\n - \"FABRIC_E_BACKUP_NOT_ENABLED\"\n - \"FABRIC_E_BACKUP_POLICY_NOT_EXISTING\"\n - \"FABRIC_E_FAULT_ANALYSIS_SERVICE_NOT_EXISTING\"\n - \"FABRIC_E_IMAGEBUILDER_RESERVED_DIRECTORY_ERROR\"\n\n - Possible values of the error code for HTTP status code 409 (Conflict)\n - \"FABRIC_E_APPLICATION_TYPE_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_APPLICATION_TYPE_PROVISION_IN_PROGRESS\"\n - \"FABRIC_E_APPLICATION_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_SERVICE_ALREADY_EXISTS\"\n - \"FABRIC_E_SERVICE_GROUP_ALREADY_EXISTS\"\n - \"FABRIC_E_APPLICATION_TYPE_IN_USE\"\n - \"FABRIC_E_FABRIC_ALREADY_IN_TARGET_VERSION\"\n - \"FABRIC_E_FABRIC_VERSION_ALREADY_EXISTS\"\n - \"FABRIC_E_FABRIC_VERSION_IN_USE\"\n - \"FABRIC_E_FABRIC_UPGRADE_IN_PROGRESS\"\n - \"FABRIC_E_NAME_ALREADY_EXISTS\"\n - \"FABRIC_E_NAME_NOT_EMPTY\"\n - \"FABRIC_E_PROPERTY_CHECK_FAILED\"\n - \"FABRIC_E_SERVICE_METADATA_MISMATCH\"\n - \"FABRIC_E_SERVICE_TYPE_MISMATCH\"\n - \"FABRIC_E_HEALTH_STALE_REPORT\"\n - \"FABRIC_E_SEQUENCE_NUMBER_CHECK_FAILED\"\n - \"FABRIC_E_NODE_HAS_NOT_STOPPED_YET\"\n - \"FABRIC_E_INSTANCE_ID_MISMATCH\"\n - \"FABRIC_E_BACKUP_IN_PROGRESS\"\n - \"FABRIC_E_RESTORE_IN_PROGRESS\"\n - \"FABRIC_E_BACKUP_POLICY_ALREADY_EXISTING\"\n\n - Possible values of the error code for HTTP status code 413 (Request Entity Too Large)\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 500 (Internal Server Error)\n - \"FABRIC_E_NODE_IS_UP\"\n - \"E_FAIL\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_ALREADY_EXISTS\"\n - \"FABRIC_E_SINGLE_INSTANCE_APPLICATION_NOT_FOUND\"\n - \"FABRIC_E_VOLUME_ALREADY_EXISTS\"\n - \"FABRIC_E_VOLUME_NOT_FOUND\"\n - \"SerializationError\"\n\n - Possible values of the error code for HTTP status code 503 (Service Unavailable)\n - \"FABRIC_E_NO_WRITE_QUORUM\"\n - \"FABRIC_E_NOT_PRIMARY\"\n - \"FABRIC_E_NOT_READY\"\n - \"FABRIC_E_RECONFIGURATION_PENDING\"\n - \"FABRIC_E_SERVICE_OFFLINE\"\n - \"E_ABORT\"\n - \"FABRIC_E_VALUE_TOO_LARGE\"\n\n - Possible values of the error code for HTTP status code 504 (Gateway Timeout)\n - \"FABRIC_E_COMMUNICATION_ERROR\"\n - \"FABRIC_E_OPERATION_NOT_COMPLETE\"\n - \"FABRIC_E_TIMEOUT\"" }, "Message": { "type": "string", @@ -11245,7 +11245,7 @@ }, "DataLossVersion": { "type": "string", - "description": "The current dataloss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." + "description": "The current data loss number of this Epoch. The data loss number property is an increasing value which is updated whenever data loss is suspected, as when loss of a quorum of replicas in the replica set that includes the Primary replica." } } }, @@ -15374,7 +15374,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Running", @@ -15403,7 +15403,7 @@ "values": [ { "value": "Invalid", - "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The valus is zero." + "description": "Indicates an invalid Chaos Schedule status. All Service Fabric enumerations have the invalid type. The value is zero." }, { "value": "Stopped", @@ -15853,7 +15853,7 @@ }, "ApplicationInclusionList": { "type": "array", - "description": "A list of application URI's to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", + "description": "A list of application URIs to include in Chaos faults.\nAll replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos.\nChaos may restart a code package only if the code package hosts replicas of these applications only.\nIf an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList.\nHowever, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted.\nAt most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/ApplicationName" } @@ -19556,7 +19556,7 @@ }, "PartitionId": { "$ref": "#/definitions/PartitionId", - "description": "The partition ID indentifying the partition." + "description": "The partition ID identifying the partition." } }, "x-ms-discriminator-value": "Partition" @@ -19660,7 +19660,7 @@ }, "PartitionId": { "$ref": "#/definitions/PartitionId", - "description": "The partition ID indentifying the partition." + "description": "The partition ID identifying the partition." } }, "x-ms-discriminator-value": "Partition" @@ -23339,7 +23339,7 @@ }, { "value": "Deleting", - "description": "Indicates the resource is being deletd. The value is 4." + "description": "Indicates the resource is being deleted. The value is 4." }, { "value": "Failed", @@ -23981,7 +23981,7 @@ }, "routes": { "type": "array", - "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can hamdle general cases.", + "description": "Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases.", "items": { "$ref": "#/definitions/HttpRouteConfig" } @@ -24585,7 +24585,7 @@ "description": "Reference to sinks in DiagnosticsDescription." }, "reliableCollectionsRefs": { - "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliablecollectionsRef for more details.", + "description": "A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details.", "type": "array", "items": { "$ref": "#/definitions/ReliableCollectionsRef" From 0764d080c3cd25022e41123936bb22fbedaf424d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 16:06:45 -0500 Subject: [PATCH 377/464] typo: CustomVision/Training (#4817) - Minor formatting - Limted -> Limited - assocated -> associated - modifed -> modified --- .../Training/stable/v1.2/Training.json | 19 +++++++------------ .../Training/stable/v2.0/Training.json | 8 ++++---- .../Training/stable/v2.1/Training.json | 8 ++++---- .../Training/stable/v2.2/Training.json | 8 ++++---- 4 files changed, 19 insertions(+), 24 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v1.2/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v1.2/Training.json index ab61c03bcfde..4d0fc5128a13 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v1.2/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v1.2/Training.json @@ -371,16 +371,11 @@ } } }, - "x-ms-examples": { - "Successful CreateImagesFromData request": { - "$ref": "./examples/CreateImagesFromData.json" - - } } - - + } + } }, "delete": { "tags": [ @@ -403,7 +398,7 @@ { "name": "imageIds", "in": "query", - "description": "Ids of the images to be deleted. Limted to 256 images per batch", + "description": "Ids of the images to be deleted. Limited to 256 images per batch", "required": true, "type": "array", "items": { @@ -578,7 +573,7 @@ { "name": "batch", "in": "body", - "description": "Image and tag ids. Limted to 64 images and 20 tags per batch", + "description": "Image and tag ids. Limited to 64 images and 20 tags per batch", "required": true, "schema": { "$ref": "#/definitions/ImageIdCreateBatch" @@ -694,7 +689,7 @@ { "name": "tagIds", "in": "query", - "description": "Tags to be deleted from the specified images. Limted to 20 tags", + "description": "Tags to be deleted from the specified images. Limited to 20 tags", "required": true, "type": "array", "items": { @@ -1926,7 +1921,7 @@ "x-nullable": true }, "AccountQuota": { - "description": "Represents a set of quotas assocated with an account", + "description": "Represents a set of quotas associated with an account", "type": "object", "properties": { "Tier": { @@ -2641,7 +2636,7 @@ }, "LastModified": { "format": "date-time", - "description": "Gets the date this project was last modifed", + "description": "Gets the date this project was last modified", "type": "string", "readOnly": true, "x-nullable": false diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json index b7e2ab4afe26..39d371d1a620 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.0/Training.json @@ -557,7 +557,7 @@ { "name": "imageIds", "in": "query", - "description": "Ids of the images to be deleted. Limted to 256 images per batch", + "description": "Ids of the images to be deleted. Limited to 256 images per batch", "required": true, "type": "array", "items": { @@ -735,7 +735,7 @@ { "name": "batch", "in": "body", - "description": "Image and tag ids. Limted to 64 images and 20 tags per batch", + "description": "Image and tag ids. Limited to 64 images and 20 tags per batch", "required": true, "schema": { "$ref": "#/definitions/ImageIdCreateBatch" @@ -851,7 +851,7 @@ { "name": "tagIds", "in": "query", - "description": "Tags to be deleted from the specified images. Limted to 20 tags", + "description": "Tags to be deleted from the specified images. Limited to 20 tags", "required": true, "type": "array", "items": { @@ -3378,7 +3378,7 @@ }, "lastModified": { "format": "date-time", - "description": "Gets the date this project was last modifed", + "description": "Gets the date this project was last modified", "type": "string", "readOnly": true, "x-nullable": false diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json index 1745217e49fa..116a2eef6d69 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.1/Training.json @@ -557,7 +557,7 @@ { "name": "imageIds", "in": "query", - "description": "Ids of the images to be deleted. Limted to 256 images per batch", + "description": "Ids of the images to be deleted. Limited to 256 images per batch", "required": true, "type": "array", "items": { @@ -735,7 +735,7 @@ { "name": "batch", "in": "body", - "description": "Image and tag ids. Limted to 64 images and 20 tags per batch", + "description": "Image and tag ids. Limited to 64 images and 20 tags per batch", "required": true, "schema": { "$ref": "#/definitions/ImageIdCreateBatch" @@ -851,7 +851,7 @@ { "name": "tagIds", "in": "query", - "description": "Tags to be deleted from the specified images. Limted to 20 tags", + "description": "Tags to be deleted from the specified images. Limited to 20 tags", "required": true, "type": "array", "items": { @@ -3414,7 +3414,7 @@ }, "lastModified": { "format": "date-time", - "description": "Gets the date this project was last modifed", + "description": "Gets the date this project was last modified", "type": "string", "readOnly": true, "x-nullable": false diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.2/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.2/Training.json index 95a064611e7b..b15bd9bb1ca4 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.2/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v2.2/Training.json @@ -305,7 +305,7 @@ { "name": "tagIds", "in": "query", - "description": "Tags to be deleted from the specified images. Limted to 20 tags.", + "description": "Tags to be deleted from the specified images. Limited to 20 tags.", "required": true, "type": "array", "items": { @@ -780,7 +780,7 @@ { "name": "imageIds", "in": "query", - "description": "Ids of the images to be deleted. Limted to 256 images per batch.", + "description": "Ids of the images to be deleted. Limited to 256 images per batch.", "required": true, "type": "array", "items": { @@ -958,7 +958,7 @@ { "name": "batch", "in": "body", - "description": "Image and tag ids. Limted to 64 images and 20 tags per batch.", + "description": "Image and tag ids. Limited to 64 images and 20 tags per batch.", "required": true, "schema": { "$ref": "#/definitions/ImageIdCreateBatch" @@ -3554,7 +3554,7 @@ }, "lastModified": { "format": "date-time", - "description": "Gets the date this project was last modifed.", + "description": "Gets the date this project was last modified.", "type": "string", "readOnly": true, "x-nullable": false From 9d5c6ab9d91e33e53277f2648e7489cb30cabb23 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 16:08:14 -0500 Subject: [PATCH 378/464] typo: storage/data-plane/Microsoft.StorageDataLake (#4785) - specifed -> specified - filesysystem -> filesystem --- .../preview/2018-06-17/DataLakeStorage.json | 4 ++-- .../stable/2018-11-09/DataLakeStorage.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json index 58dedf05a766..144de7b75b08 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/preview/2018-06-17/DataLakeStorage.json @@ -151,7 +151,7 @@ }, "responses": { "ErrorResponse": { - "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specifed resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", + "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specified resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", "headers": { "x-ms-request-id": { "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", @@ -781,7 +781,7 @@ { "name": "x-ms-rename-source", "in": "header", - "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", "required": false, "type": "string" }, diff --git a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json index 83ae7b96eabd..e7321f635cf1 100644 --- a/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json +++ b/specification/storage/data-plane/Microsoft.StorageDataLake/stable/2018-11-09/DataLakeStorage.json @@ -151,7 +151,7 @@ }, "responses": { "ErrorResponse": { - "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specifed resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", + "description": "An error occurred. The possible HTTP status, code, and message strings are listed below:\n* 400 Bad Request, ContentLengthMustBeZero, \"The Content-Length request header must be zero.\"\n* 400 Bad Request, InvalidAuthenticationInfo, \"Authentication information is not given in the correct format. Check the value of Authorization header.\"\n* 400 Bad Request, InvalidFlushPosition, \"The uploaded data is not contiguous or the position query parameter value is not equal to the length of the file after appending the uploaded data.\"\n* 400 Bad Request, InvalidHeaderValue, \"The value for one of the HTTP headers is not in the correct format.\"\n* 400 Bad Request, InvalidHttpVerb, \"The HTTP verb specified is invalid - it is not recognized by the server.\"\n* 400 Bad Request, InvalidInput, \"One of the request inputs is not valid.\"\n* 400 Bad Request, InvalidPropertyName, \"A property name cannot be empty.\"\n* 400 Bad Request, InvalidPropertyName, \"The property name contains invalid characters.\"\n* 400 Bad Request, InvalidQueryParameterValue, \"Value for one of the query parameters specified in the request URI is invalid.\"\n* 400 Bad Request, InvalidResourceName, \"The specified resource name contains invalid characters.\"\n* 400 Bad Request, InvalidSourceUri, \"The source URI is invalid.\"\n* 400 Bad Request, InvalidUri, \"The request URI is invalid.\"\n* 400 Bad Request, MissingRequiredHeader, \"An HTTP header that's mandatory for this request is not specified.\"\n* 400 Bad Request, MissingRequiredQueryParameter, \"A query parameter that's mandatory for this request is not specified.\"\n* 400 Bad Request, MultipleConditionHeadersNotSupported, \"Multiple condition headers are not supported.\"\n* 400 Bad Request, OutOfRangeInput, \"One of the request inputs is out of range.\"\n* 400 Bad Request, OutOfRangeQueryParameterValue, \"One of the query parameters specified in the request URI is outside the permissible range.\"\n* 400 Bad Request, UnsupportedHeader, \"One of the headers specified in the request is not supported.\"\n* 400 Bad Request, UnsupportedQueryParameter, \"One of the query parameters specified in the request URI is not supported.\"\n* 400 Bad Request, UnsupportedRestVersion, \"The specified Rest Version is Unsupported.\"\n* 403 Forbidden, AccountIsDisabled, \"The specified account is disabled.\"\n* 403 Forbidden, AuthorizationFailure, \"This request is not authorized to perform this operation.\"\n* 403 Forbidden, InsufficientAccountPermissions, \"The account being accessed does not have sufficient permissions to execute this operation.\"\n* 404 Not Found, FilesystemNotFound, \"The specified filesystem does not exist.\"\n* 404 Not Found, PathNotFound, \"The specified path does not exist.\"\n* 404 Not Found, RenameDestinationParentPathNotFound, \"The parent directory of the destination path does not exist.\"\n* 404 Not Found, ResourceNotFound, \"The specified resource does not exist.\"\n* 404 Not Found, SourcePathNotFound, \"The source path for a rename operation does not exist.\"\n* 405 Method Not Allowed, UnsupportedHttpVerb, \"The resource doesn't support the specified HTTP verb.\"\n* 409 Conflict, DestinationPathIsBeingDeleted, \"The specified destination path is marked to be deleted.\"\n* 409 Conflict, DirectoryNotEmpty, \"The recursive query parameter value must be true to delete a non-empty directory.\"\n* 409 Conflict, FilesystemAlreadyExists, \"The specified filesystem already exists.\"\n* 409 Conflict, FilesystemBeingDeleted, \"The specified filesystem is being deleted.\"\n* 409 Conflict, InvalidDestinationPath, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"* 409 Conflict, InvalidFlushOperation, \"The resource was created or modified by the Blob Service API and cannot be written to by the Data Lake Storage Service API.\"\n* 409 Conflict, InvalidRenameSourcePath, \"The source directory cannot be the same as the destination directory, nor can the destination be a subdirectory of the source directory.\"\n* 409 Conflict, InvalidSourceOrDestinationResourceType, \"The source and destination resource type must be identical.\"\n* 409 Conflict, LeaseAlreadyPresent, \"There is already a lease present.\"\n* 409 Conflict, LeaseIdMismatchWithLeaseOperation, \"The lease ID specified did not match the lease ID for the resource with the specified lease operation.\"\n* 409 Conflict, LeaseIsAlreadyBroken, \"The lease has already been broken and cannot be broken again.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeAcquired, \"The lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.\"\n* 409 Conflict, LeaseIsBreakingAndCannotBeChanged, \"The lease ID matched, but the lease is currently in breaking state and cannot be changed.\"\n* 409 Conflict, LeaseIsBrokenAndCannotBeRenewed, \"The lease ID matched, but the lease has been broken explicitly and cannot be renewed.\"\n* 409 Conflict, LeaseNameMismatch, \"The lease name specified did not match the existing lease name.\"\n* 409 Conflict, LeaseNotPresentWithLeaseOperation, \"The lease ID is not present with the specified lease operation.\"\n* 409 Conflict, PathAlreadyExists, \"The specified path already exists.\"\n* 409 Conflict, PathConflict, \"The specified path, or an element of the path, exists and its resource type is invalid for this operation.\"\n* 409 Conflict, SourcePathIsBeingDeleted, \"The specified source path is marked to be deleted.\"\n* 409 Conflict, ResourceTypeMismatch, \"The resource type specified in the request does not match the type of the resource.\"\n* 412 Precondition Failed, ConditionNotMet, \"The condition specified using HTTP conditional header(s) is not met.\"\n* 412 Precondition Failed, LeaseIdMismatch, \"The lease ID specified did not match the lease ID for the resource.\"\n* 412 Precondition Failed, LeaseIdMissing, \"There is currently a lease on the resource and no lease ID was specified in the request.\"\n* 412 Precondition Failed, LeaseNotPresent, \"There is currently no lease on the resource.\"\n* 412 Precondition Failed, LeaseLost, \"A lease ID was specified, but the lease for the resource has expired.\"\n* 412 Precondition Failed, SourceConditionNotMet, \"The source condition specified using HTTP conditional header(s) is not met.\"\n* 413 Request Entity Too Large, RequestBodyTooLarge, \"The request body is too large and exceeds the maximum permissible limit.\"\n* 416 Requested Range Not Satisfiable, InvalidRange, \"The range specified is invalid for the current size of the resource.\"\n* 500 Internal Server Error, InternalError, \"The server encountered an internal error. Please retry the request.\"\n* 500 Internal Server Error, OperationTimedOut, \"The operation could not be completed within the permitted time.\"\n* 503 Service Unavailable, ServerBusy, \"Egress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Ingress is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"Operations per second is over the account limit.\"\n* 503 Service Unavailable, ServerBusy, \"The server is currently unable to receive requests. Please retry your request.\"", "headers": { "x-ms-request-id": { "description": "A server-generated UUID recorded in the analytics logs for troubleshooting and correlation.", @@ -792,7 +792,7 @@ { "name": "x-ms-rename-source", "in": "header", - "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesysystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", + "description": "An optional file or directory to be renamed. The value must have the following format: \"/{filesystem}/{path}\". If \"x-ms-properties\" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.", "required": false, "type": "string" }, From b357fdc8323c24be1f87ec9ab9b426ced5638d9b Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 16:09:46 -0500 Subject: [PATCH 379/464] typo: powerbidedicated/resource-manager/Microsoft.PowerBIdedicated (#4728) - PowerBI capitialization - availibility -> availability - Dedicatedresource -> Dedicated resource - Trim trailing space --- .../stable/2017-10-01/powerbidedicated.json | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json index d420b5557d8a..d278616f6dbc 100644 --- a/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json +++ b/specification/powerbidedicated/resource-manager/Microsoft.PowerBIdedicated/stable/2017-10-01/powerbidedicated.json @@ -459,7 +459,7 @@ "in": "body", "required": true, "schema": - { + { "$ref": "#/definitions/CheckCapacityNameAvailabilityParameters" }, "description": "The name of the capacity." @@ -481,7 +481,7 @@ } } } - }, + }, "definitions": { "OperationListResult": { "description": "Result listing capacities. It contains a list of operations and a URL link to get the next set of results.", @@ -669,7 +669,7 @@ "modelAsString": true }, "readOnly": true, - "description": "The current deployment state of PowerBI Dedicatedresource. The provisioningState is to indicate states for resource provisioning." + "description": "The current deployment state of PowerBI Dedicated resource. The provisioningState is to indicate states for resource provisioning." } }, "allOf": [ @@ -786,17 +786,17 @@ "type": { "type": "string", "default": "Microsoft.PowerBIDedicated/capacities", - "description": "The resource type of powerbi dedicated." + "description": "The resource type of PowerBI dedicated." } } }, "CheckCapacityNameAvailabilityResult": { - "description": "The checking result of capacity name availibility.", + "description": "The checking result of capacity name availability.", "type": "object", "properties": { "nameAvailable": { "type": "boolean", - "description": "Indicator of availablity of the capacity name." + "description": "Indicator of availability of the capacity name." }, "reason": { "type": "string", From a09c315384840a8a5e8a762e0d573004c3b1bb24 Mon Sep 17 00:00:00 2001 From: jureid <44306969+jureid@users.noreply.github.com> Date: Mon, 10 Dec 2018 13:13:04 -0800 Subject: [PATCH 380/464] Change $filter value from invoicePeriodStartDate to invoicePeriodEndDate (#4824) $filter may be used to filter invoices by invoicePeriodEndDate, not invoicePeriodStartDate. This doc (https://docs.microsoft.com/en-us/rest/api/billing/invoices/list) is for API Version 2017-04-24-preview, so this change should fix the sample request in the doc --- .../preview/2017-04-24-preview/examples/InvoicesExpand.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/examples/InvoicesExpand.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/examples/InvoicesExpand.json index 3bdd4367a75b..e8dd72ba9303 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/examples/InvoicesExpand.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2017-04-24-preview/examples/InvoicesExpand.json @@ -3,7 +3,7 @@ "api-version": "2017-04-24-preview", "subscriptionId": "subid", "$top": "1", - "$filter": "invoicePeriodStartDate le 2017-02-01", + "$filter": "invoicePeriodEndDate le 2017-02-01", "$expand": "downloadUrl" }, "responses": { @@ -31,4 +31,4 @@ } } } -} \ No newline at end of file +} From 58cfc703b335ca3eba86644c9f5e0e245f67231e Mon Sep 17 00:00:00 2001 From: Ankur Kulshrestha Date: Mon, 10 Dec 2018 13:31:52 -0800 Subject: [PATCH 381/464] Add DeviceStreams properties to IoTHub and modify RoutingTwin object (#4823) * Add DeviceStreams properties to IoTHub and modify RoutingTwin object for new preview API * Add example files * Fix the api version * Fix build failure * validation fixes --- .../examples/checkNameAvailability.json | 20 + .../iothub_certificatescreateorupdate.json | 44 + .../examples/iothub_certificatesdelete.json | 14 + .../examples/iothub_certverify.json | 31 + .../examples/iothub_createOrUpdate.json | 301 ++ .../examples/iothub_createconsumergroup.json | 23 + .../examples/iothub_delete.json | 206 + .../examples/iothub_deleteconsumergroup.json | 13 + .../examples/iothub_exportdevices.json | 23 + .../iothub_generateverificationcode.json | 26 + .../examples/iothub_get.json | 109 + .../examples/iothub_getcertificate.json | 27 + .../examples/iothub_getconsumergroup.json | 23 + .../examples/iothub_getjob.json | 20 + .../examples/iothub_getkey.json | 19 + .../examples/iothub_getskus.json | 53 + .../examples/iothub_importdevices.json | 23 + .../examples/iothub_listbyrg.json | 111 + .../examples/iothub_listbysubscription.json | 110 + .../examples/iothub_listcertificates.json | 30 + .../examples/iothub_listehgroups.json | 26 + .../examples/iothub_listjobs.json | 23 + .../examples/iothub_listkeys.json | 46 + .../examples/iothub_operations.json | 328 ++ .../examples/iothub_patch.json | 116 + .../examples/iothub_quotametrics.json | 26 + .../iothub_routingendpointhealth.json | 24 + .../examples/iothub_stats.json | 17 + .../examples/iothub_testallroutes.json | 32 + .../examples/iothub_testnewroute.json | 48 + .../examples/iothub_usages.json | 25 + .../preview/2018-12-01-preview/iothub.json | 3406 +++++++++++++++++ 32 files changed, 5343 insertions(+) create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/checkNameAvailability.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatescreateorupdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatesdelete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certverify.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createOrUpdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_delete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_deleteconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_exportdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_generateverificationcode.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_get.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getcertificate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getjob.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getkey.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getskus.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_importdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbyrg.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbysubscription.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listcertificates.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listehgroups.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listjobs.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listkeys.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_operations.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_patch.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_quotametrics.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_routingendpointhealth.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_stats.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testallroutes.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testnewroute.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_usages.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/checkNameAvailability.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/checkNameAvailability.json new file mode 100644 index 000000000000..7d1031a3caed --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/checkNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationInputs": { + "name": "test-request" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatescreateorupdate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatescreateorupdate.json new file mode 100644 index 000000000000..e9df5616652f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatescreateorupdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "resourceName": "iothub", + "resourceGroupName": "myResourceGroup", + "api-version":"2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription":{ + "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" + }, + "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" + }, + "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=" + } + } + } + } \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatesdelete.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatesdelete.json new file mode 100644 index 000000000000..3c33872242ff --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certificatesdelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceName": "myhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certverify.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certverify.json new file mode 100644 index 000000000000..b1b91a751b5e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_certverify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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=" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createOrUpdate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createOrUpdate.json new file mode 100644 index 000000000000..254e967fad48 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createOrUpdate.json @@ -0,0 +1,301 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotHubDescription": { + "name": "iot-dps-cit-hub-1", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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 + } + } + }, + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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 + } + } + }, + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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/preview/2018-12-01-preview/examples/iothub_createconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createconsumergroup.json new file mode 100644 index 000000000000..459df01476fd --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_createconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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=" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_delete.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_delete.json new file mode 100644 index 000000000000..1173c6694ca3 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_delete.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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": {} + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_deleteconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_deleteconsumergroup.json new file mode 100644 index 000000000000..2413c95ae943 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_deleteconsumergroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": {} + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_exportdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_exportdevices.json new file mode 100644 index 000000000000..61eadcd9d399 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_exportdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_generateverificationcode.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_generateverificationcode.json new file mode 100644 index 000000000000..9b89f81f14fb --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_generateverificationcode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_get.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_get.json new file mode 100644 index 000000000000..7ce708a0f21c --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_get.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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", + "deviceStreams": { + "streamingEndpoints": ["https://streams.azure-devices-int.net:9443"] + } + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getcertificate.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getcertificate.json new file mode 100644 index 000000000000..aecfe2998085 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getcertificate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getconsumergroup.json new file mode 100644 index 000000000000..459df01476fd --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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=" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getjob.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getjob.json new file mode 100644 index 000000000000..d8fa515f0a39 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getjob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getkey.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getkey.json new file mode 100644 index 000000000000..9eb32b446d64 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getkey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "iothubowner" + }, + "responses": { + "200": { + "body": { + "keyName": "iothubowner", + "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=", + "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getskus.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getskus.json new file mode 100644 index 000000000000..148d520949d6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_getskus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_importdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_importdevices.json new file mode 100644 index 000000000000..58e852df3781 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_importdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbyrg.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbyrg.json new file mode 100644 index 000000000000..dd708fe7b8f3 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbyrg.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbysubscription.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbysubscription.json new file mode 100644 index 000000000000..a0a500e6a7ea --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listbysubscription.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "resourceName": "testHub", + "api-version": "2018-12-01-preview", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listcertificates.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listcertificates.json new file mode 100644 index 000000000000..83e454640038 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listcertificates.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listehgroups.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listehgroups.json new file mode 100644 index 000000000000..e273575bfe02 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listehgroups.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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=" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listjobs.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listjobs.json new file mode 100644 index 000000000000..213d26ee3d96 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listjobs.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listkeys.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listkeys.json new file mode 100644 index 000000000000..f427e08c7a15 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_listkeys.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_operations.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_operations.json new file mode 100644 index 000000000000..3019658c559d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_operations.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview" + }, + "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" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_patch.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_patch.json new file mode 100644 index 000000000000..1114d819582f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_patch.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "resourceName": "myHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "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": { + "operationsMonitoringProperties": { + "events": { + "None": "None", + "Connections": "None", + "DeviceTelemetry": "None", + "C2DCommands": "None", + "DeviceIdentityOperations": "None", + "FileUploadOperations": "None", + "Routes": "None" + } + }, + "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/" + }, + "operationsMonitoringEvents": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1-operationmonitoring", + "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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_quotametrics.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_quotametrics.json new file mode 100644 index 000000000000..63ce3168af8d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_quotametrics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TotalMessages", + "currentValue": 0, + "maxValue": 400000 + }, + { + "name": "TotalDeviceCount", + "currentValue": 0, + "maxValue": 500000 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..0225322ddf3f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_routingendpointhealth.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_stats.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_stats.json new file mode 100644 index 000000000000..9f6fb117e3c1 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/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 + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..6d31b15dfb61 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testallroutes.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": ["id1"], + "isEnabled": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..46c299b3b150 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_testnewroute.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-12-01-preview", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": "App Properties", + "systemProperties": "System Properties" + }, + "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 + } + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_usages.json new file mode 100644 index 000000000000..474d2fb45483 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2018-12-01-preview", + "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" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json new file mode 100644 index 000000000000..2d625f517795 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json @@ -0,0 +1,3406 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-12-01-preview", + "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 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" + } + ], + "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/CertificateBodyDescription" + } + }, + { + "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 + } + } + }, + "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" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "Thehub state 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 possible keys to this dictionary are events and operationsMonitoringEvents. Both of these keys have 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" + }, + "operationsMonitoringProperties": { + "$ref": "#/definitions/OperationsMonitoringProperties" + }, + "deviceStreams": { + "description": "The device streams properties of iothub.", + "type": "object", + "properties": { + "streamingEndpoints": { + "description": "List of Device Streams Endpoints.", + "type": "array", + "items": { + "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 + } + } + } + }, + "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 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" + } + }, + "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" + } + } + }, + "OperationsMonitoringProperties": { + "description": "The operations monitoring properties for the IoT hub. The possible keys to the dictionary are Connections, DeviceTelemetry, C2DCommands, DeviceIdentityOperations, FileUploadOperations, Routes, D2CTwinOperations, C2DTwinOperations, TwinQueries, JobsOperations, DirectMethods.", + "type": "object", + "properties": { + "events": { + "type": "object", + "additionalProperties": { + "enum": [ + "None", + "Error", + "Information", + "Error, Information" + ], + "description": "The operations monitoring level.", + "type": "string", + "x-ms-enum": { + "name": "OperationMonitoringLevel", + "modelAsString": true + } + } + } + } + }, + "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" + ] + }, + "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" + } + } + }, + "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": { + "connectionString": { + "description": "The connection string of the service bus queue endpoint.", + "type": "string" + }, + "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, operationsMonitoringEvents, 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", + "connectionString" + ] + }, + "RoutingServiceBusTopicEndpointProperties": { + "description": "The properties related to service bus topic endpoint types.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string of the service bus topic endpoint.", + "type": "string" + }, + "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, operationsMonitoringEvents, 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", + "connectionString" + ] + }, + "RoutingEventHubProperties": { + "description": "The properties related to an event hub endpoint.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string of the event hub endpoint. ", + "type": "string" + }, + "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, operationsMonitoringEvents, 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", + "connectionString" + ] + }, + "RoutingStorageContainerProperties": { + "description": "The properties related to a storage container endpoint.", + "type": "object", + "properties": { + "connectionString": { + "description": "The connection string of the storage account.", + "type": "string" + }, + "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, operationsMonitoringEvents, 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' and 'avrodeflate'. Default value is 'avro'.", + "type": "string" + } + }, + "required": [ + "name", + "connectionString", + "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" + ] + }, + "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 status", + "enum": [ + "unknown", + "healthy", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + } + } + }, + "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 + } + } + }, + "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" + } + }, + "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" + } + }, + "required": [ + "inputBlobContainerUri", + "outputBlobContainerUri" + ] + } + }, + "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" + } + } +} \ No newline at end of file From d8805f6215cad3b04b30ad2c17bc78659aedf764 Mon Sep 17 00:00:00 2001 From: Matthew Christopher Date: Mon, 10 Dec 2018 15:34:58 -0800 Subject: [PATCH 382/464] Add Batch dataplane API version 2018-12-01.8.0 (#4795) * Prepare for Azure Batch new API version * Add new data plane API version 2018-12-01.8.0 * Fix documentation issues * Fix examples - Add batchUrl parameter. - Rename "ocp-data" to "ocp-date" to correctly reflect what the API actually requires. --- .../stable/2018-12-01.8.0/BatchService.json | 15868 ++++++++++++++++ .../examples/AccountListNodeAgentSkus.json | 64 + .../examples/AccountListPoolNodeCounts.json | 121 + .../examples/ApplicationGet.json | 20 + .../examples/ApplicationList.json | 23 + .../examples/CertificateAdd.json | 20 + .../examples/CertificateCancelDelete.json | 15 + .../examples/CertificateDelete.json | 15 + .../examples/CertificateGet.json | 34 + .../examples/CertificateList.json | 36 + .../examples/FileDeleteFromNode.json | 17 + .../examples/FileDeleteFromTask.json | 17 + .../examples/FileGetFromNode.json | 21 + .../examples/FileGetFromTask.json | 21 + .../examples/FileGetPropertiesFromNode.json | 21 + .../examples/FileGetPropertiesFromTask.json | 21 + .../examples/FileListFromNode.json | 46 + .../examples/FileListFromTask.json | 41 + .../2018-12-01.8.0/examples/JobAdd_Basic.json | 20 + .../examples/JobAdd_Complex.json | 122 + .../2018-12-01.8.0/examples/JobDelete.json | 14 + .../2018-12-01.8.0/examples/JobDisable.json | 17 + .../2018-12-01.8.0/examples/JobEnable.json | 14 + .../2018-12-01.8.0/examples/JobGet.json | 41 + .../examples/JobGetLifetimeStatistics.json | 28 + .../examples/JobGetTaskCounts.json | 20 + .../2018-12-01.8.0/examples/JobList.json | 42 + .../examples/JobListFromJobSchedule.json | 43 + ...obListPreparationAndReleaseTaskStatus.json | 40 + .../2018-12-01.8.0/examples/JobPatch.json | 24 + .../examples/JobScheduleAdd_Basic.json | 24 + .../examples/JobScheduleAdd_Complex.json | 130 + .../examples/JobScheduleDelete.json | 14 + .../examples/JobScheduleDisable.json | 14 + .../examples/JobScheduleEnable.json | 14 + .../examples/JobScheduleExists.json | 17 + .../examples/JobScheduleGet.json | 44 + .../examples/JobScheduleList.json | 74 + .../examples/JobSchedulePatch.json | 30 + .../examples/JobScheduleTerminate.json | 14 + .../examples/JobScheduleUpdate.json | 30 + .../2018-12-01.8.0/examples/JobTerminate.json | 17 + .../2018-12-01.8.0/examples/JobUpdate.json | 24 + .../2018-12-01.8.0/examples/NodeAddUser.json | 21 + .../examples/NodeDeleteUser.json | 16 + .../examples/NodeDisableScheduling.json | 18 + .../examples/NodeEnableScheduling.json | 15 + .../examples/NodeGetRemoteDesktop.json | 15 + .../examples/NodeGetRemoteLoginSettings.json | 18 + .../examples/NodeGet_Basic.json | 52 + .../2018-12-01.8.0/examples/NodeList.json | 131 + .../2018-12-01.8.0/examples/NodeReboot.json | 18 + .../2018-12-01.8.0/examples/NodeReimage.json | 18 + .../examples/NodeUpdateUser.json | 20 + .../examples/NodeUploadBatchServiceLogs.json | 22 + .../PoolAdd_CloudServiceConfiguration.json | 35 + .../PoolAdd_VirtualMachineConfiguration.json | 40 + ...ualMachineConfigurationWithContainers.json | 41 + .../2018-12-01.8.0/examples/PoolDelete.json | 14 + .../examples/PoolDisableAutoScale.json | 14 + .../examples/PoolEnableAutoscale.json | 18 + .../examples/PoolEvaluateAutoscale.json | 20 + .../2018-12-01.8.0/examples/PoolExists.json | 17 + .../examples/PoolGetLifetimeStatistics.json | 37 + .../examples/PoolGet_Basic.json | 56 + .../examples/PoolListUsageMetrics.json | 30 + .../examples/PoolList_Basic.json | 54 + .../2018-12-01.8.0/examples/PoolPatch.json | 19 + .../examples/PoolRemoveNodes.json | 20 + .../2018-12-01.8.0/examples/PoolResize.json | 18 + .../examples/PoolStopResize.json | 14 + .../2018-12-01.8.0/examples/PoolUpdate.json | 22 + .../examples/TaskAddCollection_Basic.json | 43 + .../examples/TaskAddCollection_Complex.json | 77 + .../examples/TaskAdd_Basic.json | 18 + .../examples/TaskAdd_ContainerSettings.json | 28 + .../examples/TaskAdd_ExitConditions.json | 35 + .../2018-12-01.8.0/examples/TaskDelete.json | 15 + .../2018-12-01.8.0/examples/TaskGet.json | 43 + .../2018-12-01.8.0/examples/TaskList.json | 67 + .../examples/TaskListSubtasks.json | 50 + .../examples/TaskReactivate.json | 15 + .../examples/TaskTerminate.json | 15 + .../2018-12-01.8.0/examples/TaskUpdate.json | 22 + specification/batch/data-plane/readme.go.md | 10 + specification/batch/data-plane/readme.md | 11 +- 86 files changed, 18573 insertions(+), 1 deletion(-) create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListNodeAgentSkus.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListPoolNodeCounts.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateAdd.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateCancelDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromNode.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromTask.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDisable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobEnable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetLifetimeStatistics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetTaskCounts.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListFromJobSchedule.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListPreparationAndReleaseTaskStatus.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobPatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDisable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleEnable.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleExists.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobSchedulePatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeAddUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDeleteUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDisableScheduling.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeEnableScheduling.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteDesktop.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteLoginSettings.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGet_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReboot.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReimage.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUpdateUser.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUploadBatchServiceLogs.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_CloudServiceConfiguration.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfiguration.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDisableAutoScale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEnableAutoscale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEvaluateAutoscale.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolExists.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGetLifetimeStatistics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGet_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolListUsageMetrics.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolList_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolPatch.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolRemoveNodes.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolResize.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolStopResize.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolUpdate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Complex.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_Basic.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ContainerSettings.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ExitConditions.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskDelete.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskGet.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskList.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskListSubtasks.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskReactivate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskTerminate.json create mode 100644 specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskUpdate.json diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json new file mode 100644 index 000000000000..3e91d04cadf1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json @@ -0,0 +1,15868 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchService", + "version": "2018-12-01.8.0", + "description": "A client for issuing REST requests to the Azure Batch service.", + "x-ms-code-generation-settings": { + "name": "BatchServiceClient" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{batchUrl}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/batchUrl" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json; odata=minimalmetadata" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + }, + { + "api_key": [] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + }, + "api_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "paths": { + "/applications": { + "get": { + "tags": [ + "Applications" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Application_List", + "x-ms-examples": { + "List applications": { "$ref": "./examples/ApplicationList.json" } + }, + "summary": "Lists all of the applications available in the specified account.", + "description": "This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 applications can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of applications.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/applications/{applicationId}": { + "get": { + "tags": [ + "Applications" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "Get applications": { "$ref": "./examples/ApplicationGet.json" } + }, + "summary": "Gets information about the specified application.", + "description": "This operation returns only applications and versions that are available for use on compute nodes; that is, that can be used in an application package reference. For administrator information about applications and versions that are not yet available to compute nodes, use the Azure portal or the Azure Resource Manager API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "applicationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the application." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the application.", + "schema": { + "$ref": "#/definitions/ApplicationSummary" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/poolusagemetrics": { + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_ListUsageMetrics", + "x-ms-examples": { + "Pool list usage metrics": { "$ref": "./examples/PoolListUsageMetrics.json" } + }, + "summary": "Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account.", + "description": "If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "starttime", + "x-ms-client-name": "startTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "endtime", + "x-ms-client-name": "endTime", + "in": "query", + "required": false, + "type": "string", + "format": "date-time", + "description": "The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-account-usage-metrics.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of pool usage details.", + "schema": { + "$ref": "#/definitions/PoolListUsageMetricsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/nodeagentskus": { + "get": { + "tags": [ + "Accounts" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Account_ListNodeAgentSkus", + "x-ms-examples": { + "Account list node agent skus": { "$ref": "./examples/AccountListNodeAgentSkus.json" } + }, + "summary": "Lists all node agent SKUs supported by the Azure Batch service.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-node-agent-skus.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 results will be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of node agent SKUs.", + "schema": { + "$ref": "#/definitions/AccountListNodeAgentSkusResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/nodecounts": { + "get": { + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "tags": [ + "Accounts" + ], + "operationId": "Account_ListPoolNodeCounts", + "description": "Gets the number of nodes in each state, grouped by pool.", + "x-ms-examples": { + "NodeCountsPayload": { "$ref": "./examples/AccountListPoolNodeCounts.json" } + }, + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 10, + "minimum": 1, + "maximum": 10, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The response contains the number of nodes in each node state, grouped by pool.", + "schema": { + "$ref": "#/definitions/PoolNodeCountsListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimepoolstats": { + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_GetAllLifetimeStatistics", + "x-ms-examples": { + "Pool get lifetime statistics": { "$ref": "./examples/PoolGetLifetimeStatistics.json" } + }, + "summary": "Gets lifetime summary statistics for all of the pools in the specified account.", + "description": "Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the pool statistics for the lifetime of the Batch account.", + "schema": { + "$ref": "#/definitions/PoolStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/lifetimejobstats": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetAllLifetimeStatistics", + "x-ms-examples": { + "Job get lifetime statistics": { "$ref": "./examples/JobGetLifetimeStatistics.json" } + }, + "summary": "Gets lifetime summary statistics for all of the jobs in the specified account.", + "description": "Statistics are aggregated across all jobs that have ever existed in the account, from account creation to the last update time of the statistics. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the job statistics for the lifetime of the Batch account.", + "schema": { + "$ref": "#/definitions/JobStatistics" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Add", + "x-ms-examples": { + "Certificate add": { "$ref": "./examples/CertificateAdd.json" } + }, + "summary": "Adds a certificate to the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "certificate", + "in": "body", + "description": "The certificate to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Certificate_List", + "x-ms-examples": { + "Certificate list": { "$ref": "./examples/CertificateList.json" } + }, + "summary": "Lists all of the certificates that have been added to the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 certificates can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of certificates.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldelete": { + "post": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_CancelDeletion", + "x-ms-examples": { + "Certificate cancel delete": { "$ref": "./examples/CertificateCancelDelete.json" } + }, + "summary": "Cancels a failed deletion of a certificate from the specified account.", + "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the certificate being deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})": { + "delete": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Delete", + "x-ms-examples": { + "Certificate delete": { "$ref": "./examples/CertificateDelete.json" } + }, + "summary": "Deletes a certificate from the specified account.", + "description": "You cannot delete a certificate if a resource (pool or compute node) is using it. Before you can delete a certificate, you must therefore make sure that the certificate is not associated with any existing pools, the certificate is not installed on any compute nodes (even if you remove a certificate from a pool, it is not removed from existing compute nodes in that pool until they restart), and no running tasks depend on the certificate. If you try to delete a certificate that is in use, the deletion fails. The certificate status changes to deleteFailed. You can use Cancel Delete Certificate to set the status back to active if you decide that you want to continue using the certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the certificate to be deleted." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Certificates" + ], + "operationId": "Certificate_Get", + "x-ms-examples": { + "Certificate get": { "$ref": "./examples/CertificateGet.json" } + }, + "description": "Gets information about the specified certificate.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "thumbprintAlgorithm", + "in": "path", + "required": true, + "type": "string", + "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." + }, + { + "name": "thumbprint", + "in": "path", + "required": true, + "type": "string", + "description": "The thumbprint of the certificate to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the certificate.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromTask", + "x-ms-examples": { + "File delete from task": { "$ref": "./examples/FileDeleteFromTask.json" } + }, + "summary": "Deletes the specified task file from the compute node where the task ran.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job that contains the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task whose file you want to delete." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the task file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromTask", + "x-ms-examples": { + "Get File From Task": { "$ref": "./examples/FileGetFromTask.json" } + }, + "description": "Returns the content of the specified task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job that contains the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task whose file you want to retrieve." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the task file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromTask", + "x-ms-examples": { + "File get properties from task": { "$ref": "./examples/FileGetPropertiesFromTask.json" } + }, + "description": "Gets the properties of the specified task file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job that contains the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task whose file you want to get the properties of." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the task file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files/{filePath}": { + "delete": { + "tags": [ + "Files" + ], + "operationId": "File_DeleteFromComputeNode", + "x-ms-examples": { + "File delete from node": { "$ref": "./examples/FileDeleteFromNode.json" } + }, + "summary": "Deletes the specified file from the compute node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node from which you want to delete the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the file or directory that you want to delete." + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can set recursive to true to delete the directory and all of the files and subdirectories in it. If recursive is false then the directory must be empty or deletion will fail." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Files" + ], + "operationId": "File_GetFromComputeNode", + "x-ms-examples": { + "Get File From Compute Node": { "$ref": "./examples/FileGetFromNode.json" } + }, + "description": "Returns the content of the specified compute node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the compute node file that you want to get the content of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-range", + "in": "header", + "required": false, + "type": "string", + "description": "The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "The file content.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Files" + ], + "operationId": "File_GetPropertiesFromComputeNode", + "x-ms-examples": { + "File get properties from node": { "$ref": "./examples/FileGetPropertiesFromNode.json" } + }, + "description": "Gets the properties of the specified compute node file.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node that contains the file." + }, + { + "name": "filePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path to the compute node file that you want to get the properties of." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-creation-time": { + "description": "The file creation time.", + "type": "string", + "format": "date-time-rfc1123" + }, + "ocp-batch-file-isdirectory": { + "description": "Whether the object represents a directory.", + "type": "boolean" + }, + "ocp-batch-file-url": { + "description": "The URL of the file.", + "type": "string" + }, + "ocp-batch-file-mode": { + "description": "The file mode attribute in octal format.", + "type": "string" + }, + "Content-Type": { + "description": "The content type of the file.", + "type": "string" + }, + "Content-Length": { + "description": "The length of the file.", + "type": "integer", + "format": "int64" + } + }, + "description": "A response containing the file properties." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromTask", + "x-ms-examples": { + "File list from task": { "$ref": "./examples/FileListFromTask.json" } + }, + "summary": "Lists the files in a task's directory on its compute node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job that contains the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-task-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of the task directory. This parameter can be used in combination with the filter parameter to list specific type of files." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/files": { + "get": { + "tags": [ + "Files" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "File_ListFromComputeNode", + "x-ms-examples": { + "File list from node": { "$ref": "./examples/FileListFromNode.json" } + }, + "summary": "Lists all of the files in task directories on the specified compute node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node whose files you want to list." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-compute-node-files.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "recursive", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to list children of a directory." + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 files can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of files.", + "schema": { + "$ref": "#/definitions/NodeFileListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}": { + "head": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Exists", + "x-ms-examples": { + "Check Job Schedule Exists": { "$ref": "./examples/JobScheduleExists.json" } + }, + "summary": "Checks the specified job schedule exists.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule which you want to check." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the job schedule, if it exists." + }, + "404": { + "description": "The job schedule does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "delete": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Delete", + "x-ms-examples": { + "JobSchedule delete": { "$ref": "./examples/JobScheduleDelete.json" } + }, + "summary": "Deletes a job schedule from the specified account.", + "description": "When you delete a job schedule, this also deletes all jobs and tasks under that schedule. When tasks are deleted, all the files in their working directories on the compute nodes are also deleted (the retention period is ignored). The job schedule statistics are no longer accessible once the job schedule is deleted, though they are still counted towards account lifetime statistics.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Get", + "x-ms-examples": { + "JobSchedule get": { "$ref": "./examples/JobScheduleGet.json" } + }, + "description": "Gets information about the specified job schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the job schedule.", + "schema": { + "$ref": "#/definitions/CloudJobSchedule" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Patch", + "x-ms-examples": { + "JobSchedule patch": { "$ref": "./examples/JobSchedulePatch.json" } + }, + "summary": "Updates the properties of the specified job schedule.", + "description": "This replaces only the job schedule properties specified in the request. For example, if the schedule property is not specified with this request, then the Batch service will keep the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to update." + }, + { + "name": "jobSchedulePatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobSchedulePatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Update", + "x-ms-examples": { + "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } + }, + "summary": "Updates the properties of the specified job schedule.", + "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to update." + }, + { + "name": "jobScheduleUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/disable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Disable", + "x-ms-examples": { + "JobSchedule disable": { "$ref": "./examples/JobScheduleDisable.json" } + }, + "summary": "Disables a job schedule.", + "description": "No new jobs will be created until the job schedule is enabled again.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to disable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/enable": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Enable", + "x-ms-examples": { + "JobSchedule enable": { "$ref": "./examples/JobScheduleEnable.json" } + }, + "summary": "Enables a job schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/terminate": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Terminate", + "x-ms-examples": { + "JobSchedule terminate": { "$ref": "./examples/JobScheduleTerminate.json" } + }, + "summary": "Terminates a job schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule to terminates." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules": { + "post": { + "tags": [ + "JobSchedules" + ], + "operationId": "JobSchedule_Add", + "x-ms-examples": { + "Add a basic JobSchedule": { "$ref": "./examples/JobScheduleAdd_Basic.json" }, + "Add a complex JobScheduleAdd": { "$ref": "./examples/JobScheduleAdd_Complex.json" } + }, + "summary": "Adds a job schedule to the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "cloudJobSchedule", + "in": "body", + "description": "The job schedule to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobScheduleAddParameter" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "JobSchedules" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "JobSchedule_List", + "x-ms-examples": { + "JobSchedule list": { "$ref": "./examples/JobScheduleList.json" } + }, + "summary": "Lists all of the job schedules in the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-schedules.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 job schedules can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of job schedules.", + "schema": { + "$ref": "#/definitions/CloudJobScheduleListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}": { + "delete": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Delete", + "x-ms-examples": { + "Delete Job": { "$ref": "./examples/JobDelete.json" } + }, + "summary": "Deletes a job.", + "description": "Deleting a job also deletes all tasks that are part of that job, and all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working directories and all their contents. When a Delete Job request is received, the Batch service sets the job to the deleting state. All update operations on a job that is in deleting state will fail with status code 409 (Conflict), with additional information indicating that the job is being deleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Get", + "x-ms-examples": { + "Job get": { "$ref": "./examples/JobGet.json" } + }, + "summary": "Gets information about the specified job.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the job.", + "schema": { + "$ref": "#/definitions/CloudJob" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Patch", + "x-ms-examples": { + "Job patch": { "$ref": "./examples/JobPatch.json" } + }, + "summary": "Updates the properties of the specified job.", + "description": "This replaces only the job properties specified in the request. For example, if the job has constraints, and a request does not specify the constraints element, then the job keeps the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job whose properties you want to update." + }, + { + "name": "jobPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Update", + "x-ms-examples": { + "Job update": { "$ref": "./examples/JobUpdate.json" } + }, + "summary": "Updates the properties of the specified job.", + "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job whose properties you want to update." + }, + { + "name": "jobUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/disable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Disable", + "x-ms-examples": { + "Job disable": { "$ref": "./examples/JobDisable.json" } + }, + "summary": "Disables the specified job, preventing new tasks from running.", + "description": "The Batch Service immediately moves the job to the disabling state. Batch then uses the disableTasks parameter to determine what to do with the currently running tasks of the job. The job remains in the disabling state until the disable operation is completed and all tasks have been dealt with according to the disableTasks option; the job then moves to the disabled state. No new tasks are started under the job until it moves back to active state. If you try to disable a job that is in any state other than active, disabling, or disabled, the request fails with status code 409.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to disable." + }, + { + "name": "jobDisableParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/JobDisableParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/enable": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Enable", + "x-ms-examples": { + "Job enable": { "$ref": "./examples/JobEnable.json" } + }, + "summary": "Enables the specified job, allowing new tasks to run.", + "description": "When you call this API, the Batch service sets a disabled job to the enabling state. After the this operation is completed, the job moves to the active state, and scheduling of new tasks under the job resumes. The Batch service does not allow a task to remain in the active state for more than 180 days. Therefore, if you enable a job containing active tasks which were added more than 180 days ago, those tasks will not run.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to enable." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/terminate": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Terminate", + "x-ms-examples": { + "Job terminate": { "$ref": "./examples/JobTerminate.json" } + }, + "summary": "Terminates the specified job, marking it as completed.", + "description": "When a Terminate Job request is received, the Batch service sets the job to the terminating state. The Batch service then terminates any running tasks associated with the job and runs any required job release tasks. Then the job moves into the completed state. If there are any tasks in the job in the active state, they will remain in the active state. Once a job is terminated, new tasks cannot be added and any remaining active tasks will not be scheduled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to terminate." + }, + { + "name": "jobTerminateParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/JobTerminateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs": { + "post": { + "tags": [ + "Jobs" + ], + "operationId": "Job_Add", + "x-ms-examples": { + "Add a basic job": { "$ref": "./examples/JobAdd_Basic.json" }, + "Add a complex job": { "$ref": "./examples/JobAdd_Complex.json" } + }, + "summary": "Adds a job to the specified account.", + "description": "The Batch service supports two ways to control the work done as part of a job. In the first approach, the user specifies a Job Manager task. The Batch service launches this task when it is ready to start the job. The Job Manager task controls all other tasks that run under this job, by using the Task APIs. In the second approach, the user directly controls the execution of tasks under an active job, by using the Task APIs. Also note: when naming jobs, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "job", + "in": "body", + "description": "The job to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/JobAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_List", + "x-ms-examples": { + "Job list": { "$ref": "./examples/JobList.json" } + }, + "summary": "Lists all of the jobs in the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobschedules/{jobScheduleId}/jobs": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "x-ms-examples": { + "List Job Under Job Schedule": { "$ref": "./examples/JobListFromJobSchedule.json" } + }, + "operationId": "Job_ListFromJobSchedule", + "summary": "Lists the jobs that have been created under the specified job schedule.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobScheduleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job schedule from which you want to get a list of jobs." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-jobs-in-a-job-schedule.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 jobs can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of jobs.", + "schema": { + "$ref": "#/definitions/CloudJobListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/jobpreparationandreleasetaskstatus": { + "get": { + "tags": [ + "Jobs" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Job_ListPreparationAndReleaseTaskStatus", + "x-ms-examples": { + "Job list preparation and release task status": { "$ref": "./examples/JobListPreparationAndReleaseTaskStatus.json" } + }, + "summary": "Lists the execution status of the Job Preparation and Job Release task for the specified job across the compute nodes where the job has run.", + "description": "This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. This includes nodes which have since been removed from the pool. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409 (Conflict) with an error code of JobPreparationTaskNotSpecified.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-job-preparation-and-release-status.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing a list of Job Preparation and Job Release task statuses.", + "schema": { + "$ref": "#/definitions/CloudJobListPreparationAndReleaseTaskStatusResult" + } + }, + "default": { + "description": "The error from the Batch service. If this API is invoked on a job which has no Job Preparation or Job Release task, the Batch service returns HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/taskcounts": { + "get": { + "tags": [ + "Jobs" + ], + "operationId": "Job_GetTaskCounts", + "x-ms-examples": { + "Job get task counts": { "$ref": "./examples/JobGetTaskCounts.json" } + }, + "summary": "Gets the task counts for the specified job.", + "description": "Task counts provide a count of the tasks by active, running or completed task state, and a count of tasks which succeeded or failed. Tasks in the preparing state are counted as running.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "A response containing the task counts for the specified job.", + "schema": { + "$ref": "#/definitions/TaskCounts" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Add", + "x-ms-examples": { + "Add a CloudServiceConfiguration pool": { "$ref": "./examples/PoolAdd_CloudServiceConfiguration.json" }, + "Add a VirtualMachineConfiguration pool": { "$ref": "./examples/PoolAdd_VirtualMachineConfiguration.json" }, + "Add a VirtualMachineConfiguration pool with containers": { "$ref": "./examples/PoolAdd_VirtualMachineConfigurationWithContainers.json" } + }, + "summary": "Adds a pool to the specified account.", + "description": "When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "pool", + "in": "body", + "description": "The pool to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/PoolAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Pool_List", + "x-ms-examples": { + "Pool list": { "$ref": "./examples/PoolList_Basic.json" } + }, + "summary": "Lists all of the pools in the specified account.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-pools.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 pools can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of pools.", + "schema": { + "$ref": "#/definitions/CloudPoolListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}": { + "delete": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Delete", + "x-ms-examples": { + "Pool delete": { "$ref": "./examples/PoolDelete.json" } + }, + "summary": "Deletes a pool from the specified account.", + "description": "When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "head": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Exists", + "x-ms-examples": { + "Check Pool Exists": { "$ref": "./examples/PoolExists.json" } + }, + "description": "Gets basic properties of a pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to get." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing headers related to the pool, if it exists." + }, + "404": { + "description": "The pool does not exist." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Get", + "x-ms-examples": { + "Pool get": { "$ref": "./examples/PoolGet_Basic.json" } + }, + "description": "Gets information about the specified pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to get." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the pool.", + "schema": { + "$ref": "#/definitions/CloudPool" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Patch", + "x-ms-examples": { + "Patch the Pool": { "$ref": "./examples/PoolPatch.json" } + }, + "summary": "Updates the properties of the specified pool.", + "description": "This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to update." + }, + { + "name": "poolPatchParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolPatchParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/disableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_DisableAutoScale", + "x-ms-examples": { + "Disable pool autoscale": { "$ref": "./examples/PoolDisableAutoScale.json" } + }, + "summary": "Disables automatic scaling for a pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool on which to disable automatic scaling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/enableautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EnableAutoScale", + "x-ms-examples": { + "Pool enable autoscale": { "$ref": "./examples/PoolEnableAutoscale.json" } + }, + "summary": "Enables automatic scaling for a pool.", + "description": "You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool on which to enable automatic scaling." + }, + { + "name": "poolEnableAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEnableAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/evaluateautoscale": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_EvaluateAutoScale", + "x-ms-examples": { + "Pool evaluate autoscale": { "$ref": "./examples/PoolEvaluateAutoscale.json" } + }, + "summary": "Gets the result of evaluating an automatic scaling formula on the pool.", + "description": "This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool on which to evaluate the automatic scaling formula." + }, + { + "name": "poolEvaluateAutoScaleParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolEvaluateAutoScaleParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the results of the autoscale evaluation.", + "schema": { + "$ref": "#/definitions/AutoScaleRun" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/resize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_Resize", + "x-ms-examples": { + "Pool resize": { "$ref": "./examples/PoolResize.json" } + }, + "summary": "Changes the number of compute nodes that are assigned to a pool.", + "description": "You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to resize." + }, + { + "name": "poolResizeParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolResizeParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/stopresize": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_StopResize", + "x-ms-examples": { + "Pool stop resize": { "$ref": "./examples/PoolStopResize.json" } + }, + "summary": "Stops an ongoing resize operation on the pool.", + "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool whose resizing you want to stop." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service. If you call this API on a pool which is not in the resizing state, the request fails with HTTP status code 409.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/updateproperties": { + "post": { + "tags": [ + "Pools" + ], + "operationId": "Pool_UpdateProperties", + "x-ms-examples": { + "Pool update": { "$ref": "./examples/PoolUpdate.json" } + }, + "summary": "Updates the properties of the specified pool.", + "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool to update." + }, + { + "name": "poolUpdatePropertiesParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdatePropertiesParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/removenodes": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "Pool_RemoveNodes", + "x-ms-examples": { + "Pool remove nodes": { "$ref": "./examples/PoolRemoveNodes.json" } + }, + "summary": "Removes compute nodes from the specified pool.", + "description": "This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool from which you want to remove nodes." + }, + { + "name": "nodeRemoveParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeRemoveParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Add", + "x-ms-examples": { + "Add a basic task": { "$ref": "./examples/TaskAdd_Basic.json" }, + "Add a task with exit conditions": { "$ref": "./examples/TaskAdd_ExitConditions.json" }, + "Add a task with container settings": { "$ref": "./examples/TaskAdd_ContainerSettings.json" } + }, + "summary": "Adds a task to the specified job.", + "description": "The maximum lifetime of a task from addition to completion is 180 days. If a task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to which the task is to be added." + }, + { + "name": "task", + "in": "body", + "description": "The task to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "Task_List", + "x-ms-examples": { + "Task list": { "$ref": "./examples/TaskList.json" } + }, + "summary": "Lists all of the tasks that are associated with the specified job.", + "description": "For multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-tasks.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 tasks can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of tasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/addtaskcollection": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_AddCollection", + "x-ms-examples": { + "Add a basic collection of tasks": { "$ref": "./examples/TaskAddCollection_Basic.json" }, + "Add a complex collection of tasks": { "$ref": "./examples/TaskAddCollection_Complex.json" } + }, + "summary": "Adds a collection of tasks to the specified job.", + "description": "Note that each task must have a unique ID. The Batch service may not return the results for each task in the same order the tasks were submitted in this request. If the server times out or the connection is closed during the request, the request may have been partially or fully processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same task IDs during a retry so that if the prior operation succeeded, the retry will not create extra tasks unexpectedly. If the response contains any tasks which failed to add, a client can retry the request. In a retry, it is most efficient to resubmit only tasks that failed to add, and to omit tasks that were successfully added on the first attempt. The maximum lifetime of a task from addition to completion is 180 days. If a task has not completed within 180 days of being added it will be terminated by the Batch service and left in whatever state it was in at that time.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job to which the task collection is to be added." + }, + { + "name": "taskCollection", + "in": "body", + "description": "The tasks to be added.", + "required": true, + "schema": { + "$ref": "#/definitions/TaskAddCollectionParameter" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/TaskAddCollectionResult" + }, + "description": "A response containing the results of the add task collection operation." + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}": { + "delete": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Delete", + "x-ms-examples": { + "Task delete": { "$ref": "./examples/TaskDelete.json" } + }, + "summary": "Deletes a task from the specified job.", + "description": "When a task is deleted, all of the files in its directory on the compute node where it ran are also deleted (regardless of the retention time). For multi-instance tasks, the delete task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job from which to delete the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Get", + "x-ms-examples": { + "Task get": { "$ref": "./examples/TaskGet.json" } + }, + "summary": "Gets information about the specified task.", + "description": "For multi-instance tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary task. Use the list subtasks API to retrieve information about subtasks.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job that contains the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $expand clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "A response containing the task.", + "schema": { + "$ref": "#/definitions/CloudTask" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Update", + "x-ms-examples": { + "Task update": { "$ref": "./examples/TaskUpdate.json" } + }, + "description": "Updates the properties of the specified task.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job containing the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task to update." + }, + { + "name": "taskUpdateParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TaskUpdateParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/subtasksinfo": { + "get": { + "tags": [ + "Tasks" + ], + "operationId": "Task_ListSubtasks", + "x-ms-examples": { + "Task list subtasks": { "$ref": "./examples/TaskListSubtasks.json" } + }, + "summary": "Lists all of the subtasks that are associated with the specified multi-instance task.", + "description": "If the task is not a multi-instance task then this returns an empty collection.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of subtasks.", + "schema": { + "$ref": "#/definitions/CloudTaskListSubtasksResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/terminate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Terminate", + "x-ms-examples": { + "Task terminate": { "$ref": "./examples/TaskTerminate.json" } + }, + "summary": "Terminates the specified task.", + "description": "When the task has been terminated, it moves to the completed state. For multi-instance tasks, the terminate task operation applies synchronously to the primary task; subtasks are then terminated asynchronously in the background.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job containing the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task to terminate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/jobs/{jobId}/tasks/{taskId}/reactivate": { + "post": { + "tags": [ + "Tasks" + ], + "operationId": "Task_Reactivate", + "x-ms-examples": { + "Task reactivate": { "$ref": "./examples/TaskReactivate.json" } + }, + "summary": "Reactivates a task, allowing it to run again even if its retry count has been exhausted.", + "description": "Reactivation makes a task eligible to be retried again up to its maximum retry count. The task's state is changed to active. As the task is no longer in the completed state, any previous exit code or failure information is no longer available after reactivation. Each time a task is reactivated, its retry count is reset to 0. Reactivation will fail for tasks that are not completed or that previously completed successfully (with an exit code of 0). Additionally, it will fail if the job has completed (or is terminating or deleting).", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "jobId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the job containing the task." + }, + { + "name": "taskId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the task to reactivate." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service exactly matches the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource's current ETag on the service does not match the value specified by the client.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Modified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "If-Unmodified-Since", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_AddUser", + "x-ms-examples": { + "Node add user": { "$ref": "./examples/NodeAddUser.json" } + }, + "summary": "Adds a user account to the specified compute node.", + "description": "You can add a user account to a node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to create a user account." + }, + { + "name": "user", + "in": "body", + "description": "The user account to be created.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeNodeUser" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/users/{userName}": { + "delete": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DeleteUser", + "x-ms-examples": { + "Node delete user": { "$ref": "./examples/NodeDeleteUser.json" } + }, + "summary": "Deletes a user account from the specified compute node.", + "description": "You can delete a user account to a node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to delete a user account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user account to delete." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + }, + "put": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UpdateUser", + "x-ms-examples": { + "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } + }, + "summary": "Updates the password and expiration time of a user account on the specified compute node.", + "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the machine on which you want to update a user account." + }, + { + "name": "userName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user account to update." + }, + { + "name": "nodeUpdateUserParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NodeUpdateUserParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Get", + "x-ms-examples": { + "Node get": { "$ref": "./examples/NodeGet_Basic.json" } + }, + "summary": "Gets information about the specified compute node.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node that you want to get information about." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the compute node.", + "schema": { + "$ref": "#/definitions/ComputeNode" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reboot": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reboot", + "x-ms-examples": { + "Node reboot": { "$ref": "./examples/NodeReboot.json" } + }, + "summary": "Restarts the specified compute node.", + "description": "You can restart a node only if it is in an idle or running state.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node that you want to restart." + }, + { + "name": "nodeRebootParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeRebootParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/reimage": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_Reimage", + "x-ms-examples": { + "Node reimage": { "$ref": "./examples/NodeReimage.json" } + }, + "summary": "Reinstalls the operating system on the specified compute node.", + "description": "You can reinstall the operating system on a node only if it is in an idle or running state. This API can be invoked only on pools created with the cloud service configuration property.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node that you want to restart." + }, + { + "name": "nodeReimageParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeReimageParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/disablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_DisableScheduling", + "x-ms-examples": { + "Node disable scheduling": { "$ref": "./examples/NodeDisableScheduling.json" } + }, + "summary": "Disables task scheduling on the specified compute node.", + "description": "You can disable task scheduling on a node only if its current scheduling state is enabled.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node on which you want to disable task scheduling." + }, + { + "name": "nodeDisableSchedulingParameter", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/NodeDisableSchedulingParameter" + }, + "description": "The parameters for the request." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/enablescheduling": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_EnableScheduling", + "x-ms-examples": { + "Node enable scheduling": { "$ref": "./examples/NodeEnableScheduling.json" } + }, + "summary": "Enables task scheduling on the specified compute node.", + "description": "You can enable task scheduling on a node only if its current scheduling state is disabled", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node on which you want to enable task scheduling." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + }, + "DataServiceId": { + "description": "The OData ID of the resource to which the request applied.", + "type": "string" + } + }, + "description": "The request to the Batch service was successful." + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/remoteloginsettings": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteLoginSettings", + "x-ms-examples": { + "Node get remote login settings": { "$ref": "./examples/NodeGetRemoteLoginSettings.json" } + }, + "summary": "Gets the settings required for remote login to a compute node.", + "description": "Before you can remotely login to a node using the remote login settings, you must create a user account on the node. This API can be invoked only on pools created with the virtual machine configuration property. For pools created with a cloud service configuration, see the GetRemoteDesktop API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node for which to obtain the remote login settings." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the login settings.", + "schema": { + "$ref": "#/definitions/ComputeNodeGetRemoteLoginSettingsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/rdp": { + "get": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_GetRemoteDesktop", + "x-ms-examples": { + "Get RDP file of the compute node": { "$ref": "./examples/NodeGetRemoteDesktop.json" } + }, + "summary": "Gets the Remote Desktop Protocol file for the specified compute node.", + "description": "Before you can access a node by using the RDP file, you must create a user account on the node. This API can only be invoked on pools created with a cloud service configuration. For pools created with a virtual machine configuration, see the GetRemoteLoginSettings API.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node for which you want to get the Remote Desktop Protocol file." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json", + "application/octet-stream" + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the RDP information.", + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes/{nodeId}/uploadbatchservicelogs": { + "post": { + "tags": [ + "ComputeNodes" + ], + "operationId": "ComputeNode_UploadBatchServiceLogs", + "summary": "Upload Azure Batch service log files from the specified compute node to Azure Blob Storage.", + "description": "This is for gathering Azure Batch service log files in an automated fashion from nodes if you are experiencing an error and wish to escalate to Azure support. The Azure Batch service log files should be shared with Azure support to aid in debugging issues with the Batch service.", + "x-ms-examples": { + "Upload BatchService Logs": { "$ref": "./examples/NodeUploadBatchServiceLogs.json" } + }, + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool that contains the compute node." + }, + { + "name": "nodeId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the compute node from which you want to upload the Azure Batch service log files." + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "uploadBatchServiceLogsConfiguration", + "in": "body", + "description": "The Azure Batch service log files upload configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + } + }, + "description": "The request to the Batch service was successful.", + "schema": { + "$ref": "#/definitions/UploadBatchServiceLogsResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + }, + "/pools/{poolId}/nodes": { + "get": { + "tags": [ + "ComputeNodes" + ], + "x-ms-pageable": { + "nextLinkName": "odata.nextLink" + }, + "operationId": "ComputeNode_List", + "x-ms-examples": { + "Node list": { "$ref": "./examples/NodeList.json" } + }, + "summary": "Lists the compute nodes in the specified pool.", + "x-ms-request-id": "request-id", + "parameters": [ + { + "name": "poolId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the pool from which you want to list nodes." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $filter clause. For more information on constructing this filter, see https://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-nodes-in-a-pool.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "An OData $select clause.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "maxresults", + "x-ms-client-name": "maxResults", + "default": 1000, + "minimum": 1, + "maximum": 1000, + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response. A maximum of 1000 nodes can be returned.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "timeout", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "default": 30, + "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.", + "x-ms-parameter-grouping": { + "postfix": "Options" + }, + "x-ms-client-request-id": true + }, + { + "name": "return-client-request-id", + "default": false, + "in": "header", + "required": false, + "type": "boolean", + "description": "Whether the server should return the client-request-id in the response.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "name": "ocp-date", + "in": "header", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "description": "The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "headers": { + "client-request-id": { + "description": "The client-request-id provided by the client during the request. This will be returned only if the return-client-request-id parameter was set to true.", + "type": "string", + "format": "uuid" + }, + "request-id": { + "description": "A unique identifier for the request that was made to the Batch service. If a request is consistently failing and you have verified that the request is properly formulated, you may use this value to report the error to Microsoft. In your report, include the value of this request ID, the approximate time that the request was made, the Batch account against which the request was made, and the region that account resides in.", + "type": "string", + "format": "uuid" + }, + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Modified-Since, If-Unmodified-Since, If-Match or If-None-Match headers.", + "type": "string" + }, + "Last-Modified": { + "description": "The time at which the resource was last modified.", + "type": "string", + "format": "date-time-rfc1123" + } + }, + "description": "A response containing the list of nodes.", + "schema": { + "$ref": "#/definitions/ComputeNodeListResult" + } + }, + "default": { + "description": "The error from the Batch service.", + "schema": { + "$ref": "#/definitions/BatchError" + } + } + } + } + } + }, + "definitions": { + "PoolUsageMetrics": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the pool whose metrics are aggregated in this entry." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the aggregation interval covered by this entry." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end time of the aggregation interval covered by this entry." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", + "description": "For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalCoreHours": { + "type": "number", + "format": "double", + "title": "The total core hours used in the pool during this aggregation interval." + } + }, + "required": [ "poolId", "startTime", "endTime", "vmSize", "totalCoreHours" ], + "title": "Usage metrics for a pool across an aggregation interval." + }, + "PoolListUsageMetricsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolUsageMetrics" + }, + "title": "The pool usage metrics data." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of a listing the usage metrics for an account." + }, + "NodeAgentSku": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the node agent SKU." + }, + "verifiedImageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageReference" + }, + "title": "The list of Azure Marketplace images verified to be compatible with this node agent SKU.", + "description": "This collection is not exhaustive (the node agent may be compatible with other images)." + }, + "osType": { + "type": "string", + "title": "The type of operating system (e.g. Windows or Linux) compatible with the node agent SKU.", + "enum": [ + "linux", + "windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": false, + "values": [ + { + "value": "linux", + "description": "The Linux operating system." + }, + { + "value": "windows", + "description": "The Windows operating system." + } + ] + } + } + }, + "title": "A node agent SKU supported by the Batch service.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems." + }, + "AuthenticationTokenSettings": { + "properties": { + "access": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "job" + ], + "x-ms-enum": { + "name": "AccessScope", + "modelAsString": false, + "values": [ + { + "value": "job", + "description": "Grants access to perform all operations on the job containing the task." + } + ] + } + }, + "title": "The Batch resources to which the token grants access.", + "description": "The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is 'job', which grants access to all operations related to the job which contains the task." + } + }, + "title": "The settings for an authentication token that the task can use to perform Batch service operations." + }, + "AccountListNodeAgentSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeAgentSku" + }, + "title": "The list of supported node agent SKUs." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the supported node agent SKUs." + }, + "UsageStatistics": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "dedicatedCoreTime": { + "type": "string", + "format": "duration", + "title": "The aggregated wall-clock time of the dedicated compute node cores being part of the pool." + } + }, + "required": [ "startTime", "lastUpdateTime", "dedicatedCoreTime" ], + "title": "Statistics related to pool usage information." + }, + "ResourceStatistics": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "avgCPUPercentage": { + "type": "number", + "format": "double", + "title": "The average CPU usage across all nodes in the pool (percentage per node)." + }, + "avgMemoryGiB": { + "type": "number", + "format": "double", + "title": "The average memory usage in GiB across all nodes in the pool." + }, + "peakMemoryGiB": { + "type": "number", + "format": "double", + "title": "The peak memory usage in GiB across all nodes in the pool." + }, + "avgDiskGiB": { + "type": "number", + "format": "double", + "title": "The average used disk space in GiB across all nodes in the pool." + }, + "peakDiskGiB": { + "type": "number", + "format": "double", + "title": "The peak used disk space in GiB across all nodes in the pool." + }, + "diskReadIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations across all nodes in the pool." + }, + "diskWriteIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations across all nodes in the pool." + }, + "diskReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk reads across all nodes in the pool." + }, + "diskWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of disk writes across all nodes in the pool." + }, + "networkReadGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network reads across all nodes in the pool." + }, + "networkWriteGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB of network writes across all nodes in the pool." + } + }, + "required": [ "startTime", "lastUpdateTime", "avgCPUPercentage", "avgMemoryGiB", "peakMemoryGiB", "avgDiskGiB", "peakDiskGiB", "diskReadIOps", "diskWriteIOps", "diskReadGiB", "diskWriteGiB", "networkReadGiB", "networkWriteGiB" ], + "title": "Statistics related to resource consumption by compute nodes in a pool." + }, + "PoolStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL for the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "usageStats": { + "$ref": "#/definitions/UsageStatistics", + "title": "Statistics related to pool usage, such as the amount of core-time used." + }, + "resourceStats": { + "$ref": "#/definitions/ResourceStatistics", + "title": "Statistics related to resource consumption by compute nodes in the pool." + } + }, + "required": [ "url", "startTime", "lastUpdateTime" ], + "title": "Contains utilization and resource usage statistics for the lifetime of a pool." + }, + "JobStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all tasks in the job.", + "description": " The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all tasks in the job." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all tasks in the job." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB read from disk by all tasks in the job." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total amount of data in GiB written to disk by all tasks in the job." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of tasks successfully completed in the job during the given time range.", + "description": "A task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of tasks in the job that failed during the given time range.", + "description": "A task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries on all the tasks in the job during the given time range." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all tasks in the job.", + "description": "The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.) This value is only reported in the account lifetime statistics; it is not included in the job statistics." + } + }, + "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "numSucceededTasks", "numFailedTasks", "numTaskRetries", "waitTime" ], + "title": "Resource usage statistics for a job." + }, + "NameValuePair": { + "properties": { + "name": { + "type": "string", + "title": "The name in the name-value pair." + }, + "value": { + "type": "string", + "title": "The value in the name-value pair." + } + }, + "title": "Represents a name-value pair." + }, + "DeleteCertificateError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the certificate deletion error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the certificate deletion error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the certificate deletion error.", + "description": "This list includes details such as the active pools and nodes referencing this certificate. However, if a large number of resources reference the certificate, the list contains only about the first hundred." + } + }, + "title": "An error encountered by the Batch service when deleting a certificate." + }, + "Certificate": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint." + }, + "url": { + "type": "string", + "title": "The URL of the certificate." + }, + "state": { + "title": "The current state of the certificate.", + "$ref": "#/definitions/CertificateState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its current state." + }, + "previousState": { + "title": "The previous state of the certificate.", + "description": "This property is not set if the certificate is in its initial active state.", + "$ref": "#/definitions/CertificateState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its previous state.", + "description": "This property is not set if the certificate is in its initial Active state." + }, + "publicData": { + "type": "string", + "title": "The public part of the certificate as a base-64 encoded .cer file." + }, + "deleteCertificateError": { + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error that occurred on the last attempt to delete this certificate.", + "description": "This property is set only if the certificate is in the DeleteFailed state." + } + }, + "description": "A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine." + }, + "ApplicationPackageReference": { + "properties": { + "applicationId": { + "type": "string", + "title": "The ID of the application to deploy." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted on a pool, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences and HTTP status code 409. If this is omitted on a task, and no default version is specified for this application, the task fails with a pre-processing error." + } + }, + "required": [ "applicationId" ], + "title": "A reference to an application package to be deployed to compute nodes." + }, + "ApplicationSummary": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the application within the account." + }, + "displayName": { + "type": "string", + "title": "The display name for the application." + }, + "versions": { + "type": "array", + "title": "The list of available versions of the application.", + "items": { + "type": "string" + } + } + }, + "required": [ "id", "displayName", "versions" ], + "title": "Contains information about an application in an Azure Batch account." + }, + "CertificateAddParameter": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed)." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm used to derive the thumbprint. This must be sha1." + }, + "data": { + "type": "string", + "title": "The base64-encoded contents of the certificate. The maximum size is 10KB." + }, + "certificateFormat": { + "type": "string", + "title": "The format of the certificate data.", + "enum": [ + "pfx", + "cer" + ], + "x-ms-enum": { + "name": "CertificateFormat", + "modelAsString": false, + "values": [ + { + "value": "pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] + } + }, + "password": { + "type": "string", + "title": "The password to access the certificate's private key.", + "description": "This is required if the certificate format is pfx. It should be omitted if the certificate format is cer." + } + }, + "required": [ "thumbprint", "thumbprintAlgorithm", "data" ], + "title": "A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine." + }, + "CertificateListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "title": "The list of certificates." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the certificates in the account." + }, + "FileProperties": { + "properties": { + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The file creation time.", + "description": "The creation time is not returned for files on Linux compute nodes." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The time at which the file was last modified." + }, + "contentLength": { + "type": "integer", + "format": "int64", + "title": "The length of the file." + }, + "contentType": { + "type": "string", + "title": "The content type of the file." + }, + "fileMode": { + "type": "string", + "title": "The file mode attribute in octal format.", + "description": "The file mode is returned only for files on Linux compute nodes." + } + }, + "required": [ "lastModified", "contentLength" ], + "title": "The properties of a file on a compute node." + }, + "NodeFile": { + "properties": { + "name": { + "type": "string", + "title": "The file path." + }, + "url": { + "type": "string", + "title": "The URL of the file." + }, + "isDirectory": { + "type": "boolean", + "title": "Whether the object represents a directory." + }, + "properties": { + "$ref": "#/definitions/FileProperties", + "title": "The file properties." + } + }, + "title": "Information about a file or directory on a compute node." + }, + "NodeFileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NodeFile" + }, + "title": "The list of files." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the files on a compute node, or the files associated with a task on a node." + }, + "Schedule": { + "properties": { + "doNotRunUntil": { + "type": "string", + "format": "date-time", + "title": "The earliest time at which any job may be created under this job schedule.", + "description": "If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately." + }, + "doNotRunAfter": { + "type": "string", + "format": "date-time", + "title": "A time after which no job will be created under this job schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active job under this job schedule.", + "description": "If you do not specify a doNotRunAfter time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it." + }, + "startWindow": { + "type": "string", + "format": "duration", + "title": "The time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created.", + "description": "If a job is not created within the startWindow interval, then the 'opportunity' is lost; no job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the job that is 'due' in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "recurrenceInterval": { + "type": "string", + "format": "duration", + "title": "The time interval between the start times of two successive jobs under the job schedule. A job schedule can have at most one active job under it at any given time.", + "description": "Because a job schedule can have at most one active job under it at any given time, if it is time to create a new job under a job schedule, but the previous job is still running, the Batch service will not create the new job until the previous job finishes. If the previous job does not finish within the startWindow period of the new recurrenceInterval, then no new job will be scheduled for that interval. For recurring jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when jobs are created, add tasks to the jobs and terminate the jobs ready for the next recurrence. The default is that the schedule does not recur: one job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "title": "The schedule according to which jobs will be created" + }, + "JobConstraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the job may run, measured from the time the job is created.", + "description": "If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the job may run." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries. The Batch service will try each task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry tasks. If the maximum retry count is -1, the Batch service retries tasks without limit. The default value is 0 (no retries)." + } + }, + "title": "The execution constraints for a job." + }, + "JobNetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which nodes running tasks from the job will join for the duration of the task.", + "description": "This is only supported for jobs running on VirtualMachineConfiguration pools. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes which will run tasks from the job. For more details, see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration." + } + }, + "required": [ "subnetId" ], + "title": "The network configuration for the job." + }, + "TaskContainerSettings": { + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The image to use to create the container in which the task will run.", + "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container image.", + "description": "This setting can be omitted if was already provided at pool creation." + } + }, + "required": [ "imageName" ], + "title": "The container settings for a task." + }, + "ResourceFile": { + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading blobs from the container. There are two ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the container, or set the ACL for the container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the compute node to which to download the file(s), relative to the task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." + } + }, + "title": "A single file or multiple files to be downloaded to a compute node." + }, + "EnvironmentSetting": { + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable." + } + }, + "required": [ "name" ], + "title": "An environment variable to be set on a task process." + }, + "ExitConditions": { + "properties": { + "exitCodes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeMapping" + }, + "title": "A list of individual task exit codes and how the Batch service should respond to them." + }, + "exitCodeRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ExitCodeRangeMapping" + }, + "title": "A list of task exit code ranges and how the Batch service should respond to them." + }, + "preProcessingError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the task fails to start due to an error." + }, + "fileUploadError": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if a file upload error occurs.", + "description": "If the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence." + }, + "default": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties.", + "description": "This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behavior on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection." + } + }, + "title": "Specifies how the Batch service should respond when the task completes." + }, + "ExitCodeMapping": { + "properties": { + "code": { + "type": "integer", + "format": "int32", + "title": "A process exit code." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the task exits with this exit code." + } + }, + "title": "How the Batch service should respond if a task exits with a particular exit code.", + "required": [ "code", "exitOptions" ] + }, + "ExitCodeRangeMapping": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first exit code in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last exit code in the range." + }, + "exitOptions": { + "$ref": "#/definitions/ExitOptions", + "title": "How the Batch service should respond if the task exits with an exit code in the range start to end (inclusive)." + } + }, + "title": "A range of exit codes and how the Batch service should respond to exit codes within that range.", + "required": [ "start", "end", "exitOptions" ] + }, + "ExitOptions": { + "properties": { + "jobAction": { + "type": "string", + "title": "An action to take on the job containing the task, if the task completes with the given exit condition and the job's onTaskFailed property is 'performExitOptionsJobAction'.", + "description": "The default is none for exit code 0 and terminate for all other exit conditions. If the job's onTaskFailed property is noaction, then specifying this property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "enum": [ + "none", + "disable", + "terminate" + ], + "x-ms-enum": { + "name": "JobAction", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "Take no action." + }, + { + "value": "disable", + "description": "Disable the job. This is equivalent to calling the disable job API, with a disableTasks value of requeue." + }, + { + "value": "terminate", + "description": "Terminate the job. The terminateReason in the job's executionInfo is set to \"TaskFailed\"." + } + ] + } + }, + "dependencyAction": { + "type": "string", + "title": "An action that the Batch service performs on tasks that depend on this task.", + "description": "The default is 'satisfy' for exit code 0, and 'block' for all other exit conditions. If the job's usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error and the add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "enum": [ + "satisfy", + "block" + ], + "x-ms-enum": { + "name": "DependencyAction", + "modelAsString": false, + "values": [ + { + "value": "satisfy", + "description": "Satisfy the task's dependencies." + }, + { + "value": "block", + "description": "Block the task's dependencies." + } + ] + } + } + }, + "title": "Specifies how the Batch service responds to a particular exit condition." + }, + "AutoUserSpecification": { + "properties": { + "scope": { + "type": "string", + "title": "The scope for the auto user", + "description": "The default value is task.", + "enum": [ + "task", + "pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "value": "task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] + } + }, + "elevationLevel": { + "title": "The elevation level of the auto user.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + } + }, + "title": "Specifies the parameters for the auto user that runs a task on the Batch service." + }, + "UserIdentity": { + "properties": { + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The name of the user identity under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + }, + "title": "The definition of the user identity under which the task is run.", + "description": "Specify either the userName or autoUser property, but not both." + }, + "LinuxUserConfiguration": { + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "title": "The SSH private key for the user account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done)." + } + }, + "title": "Properties used to create a user account on a Linux node." + }, + "WindowsUserConfiguration": { + "properties": { + "loginMode": { + "type": "string", + "title": "The login mode for the user.", + "description": "The default value for VirtualMachineConfiguration pools is batch and for CloudServiceConfiguration pools is interactive.", + "enum": [ + "batch", + "interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "value": "batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "value": "interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. UAC is enabled on Windows VirtualMachineConfiguration pools. If this option is used with an elevated user identity in a Windows VirtualMachineConfiguration pool, the user session will not be elevated unless the application executed by the task command line is configured to always require administrative privilege or to always require maximum privilege." + } + ] + } + } + }, + "title": "Properties used to create a user account on a Windows node." + }, + "UserAccount": { + "properties": { + "name": { + "type": "string", + "title": "The name of the user account." + }, + "password": { + "type": "string", + "title": "The password for the user account." + }, + "elevationLevel": { + "title": "The elevation level of the user account.", + "description": "The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + }, + "linuxUserConfiguration": { + "title": "The Linux-specific user configuration for the user account.", + "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.", + "$ref": "#/definitions/LinuxUserConfiguration" + }, + "windowsUserConfiguration": { + "title": "The Windows-specific user configuration for the user account.", + "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.", + "$ref": "#/definitions/WindowsUserConfiguration" + } + }, + "required": [ "name", "password" ], + "title": "Properties used to create a user used to execute tasks on an Azure Batch node." + }, + "TaskConstraints": { + "properties": { + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it.", + "description": "If this is not specified, there is no time limit on how long the task may run." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the task directory on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the task directory and all its contents.", + "description": "The default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero.", + "description": "Note that this value specifically controls the number of retries for the task executable due to a nonzero exit code. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task after the first attempt. If the maximum retry count is -1, the Batch service retries the task without limit." + } + }, + "title": "Execution constraints to apply to a task." + }, + "JobManagerTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Manager task within the job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "The display name of the Job Manager task.", + "description": "It need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Manager task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Manager task runs.", + "description": "If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "description": "Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the compute node after running the command line.", + "description": "For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Manager task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Manager task." + }, + "killJobOnCompletion": { + "type": "boolean", + "title": "Whether completion of the Job Manager task signifies completion of the entire job.", + "description": "If true, when the Job Manager task completes, the Batch service marks the job as complete. If any tasks are still running at this time (other than Job Release), those tasks are terminated. If false, the completion of the Job Manager task does not affect the job status. In this case, you should either use the onAllTasksComplete attribute to terminate the job, or have a client or user terminate the job explicitly. An example of this is if the Job Manager creates a set of tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control job lifetime, and using the Job Manager task only to create the tasks for the job (not to monitor progress), then it is important to set killJobOnCompletion to false." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Manager task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "runExclusive": { + "type": "boolean", + "title": "Whether the Job Manager task requires exclusive use of the compute node where it runs.", + "description": "If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. The Job Manager task counts normally against the node's concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks. The default value is true." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + }, + "allowLowPriorityNode": { + "type": "boolean", + "title": "Whether the Job Manager task may run on a low-priority compute node.", + "description": "The default value is true." + } + }, + "required": [ "id", "commandLine" ], + "title": "Specifies details of a Job Manager task.", + "description": "The Job Manager task is automatically started when the job is created. The Batch service tries to schedule the Job Manager task before any other tasks in the job. When shrinking a pool, the Batch service tries to preserve compute nodes where Job Manager tasks are running for as long as possible (that is, nodes running 'normal' tasks are removed before nodes running Job Manager tasks). When a Job Manager task fails and needs to be restarted, the system tries to schedule it at the highest priority. If there are no idle nodes available, the system may terminate one of the running tasks in the pool and return it to the queue in order to make room for the Job Manager task to restart. Note that a Job Manager task in one job does not have priority over tasks in other jobs. Across jobs, only job level priorities are observed. For example, if a Job Manager in a priority 0 job needs to be restarted, it will not displace tasks of a priority 1 job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." + }, + "JobPreparationTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Preparation task within the job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other task in the job can have the same ID as the Job Preparation task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Preparation task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Preparation task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "description": "Files listed under this element are located in the task's working directory. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Preparation task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to the Job Preparation task." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the Job Preparation task to complete successfully before scheduling any other tasks of the job on the compute node. A Job Preparation task has completed successfully if it exits with exit code 0.", + "description": "If true and the Job Preparation task fails on a compute node, the Batch service retries the Job Preparation task up to its maximum retry count (as specified in the constraints element). If the task has still not completed successfully after all retries, then the Batch service will not schedule tasks of the job to the compute node. The compute node remains active and eligible to run tasks of other jobs. If false, the Batch service will not wait for the Job Preparation task to complete. In this case, other tasks of the job can start executing on the compute node while the Job Preparation task is still running; and even if the Job Preparation task fails, new tasks will continue to be scheduled on the node. The default value is true." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Preparation task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + }, + "rerunOnNodeRebootAfterSuccess": { + "type": "boolean", + "title": "Whether the Batch service should rerun the Job Preparation task after a compute node reboots.", + "description": "The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. The default value is true." + } + }, + "required": [ "commandLine" ], + "title": "A Job Preparation task to run before any tasks of the job on any given compute node.", + "description": "You can use Job Preparation to prepare a compute node to run tasks for the job. Activities commonly performed in Job Preparation include: Downloading common resource files used by all the tasks in the job. The Job Preparation task can download these common resource files to the shared location on the compute node. (AZ_BATCH_NODE_ROOT_DIR\\shared), or starting a local service on the compute node so that all tasks of that job can communicate with it. If the Job Preparation task fails (that is, exhausts its retry count before exiting with exit code 0), Batch will not run tasks of this job on the compute node. The node remains ineligible to run tasks of this job until it is reimaged. The node remains active and can be used for other jobs. The Job Preparation task can run multiple times on the same compute node. Therefore, you should write the Job Preparation task to handle re-execution. If the compute node is rebooted, the Job Preparation task is run again on the node before scheduling any other task of the job, if rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did not previously complete. If the compute node is reimaged, the Job Preparation task is run again before scheduling any task of the job. Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." + }, + "JobReleaseTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the Job Release task within the job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other task in the job can have the same ID as the Job Release task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict)." + }, + "commandLine": { + "type": "string", + "title": "The command line of the Job Release task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the Job Release task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the Job Release task." + }, + "maxWallClockTime": { + "type": "string", + "format": "duration", + "title": "The maximum elapsed time that the Job Release task may run on a given compute node, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "retentionTime": { + "type": "string", + "format": "duration", + "title": "The minimum time to retain the task directory for the Job Release task on the compute node. After this time, the Batch service may delete the task directory and all its contents.", + "description": "The default is 7 days, i.e. the task directory will be retained for 7 days unless the compute node is removed or the job is deleted." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the Job Release task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + } + }, + "required": [ "commandLine" ], + "title": "A Job Release task to run on job completion on any compute node where the job has run.", + "description": "The Job Release task runs when the job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the job is still active, the job's maximum wall clock time constraint is reached, and the job is still active, or the job's Job Manager task completed, and the job is configured to terminate when the Job Manager completes. The Job Release task runs on each compute node where tasks of the job have run and the Job Preparation task ran and completed. If you reimage a compute node after it has run the Job Preparation task, and the job ends without any further tasks of the job running on that compute node (and hence the Job Preparation task does not re-run), then the Job Release task does not run on that node. If a compute node reboots while the Job Release task is still running, the Job Release task runs again when the compute node starts up. The job is not marked as complete until all Job Release tasks have completed. The Job Release task runs in the background. It does not occupy a scheduling slot; that is, it does not count towards the maxTasksPerNode limit specified on the pool." + }, + "TaskSchedulingPolicy": { + "properties": { + "nodeFillType": { + "type": "string", + "title": "How tasks are distributed across compute nodes in a pool.", + "enum": [ + "spread", + "pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "pack", + "description": "As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] + } + } + }, + "required": [ "nodeFillType" ], + "title": "Specifies how tasks should be distributed across compute nodes." + }, + "StartTask": { + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the start task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the start task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers.", + "description": "Files listed under this element are located in the task's working directory." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the start task." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the start task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the task may be retried.", + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", + "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and failure info details. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false." + } + }, + "required": [ "commandLine" ], + "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.", + "description": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." + }, + "CertificateReference": { + "properties": { + "thumbprint": { + "type": "string", + "title": "The thumbprint of the certificate." + }, + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm with which the thumbprint is associated. This must be sha1." + }, + "storeLocation": { + "type": "string", + "title": "The location of the certificate store on the compute node into which to install the certificate.", + "description": "The default value is currentuser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "enum": [ + "currentuser", + "localmachine" + ], + "x-ms-enum": { + "name": "CertificateStoreLocation", + "modelAsString": false, + "values": [ + { + "value": "currentuser", + "description": "Certificates should be installed to the CurrentUser certificate store.", + "name": "currentUser" + }, + { + "value": "localmachine", + "description": "Certificates should be installed to the LocalMachine certificate store.", + "name": "localMachine" + } + ] + } + }, + "storeName": { + "type": "string", + "title": "The name of the certificate store on the compute node into which to install the certificate.", + "description": "This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My." + }, + "visibility": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "starttask", + "task", + "remoteuser" + ], + "x-ms-enum": { + "name": "CertificateVisibility", + "modelAsString": false, + "values": [ + { + "value": "starttask", + "description": "The certificate should be visible to the user account under which the start task is run.", + "name": "startTask" + }, + { + "value": "task", + "description": "The certificate should be visible to the user accounts under which job tasks are run." + }, + { + "value": "remoteuser", + "description": "The certificate should be visible to the user accounts under which users remotely access the node.", + "name": "remoteUser" + } + ] + } + }, + "title": "Which user accounts on the compute node should have access to the private data of the certificate.", + "description": "You can specify more than one visibility in this collection. The default is all accounts." + } + }, + "required": [ "thumbprint", "thumbprintAlgorithm" ], + "title": "A reference to a certificate to be installed on compute nodes in a pool." + }, + "MetadataItem": { + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item." + } + }, + "required": [ "name", "value" ], + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." + }, + "PoolSpecification": { + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machines in the pool. All virtual machines in a pool are the same size.", + "description": "For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property must be specified if the pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property must be specified if the pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "maxTasksPerNode": { + "type": "integer", + "format": "int32", + "title": "The maximum number of tasks that can run concurrently on a single compute node in the pool.", + "description": "The default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting)." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the pool permits direct communication between nodes.", + "description": "Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail. The permitted licenses available on the pool are 'maya', 'vray', '3dsmax', 'arnold'. An additional charge applies for each application license added to the pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ "vmSize" ], + "title": "Specification for creating a new pool." + }, + "AutoPoolSpecification": { + "properties": { + "autoPoolIdPrefix": { + "type": "string", + "title": "A prefix to be added to the unique identifier when a pool is automatically created.", + "description": "The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long." + }, + "poolLifetimeOption": { + "type": "string", + "title": "The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools.", + "enum": [ + "jobschedule", + "job" + ], + "x-ms-enum": { + "name": "PoolLifetimeOption", + "modelAsString": false, + "values": [ + { + "value": "jobschedule", + "description": "The pool exists for the lifetime of the job schedule. The Batch Service creates the pool when it creates the first job on the schedule. You may apply this option only to job schedules, not to jobs.", + "name": "jobSchedule" + }, + { + "value": "job", + "description": "The pool exists for the lifetime of the job to which it is dedicated. The Batch service creates the pool when it creates the job. If the 'job' option is applied to a job schedule, the Batch service creates a new auto pool for every job created on the schedule." + } + ] + } + }, + "keepAlive": { + "type": "boolean", + "title": "Whether to keep an auto pool alive after its lifetime expires.", + "description": "If false, the Batch service deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If true, the Batch service does not delete the pool automatically. It is up to the user to delete auto pools created with this option." + }, + "pool": { + "$ref": "#/definitions/PoolSpecification", + "title": "The pool specification for the auto pool." + } + }, + "required": [ "poolLifetimeOption" ], + "title": "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted." + }, + "PoolInformation": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of an existing pool. All the tasks of the job will run on the specified pool.", + "description": "You must ensure that the pool referenced by this property exists. If the pool does not exist at the time the Batch service tries to schedule a job, no tasks for the job will run until you create a pool with that id. Note that the Batch service will not reject the job request; it will simply not run tasks until the pool exists. You must specify either the pool ID or the auto pool specification, but not both." + }, + "autoPoolSpecification": { + "$ref": "#/definitions/AutoPoolSpecification", + "title": "Characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted.", + "description": "If auto pool creation fails, the Batch service moves the job to a completed state, and the pool creation error is set in the job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto pool. Any user actions that affect the lifetime of the auto pool while the job is active will result in unexpected behavior. You must specify either the pool ID or the auto pool specification, but not both." + } + }, + "title": "Specifies how a job should be assigned to a pool." + }, + "JobSpecification": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of jobs created under this schedule.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all jobs under the job schedule. You can update a job's priority after it has been created using by using the update job API." + }, + "displayName": { + "type": "string", + "title": "The display name for jobs created under this schedule.", + "description": "The name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether tasks in the job can define dependencies on each other. The default is false." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all tasks in a job created under this schedule are in the completed state.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the job." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for jobs created under this schedule." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "The details of a Job Manager task to be launched when a job is started under this schedule.", + "description": "If the job does not specify a Job Manager task, the user must explicitly add tasks to the job using the Task API. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation task for jobs created under this schedule.", + "description": "If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release task for jobs created under this schedule.", + "description": "The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of common environment variable settings. These environment variables are set for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job Release tasks).", + "description": "Individual tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The pool on which the Batch service runs the tasks of jobs created under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with each job created under this schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ "poolInfo" ], + "title": "Specifies details of the jobs to be created on a schedule." + }, + "RecentJob": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the job." + }, + "url": { + "type": "string", + "title": "The URL of the job." + } + }, + "title": "Information about the most recent job to run under the job schedule." + }, + "JobScheduleExecutionInformation": { + "properties": { + "nextRunTime": { + "type": "string", + "format": "date-time", + "title": "The next time at which a job will be created under this schedule.", + "description": "This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no job will be created at nextRunTime unless the job is enabled before then." + }, + "recentJob": { + "$ref": "#/definitions/RecentJob", + "title": "Information about the most recent job under the job schedule.", + "description": "This property is present only if the at least one job has run under the schedule." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the schedule ended.", + "description": "This property is set only if the job schedule is in the completed state." + } + }, + "title": "Contains information about jobs that have been and will be run under a job schedule." + }, + "JobScheduleStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of all the tasks in all the jobs created under the schedule.", + "description": "The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by all tasks in all jobs created under the schedule." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by all tasks in all jobs created under the schedule." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by all tasks in all jobs created under the schedule." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by all tasks in all jobs created under the schedule." + }, + "numSucceededTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of tasks successfully completed during the given time range in jobs created under the schedule. A task completes successfully if it returns exit code 0." + }, + "numFailedTasks": { + "type": "integer", + "format": "int64", + "title": "The total number of tasks that failed during the given time range in jobs created under the schedule. A task fails if it exhausts its maximum retry count without returning exit code 0." + }, + "numTaskRetries": { + "type": "integer", + "format": "int64", + "title": "The total number of retries during the given time range on all tasks in all jobs created under the schedule." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of all tasks in all jobs created under the schedule. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.)", + "description": "This value is only reported in the account lifetime statistics; it is not included in the job statistics." + } + }, + "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "numSucceededTasks", "numFailedTasks", "numTaskRetries", "waitTime" ], + "title": "Resource usage statistics for a job schedule." + }, + "CloudJobSchedule": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the account." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule." + }, + "url": { + "type": "string", + "title": "The URL of the job schedule." + }, + "eTag": { + "type": "string", + "title": "The ETag of the job schedule.", + "description": "This is an opaque string. You can use it to detect whether the job schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the job schedule.", + "description": "This is the last time at which the schedule level data, such as the job specification or recurrence information, changed. It does not factor in job-level changes such as new jobs being created or jobs changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the job schedule." + }, + "state": { + "title": "The current state of the job schedule.", + "$ref": "#/definitions/JobScheduleState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the job schedule entered the current state." + }, + "previousState": { + "title": "The previous state of the job schedule.", + "description": "This property is not present if the job schedule is in its initial active state.", + "$ref": "#/definitions/JobScheduleState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the job schedule entered its previous state.", + "description": "This property is not present if the job schedule is in its initial active state." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the jobs to be created on this schedule." + }, + "executionInfo": { + "$ref": "#/definitions/JobScheduleExecutionInformation", + "title": "Information about jobs that have been and will be run under this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "stats": { + "$ref": "#/definitions/JobScheduleStatistics", + "title": "The lifetime resource usage statistics for the job schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job." + }, + "JobScheduleAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the schedule within the account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the schedule.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which jobs will be created." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the jobs to be created on this schedule." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the schedule as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ "id", "schedule", "jobSpecification" ], + "title": "A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job." + }, + "CloudJobScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJobSchedule" + }, + "title": "The list of job schedules." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the job schedules in an account." + }, + "JobSchedulingError": { + "properties": { + "category": { + "title": "The category of the job scheduling error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the job scheduling error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the job scheduling error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the scheduling error." + } + }, + "required": [ "category" ], + "title": "An error encountered by the Batch service when scheduling a job." + }, + "JobExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the job.", + "description": "This is the time at which the job was created." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The completion time of the job.", + "description": "This property is set only if the job is in the completed state." + }, + "poolId": { + "type": "string", + "title": "The ID of the pool to which this job is assigned.", + "description": "This element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the ID of that auto pool." + }, + "schedulingError": { + "$ref": "#/definitions/JobSchedulingError", + "title": "Details of any error encountered by the service in starting the job.", + "description": "This property is not set if there was no error starting the job." + }, + "terminateReason": { + "type": "string", + "title": "A string describing the reason the job ended.", + "description": "This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job's onAllTasksComplete attribute is set to terminatejob, and all tasks in the job are complete. TaskFailed - the job's onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminatejob. Any other string is a user-defined reason specified in a call to the 'Terminate a job' operation." + } + }, + "required": [ "startTime" ], + "title": "Contains information about the execution of a job in the Azure Batch service." + }, + "CloudJob": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the job within the account.", + "description": "The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the job." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether tasks in the job can define dependencies on each other. The default is false." + }, + "url": { + "type": "string", + "title": "The URL of the job." + }, + "eTag": { + "type": "string", + "title": "The ETag of the job.", + "description": "This is an opaque string. You can use it to detect whether the job has changed between requests. In particular, you can be pass the ETag when updating a job to specify that your changes should take effect only if nobody else has modified the job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the job.", + "description": "This is the last time at which the job level data, such as the job state or priority, changed. It does not factor in task-level changes such as adding new tasks or tasks changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the job." + }, + "state": { + "title": "The current state of the job.", + "$ref": "#/definitions/JobState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the job entered its current state." + }, + "previousState": { + "title": "The previous state of the job.", + "description": "This property is not set if the job is in its initial Active state.", + "$ref": "#/definitions/JobState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the job entered its previous state.", + "description": "This property is not set if the job is in its initial Active state." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager task to be launched when the job is started." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation task.", + "description": "The Job Preparation task is a special task run on each node before any other task of the job." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release task.", + "description": "The Job Release task is a special task run at the end of the job on each node that has run any other task of the job." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).", + "description": "Individual tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The pool settings associated with the job." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all tasks in the job are in the completed state.", + "description": "The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any task in the job fails.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the job." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "executionInfo": { + "$ref": "#/definitions/JobExecutionInformation", + "title": "The execution information for the job." + }, + "stats": { + "$ref": "#/definitions/JobStatistics", + "title": "Resource usage statistics for the entire lifetime of the job. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "An Azure Batch job." + }, + "JobAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the job within the account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the job.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "description": "The execution constraints for the job." + }, + "jobManagerTask": { + "$ref": "#/definitions/JobManagerTask", + "title": "Details of a Job Manager task to be launched when the job is started.", + "description": "If the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents." + }, + "jobPreparationTask": { + "$ref": "#/definitions/JobPreparationTask", + "title": "The Job Preparation task.", + "description": "If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node." + }, + "jobReleaseTask": { + "$ref": "#/definitions/JobReleaseTask", + "title": "The Job Release task.", + "description": "A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation." + }, + "commonEnvironmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).", + "description": "Individual tasks can override an environment setting specified here by specifying the same setting name with a different value." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The pool on which the Batch service runs the job's tasks." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all tasks in the job are in the completed state.", + "description": "Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction.", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "onTaskFailure": { + "title": "The action the Batch service should take when any task in the job fails.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", + "$ref": "#/definitions/OnTaskFailure" + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "usesTaskDependencies": { + "type": "boolean", + "title": "Whether tasks in the job can define dependencies on each other. The default is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/JobNetworkConfiguration", + "title": "The network configuration for the job." + } + }, + "required": [ "id", "poolInfo" ], + "title": "An Azure Batch job to add." + }, + "CloudJobListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudJob" + }, + "title": "The list of jobs." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the jobs in an account." + }, + "TaskContainerExecutionInformation": { + "properties": { + "containerId": { + "type": "string", + "title": "The ID of the container." + }, + "state": { + "type": "string", + "title": "The state of the container.", + "description": "This is the state of the container according to the Docker service. It is equivalent to the status field returned by \"docker inspect\"." + }, + "error": { + "type": "string", + "title": "Detailed error information about the container.", + "description": "This is the detailed error string from the Docker service, if available. It is equivalent to the error field returned by \"docker inspect\"." + } + }, + "title": "Contains information about the container which a task is executing." + }, + "TaskFailureInformation": { + "properties": { + "category": { + "title": "The category of the task error.", + "$ref": "#/definitions/ErrorCategory" + }, + "code": { + "type": "string", + "title": "An identifier for the task error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the task error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional details related to the error." + } + }, + "required": [ "category" ], + "title": "Information about a task failure." + }, + "JobPreparationTaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task started running.", + "description": "If the task has been restarted or retried, this is the most recent time at which the task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Preparation task completed.", + "description": "This property is set only if the task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Preparation task on the compute node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobPreparationTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Preparation task on the compute node. You can use this path to retrieve files created by the task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Preparation task on the compute node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the task command line.", + "description": "This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the task is executing.", + "description": "This property is set only if the task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the task failure, if any.", + "description": "This property is set only if the task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the Job Preparation task started running.", + "description": "This property is set only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ "startTime", "retryCount", "state" ], + "title": "Contains information about the execution of a Job Preparation task on a compute node." + }, + "JobReleaseTaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task started running.", + "description": "If the task has been restarted or retried, this is the most recent time at which the task started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the Job Release task completed.", + "description": "This property is set only if the task is in the Completed state." + }, + "state": { + "type": "string", + "title": "The current state of the Job Release task on the compute node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "JobReleaseTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The task is currently running (including retrying)." + }, + { + "value": "completed", + "description": "The task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to task preparation errors (such as resource file download failures)." + } + ] + } + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the Job Release task on the compute node. You can use this path to retrieve files created by the task, such as log files." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the Job Release task on the compute node." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the task command line.", + "description": "This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the task is executing.", + "description": "This property is set only if the task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the task failure, if any.", + "description": "This property is set only if the task is in the completed state and encountered a failure." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ "startTime", "state" ], + "title": "Contains information about the execution of a Job Release task on a compute node." + }, + "JobPreparationAndReleaseTaskExecutionInformation": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the pool containing the compute node to which this entry refers." + }, + "nodeId": { + "type": "string", + "title": "The ID of the compute node to which this entry refers." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the compute node to which this entry refers." + }, + "jobPreparationTaskExecutionInfo": { + "$ref": "#/definitions/JobPreparationTaskExecutionInformation", + "title": "Information about the execution status of the Job Preparation task on this compute node." + }, + "jobReleaseTaskExecutionInfo": { + "$ref": "#/definitions/JobReleaseTaskExecutionInformation", + "title": "Information about the execution status of the Job Release task on this compute node.", + "description": "This property is set only if the Job Release task has run on the node." + } + }, + "title": "The status of the Job Preparation and Job Release tasks on a compute node." + }, + "CloudJobListPreparationAndReleaseTaskStatusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/JobPreparationAndReleaseTaskExecutionInformation" + }, + "title": "A list of Job Preparation and Job Release task execution information." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the status of the Job Preparation and Job Release tasks for a job." + }, + "TaskCounts": { + "properties": { + "active": { + "type": "integer", + "format": "int32", + "title": "The number of tasks in the active state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of tasks in the running or preparing state." + }, + "completed": { + "type": "integer", + "format": "int32", + "title": "The number of tasks in the completed state." + }, + "succeeded": { + "type": "integer", + "format": "int32", + "title": "The number of tasks which succeeded. A task succeeds if its result (found in the executionInfo property) is 'success'." + }, + "failed": { + "type": "integer", + "format": "int32", + "title": "The number of tasks which failed. A task fails if its result (found in the executionInfo property) is 'failure'." + } + }, + "required": [ "active", "running", "completed", "succeeded", "failed" ], + "title": "The task counts for a job." + }, + "AutoScaleRunError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the autoscale error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the autoscale error." + } + }, + "title": "An error that occurred when executing or evaluating a pool autoscale formula." + }, + "AutoScaleRun": { + "properties": { + "timestamp": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful." + } + }, + "required": [ "timestamp" ], + "title": "The results and errors from an execution of a pool autoscale formula." + }, + "ResizeError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the pool resize error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the pool resize error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "A list of additional error details related to the pool resize error." + } + }, + "title": "An error that occurred when resizing a pool." + }, + "CloudServiceConfiguration": { + "properties": { + "osFamily": { + "type": "string", + "title": "The Azure Guest OS family to be installed on the virtual machines in the pool.", + "description": "Possible values are:\n2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1.\n3 - OS Family 3, equivalent to Windows Server 2012.\n4 - OS Family 4, equivalent to Windows Server 2012 R2.\n5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)." + }, + "osVersion": { + "type": "string", + "title": "The Azure Guest OS version to be installed on the virtual machines in the pool.", + "description": "The default value is * which specifies the latest operating system version for the specified OS family." + } + }, + "required": [ "osFamily" ], + "title": "The configuration for nodes in a pool based on the Azure Cloud Services platform." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace image.", + "description": "For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "virtualMachineImageId": { + "type": "string", + "title": "The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}", + "description": "This property is mutually exclusive with other ImageReference properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For more details, see https://docs.microsoft.com/azure/batch/batch-custom-images." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace image or a custom Azure Virtual Machine image. To get the list of all Azure Marketplace image references verified by Azure Batch, see the 'List node agent SKUs' operation." + }, + "WindowsConfiguration": { + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + }, + "title": "Windows operating system settings to apply to the virtual machine." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to be enabled for the data disks.", + "description": "The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in gigabytes." + }, + "storageAccountType": { + "title": "The storage account type to be used for the data disk.", + "description": "If omitted, the default is \"standard_lrs\".", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "title": "Settings which will be used by the data disks associated to compute nodes in the pool." + }, + "StorageAccountType": { + "type": "string", + "title": "The storage account type for use in creating data disks.", + "enum": [ + "standard_lrs", + "premium_lrs" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "standard_lrs", + "description": "The data disk should use standard locally redundant storage.", + "name": "StandardLRS" + }, + { + "value": "premium_lrs", + "description": "The data disk should use premium locally redundant storage.", + "name": "PremiumLRS" + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "description": "The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.", + "enum": [ + "none", + "readonly", + "readwrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "readonly", + "description": "The caching mode for the disk is read only.", + "name": "readOnly" + }, + { + "value": "readwrite", + "description": "The caching mode for the disk is read and write.", + "name": "readWrite" + } + ] + } + }, + "VirtualMachineConfiguration": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace image or the custom Virtual Machine image to use." + }, + "nodeAgentSKUId": { + "type": "string", + "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference property specifies a Linux OS image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the pool.", + "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." + } + }, + "required": [ "nodeAgentSKUId", "imageReference" ], + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." + }, + "ContainerRegistry": { + "properties": { + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "title": "The password to log into the registry server." + } + }, + "required": [ "username", "password" ], + "title": "A private container registry." + }, + "ContainerConfiguration": { + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "dockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "dockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + } + ] + } + }, + "containerImageNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of container image names.", + "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry." + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "title": "Additional private registries from which containers can be pulled.", + "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here." + } + }, + "required": [ "type" ], + "title": "The configuration for container-enabled pools." + }, + "NetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join.", + "description": "This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. For pools created with virtualMachineConfiguration only ARM virtual networks ('Microsoft.Network/virtualNetworks') are supported, but for pools created with cloudServiceConfiguration both ARM and classic virtual networks are supported. For more details, see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration" + }, + "dynamicVNetAssignmentScope": { + "type": "string", + "title": "The scope of dynamic vnet assignment.", + "enum": [ + "none", + "job" + ], + "x-ms-enum": { + "name": "DynamicVNetAssignmentScope", + "modelAsString": false, + "values": [ + { + "value": "none", + "description": "No dynamic VNet assignment is enabled." + }, + { + "value": "job", + "description": "Dynamic VNet assignment is done per-job." + } + ] + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on compute nodes in the Batch pool.", + "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property." + } + }, + "description": "The network configuration for a pool." + }, + "CloudPool": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the pool within the account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "url": { + "type": "string", + "title": "The URL of the pool." + }, + "eTag": { + "type": "string", + "title": "The ETag of the pool.", + "description": "This is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the pool.", + "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the pool." + }, + "state": { + "type": "string", + "title": "The current state of the pool.", + "enum": [ + "active", + "deleting" + ], + "x-ms-enum": { + "name": "PoolState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current state." + }, + "allocationState": { + "type": "string", + "title": "Whether the pool is resizing.", + "enum": [ + "steady", + "resizing", + "stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "value": "steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + } + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current allocation state." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All virtual machines in a pool are the same size.", + "description": "For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "This is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes." + }, + "resizeErrors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "A list of errors encountered while performing the last resize on the pool.", + "description": "This property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of dedicated compute nodes currently in the pool." + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of low-priority compute nodes currently in the pool.", + "description": "Low-priority compute nodes which have been preempted are included in this count." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "description": "This property is set only if the pool automatically scales, i.e. enableAutoScale is true." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. enableAutoScale is true." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. enableAutoScale is true." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the pool permits direct communication between nodes.", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail." + }, + "maxTasksPerNode": { + "type": "integer", + "format": "int32", + "title": "The maximum number of tasks that can run concurrently on a single compute node in the pool." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata." + }, + "stats": { + "$ref": "#/definitions/PoolStatistics", + "title": "Utilization and resource usage statistics for the entire lifetime of the pool. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes." + } + }, + "title": "A pool in the Azure Batch service." + }, + "PoolAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the pool within the account.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two pool IDs within an account that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All virtual machines in a pool are the same size.", + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both." + }, + "enableAutoScale": { + "type": "boolean", + "title": "Whether the pool size should automatically adjust over time.", + "description": "If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false." + }, + "autoScaleFormula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "description": "This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see 'Automatically scale compute nodes in an Azure Batch pool' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "enableInterNodeCommunication": { + "type": "boolean", + "title": "Whether the pool permits direct communication between nodes.", + "description": "Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool.", + "description": "The task runs when the node is added to the pool or when the node is restarted." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail." + }, + "maxTasksPerNode": { + "type": "integer", + "format": "int32", + "title": "The maximum number of tasks that can run concurrently on a single compute node in the pool.", + "description": "The default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting)." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + } + }, + "required": [ "id", "vmSize" ], + "title": "A pool in the Azure Batch service to add." + }, + "ApplicationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSummary" + }, + "title": "The list of applications available in the account." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the applications available in an account." + }, + "CloudPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudPool" + }, + "title": "The list of pools." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the pools in an account." + }, + "AffinityInformation": { + "properties": { + "affinityId": { + "type": "string", + "title": "An opaque string representing the location of a compute node or a task that has run previously.", + "description": "You can pass the affinityId of a compute node to indicate that this task needs to run on that compute node. Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere." + } + }, + "required": [ "affinityId" ], + "title": "A locality hint that can be used by the Batch service to select a compute node on which to start a task." + }, + "TaskExecutionInformation": { + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task started running.", + "description": "'Running' corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task completed.", + "description": "This property is set only if the task is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the task command line.", + "description": "This property is set only if the task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the task (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the task is executing.", + "description": "This property is set only if the task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the task failure, if any.", + "description": "This property is set only if the task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the task started running.", + "description": "This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "requeueCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the task has been requeued by the Batch service as the result of a user request.", + "description": "When the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons." + }, + "lastRequeueTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which the task has been requeued by the Batch service as the result of a user request.", + "description": "This property is set only if the requeueCount is nonzero." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ "requeueCount", "retryCount" ], + "title": "Information about the execution of a task." + }, + "ComputeNodeInformation": { + "properties": { + "affinityId": { + "type": "string", + "title": "An identifier for the compute node on which the task ran, which can be passed when adding a task to request that the task be scheduled on this compute node." + }, + "nodeUrl": { + "type": "string", + "title": "The URL of the node on which the task ran. " + }, + "poolId": { + "type": "string", + "title": "The ID of the pool on which the task ran." + }, + "nodeId": { + "type": "string", + "title": "The ID of the node on which the task ran." + }, + "taskRootDirectory": { + "type": "string", + "title": "The root directory of the task on the compute node." + }, + "taskRootDirectoryUrl": { + "type": "string", + "title": "The URL to the root directory of the task on the compute node." + } + }, + "title": "Information about the compute node on which a task ran." + }, + "NodeAgentInformation": { + "properties": { + "version": { + "type": "string", + "title": "The version of the Batch node agent running on the compute node.", + "description": "This version number can be checked against the node agent release notes located at https://github.com/Azure/Batch/blob/master/changelogs/nodeagent/CHANGELOG.md." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time when the node agent was updated on the compute node.", + "description": "This is the most recent time that the node agent was updated to a new version." + } + }, + "required": [ "version", "lastUpdateTime" ], + "title": "Information about the node agent.", + "description": "The Batch node agent is a program that runs on each node in the pool and provides Batch capability on the compute node." + }, + "MultiInstanceSettings": { + "properties": { + "numberOfInstances": { + "type": "integer", + "format": "int32", + "title": "The number of compute nodes required by the task.", + "description": "If omitted, the default is 1." + }, + "coordinationCommandLine": { + "type": "string", + "title": "The command line to run on all the compute nodes to enable them to coordinate when the primary runs the main task command.", + "description": "A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages." + }, + "commonResourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download before running the coordination command line.", + "description": "The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary. Also note that these resource files are not downloaded to the task working directory, but instead are downloaded to the task root directory (one directory above the working directory). There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + } + }, + "required": [ "coordinationCommandLine" ], + "title": "Settings which specify how to run a multi-instance task.", + "description": "Multi-instance tasks are commonly used to support MPI tasks." + }, + "TaskStatistics": { + "properties": { + "url": { + "type": "string", + "title": "The URL of the statistics." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start time of the time range covered by the statistics." + }, + "lastUpdateTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime." + }, + "userCPUTime": { + "type": "string", + "format": "duration", + "title": "The total user mode CPU time (summed across all cores and all compute nodes) consumed by the task." + }, + "kernelCPUTime": { + "type": "string", + "format": "duration", + "title": "The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by the task." + }, + "wallClockTime": { + "type": "string", + "format": "duration", + "title": "The total wall clock time of the task.", + "description": "The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If the task was retried, this includes the wall clock time of all the task retries." + }, + "readIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk read operations made by the task." + }, + "writeIOps": { + "type": "integer", + "format": "int64", + "title": "The total number of disk write operations made by the task." + }, + "readIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes read from disk by the task." + }, + "writeIOGiB": { + "type": "number", + "format": "double", + "title": "The total gibibytes written to disk by the task." + }, + "waitTime": { + "type": "string", + "format": "duration", + "title": "The total wait time of the task. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.)" + } + }, + "required": [ "url", "startTime", "lastUpdateTime", "userCPUTime", "kernelCPUTime", "wallClockTime", "readIOps", "writeIOps", "readIOGiB", "writeIOGiB", "waitTime" ], + "title": "Resource usage statistics for a task." + }, + "TaskDependencies": { + "properties": { + "taskIds": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of task IDs that this task depends on. All tasks in this list must complete successfully before the dependent task can be scheduled.", + "description": "The taskIds collection is limited to 64000 characters total (i.e. the combined length of all task IDs). If the taskIds collection exceeds the maximum length, the Add Task request fails with error code TaskDependencyListTooLong. In this case consider using task ID ranges instead." + }, + "taskIdRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskIdRange" + }, + "title": "The list of task ID ranges that this task depends on. All tasks in all ranges must complete successfully before the dependent task can be scheduled." + } + }, + "title": "Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled." + }, + "TaskIdRange": { + "properties": { + "start": { + "type": "integer", + "format": "int32", + "title": "The first task ID in the range." + }, + "end": { + "type": "integer", + "format": "int32", + "title": "The last task ID in the range." + } + }, + "title": "A range of task IDs that a task can depend on. All tasks with IDs in the range must complete successfully before the dependent task can be scheduled.", + "description": "The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents tasks '9', '10', '11' and '12'.", + "required": [ "start", "end" ] + }, + "CloudTask": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the task within the job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters." + }, + "displayName": { + "type": "string", + "title": "A display name for the task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "url": { + "type": "string", + "title": "The URL of the task." + }, + "eTag": { + "type": "string", + "title": "The ETag of the task.", + "description": "This is an opaque string. You can use it to detect whether the task has changed between requests. In particular, you can be pass the ETag when updating a task to specify that your changes should take effect only if nobody else has modified the task in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the task." + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the task." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the task completes." + }, + "state": { + "title": "The current state of the task.", + "$ref": "#/definitions/TaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task entered its current state." + }, + "previousState": { + "title": "The previous state of the task.", + "description": "This property is not set if the task is in its initial Active state.", + "$ref": "#/definitions/TaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the task entered its previous state.", + "description": "This property is not set if the task is in its initial Active state." + }, + "commandLine": { + "type": "string", + "title": "The command line of the task.", + "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the task runs.", + "description": "If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the compute node after running the command line.", + "description": "For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a compute node on which to start the new task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this task." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the task." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the compute node on which the task ran." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task." + }, + "stats": { + "$ref": "#/definitions/TaskStatistics", + "title": "Resource usage statistics for the task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The tasks that this task depends on.", + "description": "This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "title": "An Azure Batch task.", + "description": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." + }, + "TaskAddParameter": { + "properties": { + "id": { + "type": "string", + "title": "A string that uniquely identifies the task within the job.", + "description": "The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a job that differ only by case)." + }, + "displayName": { + "type": "string", + "title": "A display name for the task.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "commandLine": { + "type": "string", + "title": "The command line of the task.", + "description": "For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. If the command line refers to file paths, it should use a relative path (relative to the task working directory), or use the Batch provided environment variable (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables)." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the task runs.", + "description": "If the pool that will run this task has containerConfiguration set, this must be set as well. If the pool that will run this task doesn't have containerConfiguration set, this must not be set. When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + }, + "exitConditions": { + "$ref": "#/definitions/ExitConditions", + "description": "How the Batch service should respond when the task completes." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line.", + "description": "For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed. There is a maximum size for the list of resource files. When the max size is exceeded, the request will fail and the response error code will be RequestEntityTooLarge. If this occurs, the collection of ResourceFiles must be reduced in size. This can be achieved using .zip files, Application Packages, or Docker Containers." + }, + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "title": "A list of files that the Batch service will upload from the compute node after running the command line.", + "description": "For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the task." + }, + "affinityInfo": { + "$ref": "#/definitions/AffinityInformation", + "title": "A locality hint that can be used by the Batch service to select a compute node on which to start the new task." + }, + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "The execution constraints that apply to this task.", + "description": "If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the job, the maxWallClockTime is infinite, and the retentionTime is 7 days." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "multiInstanceSettings": { + "$ref": "#/definitions/MultiInstanceSettings", + "title": "An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task." + }, + "dependsOn": { + "$ref": "#/definitions/TaskDependencies", + "title": "The tasks that this task depends on.", + "description": "This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled. If the job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of application packages that the Batch service will deploy to the compute node before running the command line.", + "description": "Application packages are downloaded and deployed to a shared directory, not the task working directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails." + }, + "authenticationTokenSettings": { + "title": "The settings for an authentication token that the task can use to perform Batch service operations.", + "description": "If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.", + "$ref": "#/definitions/AuthenticationTokenSettings" + } + }, + "required": [ "id", "commandLine" ], + "title": "An Azure Batch task to add.", + "description": "Batch will retry tasks when a recovery operation is triggered on a compute node. Examples of recovery operations include (but are not limited to) when an unhealthy compute node is rebooted or a compute node disappeared due to host failure. Retries due to recovery operations are independent of and are not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is 0, an internal retry due to a recovery operation may occur. Because of this, all tasks should be idempotent. This means tasks need to tolerate being interrupted and restarted without causing any corruption or duplicate data. The best practice for long running tasks is to use some form of checkpointing." + }, + "TaskAddCollectionParameter": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddParameter" + }, + "maxItems": 100, + "title": "The collection of tasks to add. The maximum count of tasks is 100.", + "description": "The total serialized size of this collection must be less than 1MB. If it is greater than 1MB (for example if each task has 100's of resource files or environment variables), the request will fail with code 'RequestBodyTooLarge' and should be retried again with fewer tasks." + } + }, + "required": [ "value" ], + "title": "A collection of Azure Batch tasks to add." + }, + "TaskAddResult": { + "properties": { + "status": { + "type": "string", + "title": "The status of the add task request.", + "enum": [ + "success", + "clienterror", + "servererror" + ], + "x-ms-enum": { + "name": "TaskAddStatus", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task was added successfully." + }, + { + "value": "clienterror", + "description": "The task failed to add due to a client error and should not be retried without modifying the request as appropriate.", + "name": "clientError" + }, + { + "value": "servererror", + "description": "Task failed to add due to a server error and can be retried without modification.", + "name": "serverError" + } + ] + } + }, + "taskId": { + "type": "string", + "title": "The ID of the task for which this is the result." + }, + "eTag": { + "type": "string", + "title": "The ETag of the task, if the task was successfully added.", + "description": "You can use this to detect whether the task has changed between requests. In particular, you can be pass the ETag with an Update Task request to specify that your changes should take effect only if nobody else has modified the job in the meantime." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the task." + }, + "location": { + "type": "string", + "title": "The URL of the task, if the task was successfully added." + }, + "error": { + "$ref": "#/definitions/BatchError", + "title": "The error encountered while attempting to add the task." + } + }, + "required": [ "status", "taskId" ], + "title": "Result for a single task added as part of an add task collection operation." + }, + "TaskAddCollectionResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskAddResult" + }, + "title": "The results of the add task collection operation." + } + }, + "title": "The result of adding a collection of tasks to a job." + }, + "SubtaskInformation": { + "properties": { + "id": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask." + }, + "nodeInfo": { + "$ref": "#/definitions/ComputeNodeInformation", + "title": "Information about the compute node on which the subtask ran." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask completed.", + "description": "This property is set only if the subtask is in the Completed state." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the subtask command line.", + "description": "This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the task is executing.", + "description": "This property is set only if the task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the task failure, if any.", + "description": "This property is set only if the task is in the completed state and encountered a failure." + }, + "state": { + "title": "The current state of the subtask.", + "$ref": "#/definitions/SubtaskState" + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its current state." + }, + "previousState": { + "title": "The previous state of the subtask.", + "description": "This property is not set if the subtask is in its initial running state.", + "$ref": "#/definitions/SubtaskState" + }, + "previousStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the subtask entered its previous state.", + "description": "This property is not set if the subtask is in its initial running state." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "title": "Information about an Azure Batch subtask." + }, + "CloudTaskListSubtasksResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SubtaskInformation" + }, + "title": "The list of subtasks." + } + }, + "title": "The result of listing the subtasks of a task." + }, + "CloudTaskListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudTask" + }, + "title": "The list of tasks." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the tasks in a job." + }, + "TaskInformation": { + "properties": { + "taskUrl": { + "type": "string", + "title": "The URL of the task." + }, + "jobId": { + "type": "string", + "title": "The ID of the job to which the task belongs." + }, + "taskId": { + "type": "string", + "title": "The ID of the task." + }, + "subtaskId": { + "type": "integer", + "format": "int32", + "title": "The ID of the subtask if the task is a multi-instance task." + }, + "taskState": { + "title": "The current state of the task.", + "$ref": "#/definitions/TaskState" + }, + "executionInfo": { + "$ref": "#/definitions/TaskExecutionInformation", + "title": "Information about the execution of the task." + } + }, + "required": [ "taskState" ], + "title": "Information about a task running on a compute node." + }, + "StartTaskInformation": { + "properties": { + "state": { + "type": "string", + "title": "The state of the start task on the compute node.", + "enum": [ + "running", + "completed" + ], + "x-ms-enum": { + "name": "StartTaskState", + "modelAsString": false, + "values": [ + { + "value": "running", + "description": "The start task is currently running." + }, + { + "value": "completed", + "description": "The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to task preparation errors (such as resource file download failures)." + } + ] + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the start task started running.", + "description": "This value is reset every time the task is restarted or retried (that is, this is the most recent time at which the start task started running)." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the start task stopped running.", + "description": "This is the end time of the most recent run of the start task, if that run has completed (even if that run failed and a retry is pending). This element is not present if the start task is currently running." + }, + "exitCode": { + "type": "integer", + "format": "int32", + "title": "The exit code of the program specified on the start task command line.", + "description": "This property is set only if the start task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the start task (due to timeout, or user termination via the API) you may see an operating system-defined exit code." + }, + "containerInfo": { + "$ref": "#/definitions/TaskContainerExecutionInformation", + "title": "Information about the container under which the task is executing.", + "description": "This property is set only if the task runs in a container context." + }, + "failureInfo": { + "$ref": "#/definitions/TaskFailureInformation", + "title": "Information describing the task failure, if any.", + "description": "This property is set only if the task is in the completed state and encountered a failure." + }, + "retryCount": { + "type": "integer", + "format": "int32", + "title": "The number of times the task has been retried by the Batch service.", + "description": "Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints." + }, + "lastRetryTime": { + "type": "string", + "format": "date-time", + "title": "The most recent time at which a retry of the task started running.", + "description": "This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not." + }, + "result": { + "$ref": "#/definitions/TaskExecutionResult", + "title": "The result of the task execution.", + "description": "If the value is 'failed', then the details of the failure can be found in the failureInfo property." + } + }, + "required": [ "state", "startTime", "retryCount" ], + "title": "Information about a start task running on a compute node." + }, + "ComputeNodeError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "title": "A message describing the compute node error, intended to be suitable for display in a user interface." + }, + "errorDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/NameValuePair" + }, + "title": "The list of additional error details related to the compute node error." + } + }, + "title": "An error encountered by a compute node." + }, + "ComputeNode": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the compute node.", + "description": "Every node that is added to a pool is assigned a unique ID. Whenever a node is removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new nodes." + }, + "url": { + "type": "string", + "title": "The URL of the compute node." + }, + "state": { + "type": "string", + "title": "The current state of the compute node.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "enum": [ + "idle", + "rebooting", + "reimaging", + "running", + "unusable", + "creating", + "starting", + "waitingforstarttask", + "starttaskfailed", + "unknown", + "leavingpool", + "offline", + "preempted" + ], + "x-ms-enum": { + "name": "ComputeNodeState", + "modelAsString": false, + "values": [ + { + "value": "idle", + "description": "The node is not currently running a task." + }, + { + "value": "rebooting", + "description": "The node is rebooting." + }, + { + "value": "reimaging", + "description": "The node is reimaging." + }, + { + "value": "running", + "description": "The node is running one or more tasks (other than a start task)." + }, + { + "value": "unusable", + "description": "The node cannot be used for task execution due to errors." + }, + { + "value": "creating", + "description": "The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the pool." + }, + { + "value": "starting", + "description": "The Batch service is starting on the underlying virtual machine." + }, + { + "value": "waitingforstarttask", + "description": "The start task has started running on the compute node, but waitForSuccess is set and the start task has not yet completed.", + "name": "waitingForStartTask" + }, + { + "value": "starttaskfailed", + "description": "The start task has failed on the compute node (and exhausted all retries), and waitForSuccess is set. The node is not usable for running tasks.", + "name": "startTaskFailed" + }, + { + "value": "unknown", + "description": "The Batch service has lost contact with the node, and does not know its true state." + }, + { + "value": "leavingpool", + "description": "The node is leaving the pool, either because the user explicitly removed it or because the pool is resizing or autoscaling down.", + "name": "leavingPool" + }, + { + "value": "offline", + "description": "The node is not currently running a task, and scheduling of new tasks to the node is disabled." + }, + { + "value": "preempted", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + } + ] + } + }, + "schedulingState": { + "type": "string", + "title": "Whether the compute node is available for task scheduling.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "SchedulingState", + "modelAsString": false, + "values": [ + { + "value": "enabled", + "description": "Tasks can be scheduled on the node." + }, + { + "value": "disabled", + "description": "No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled." + } + ] + } + }, + "stateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the compute node entered its current state." + }, + "lastBootTime": { + "type": "string", + "format": "date-time", + "title": "The last time at which the compute node was started.", + "description": "This property may not be present if the node state is unusable." + }, + "allocationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which this compute node was allocated to the pool.", + "description": "This is the time when the node was initially allocated and doesn't change once set. It is not updated when the node is service healed or preempted." + }, + "ipAddress": { + "type": "string", + "title": "The IP address that other compute nodes can use to communicate with this compute node.", + "description": "Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes." + }, + "affinityId": { + "type": "string", + "title": "An identifier which can be passed when adding a task to request that the task be scheduled on this node.", + "description": "Note that this is just a soft affinity. If the target node is busy or unavailable at the time the task is scheduled, then the task will be scheduled elsewhere." + }, + "vmSize": { + "type": "string", + "title": "The size of the virtual machine hosting the compute node.", + "description": "For information about available sizes of virtual machines in pools, see Choose a VM size for compute nodes in an Azure Batch pool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes)." + }, + "totalTasksRun": { + "type": "integer", + "format": "int32", + "title": "The total number of job tasks completed on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks." + }, + "runningTasksCount": { + "type": "integer", + "format": "int32", + "title": "The total number of currently running job tasks on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks." + }, + "totalTasksSucceeded": { + "type": "integer", + "format": "int32", + "title": "The total number of job tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Manager tasks and normal tasks, but not Job Preparation, Job Release or Start tasks." + }, + "recentTasks": { + "type": "array", + "items": { + "$ref": "#/definitions/TaskInformation" + }, + "title": "A list of tasks whose state has recently changed.", + "description": "This property is present only if at least one task has run on this node since it was assigned to the pool." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "The task specified to run on the compute node as it joins the pool." + }, + "startTaskInfo": { + "$ref": "#/definitions/StartTaskInformation", + "title": "Runtime information about the execution of the start task on the compute node." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates installed on the compute node.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNodeError" + }, + "title": "The list of errors that are currently being encountered by the compute node." + }, + "isDedicated": { + "type": "boolean", + "title": "Whether this compute node is a dedicated node. If false, the node is a low-priority node." + }, + "endpointConfiguration": { + "$ref": "#/definitions/ComputeNodeEndpointConfiguration", + "title": "The endpoint configuration for the compute node." + }, + "nodeAgentInfo": { + "$ref": "#/definitions/NodeAgentInformation", + "title": "Information about the node agent version and the time the node upgraded to a new version." + } + }, + "title": "A compute node in the Batch service." + }, + "PoolEndpointConfiguration": { + "properties": { + "inboundNATPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNATPool" + }, + "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", + "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400." + } + }, + "required": [ "inboundNATPools" ], + "title": "The endpoint configuration for a pool." + }, + "InboundNATPool": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the compute node.", + "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Each range must contain at least 40 ports. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + } + } + }, + "required": [ "name", "protocol", "backendPort", "frontendPortRangeStart", "frontendPortRangeEnd" ], + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally." + }, + "NetworkSecurityGroupRule": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "type": "string", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "value": "allow", + "description": "Allow access." + }, + { + "value": "deny", + "description": "Deny access." + } + ] + } + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + } + }, + "required": [ "priority", "access", "sourceAddressPrefix" ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ComputeNodeEndpointConfiguration": { + "properties": { + "inboundEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundEndpoint" + }, + "title": "The list of inbound endpoints that are accessible on the compute node." + } + }, + "required": [ "inboundEndpoints" ], + "title": "The endpoint configuration for the compute node." + }, + "InboundEndpoint": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint." + }, + "protocol": { + "$ref": "#/definitions/InboundEndpointProtocol", + "title": "The protocol of the endpoint." + }, + "publicIPAddress": { + "type": "string", + "title": "The public IP address of the compute node." + }, + "publicFQDN": { + "type": "string", + "title": "The public fully qualified domain name for the compute node." + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "title": "The public port number of the endpoint." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The backend port number of the endpoint." + } + }, + "required": [ "name", "protocol", "publicIPAddress", "publicFQDN", "frontendPort", "backendPort" ], + "title": "An inbound endpoint on a compute node." + }, + "ComputeNodeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ComputeNode" + }, + "title": "The list of compute nodes." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the compute nodes in a pool." + }, + "ComputeNodeUser": { + "properties": { + "name": { + "type": "string", + "title": "The user name of the account." + }, + "isAdmin": { + "type": "boolean", + "title": "Whether the account should be an administrator on the compute node.", + "description": "The default value is false." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day." + }, + "password": { + "type": "string", + "title": "The password of the account.", + "description": "The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the compute node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + } + }, + "required": [ "name" ], + "title": "A user account for RDP or SSH access on a compute node." + }, + "ComputeNodeGetRemoteLoginSettingsResult": { + "properties": { + "remoteLoginIPAddress": { + "type": "string", + "title": "The IP address used for remote login to the compute node." + }, + "remoteLoginPort": { + "type": "integer", + "format": "int32", + "title": "The port used for remote login to the compute node." + } + }, + "required": [ "remoteLoginIPAddress", "remoteLoginPort" ], + "title": "The remote login settings for a compute node." + }, + "JobSchedulePatchParameter": { + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which jobs will be created.", + "description": "If you do not specify this element, the existing schedule is left unchanged." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "The details of the jobs to be created on this schedule.", + "description": "Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job schedule as metadata.", + "description": "If you do not specify this element, existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a job schedule." + }, + "JobScheduleUpdateParameter": { + "properties": { + "schedule": { + "$ref": "#/definitions/Schedule", + "title": "The schedule according to which jobs will be created.", + "description": "If you do not specify this element, it is equivalent to passing the default schedule: that is, a single job scheduled to run immediately." + }, + "jobSpecification": { + "$ref": "#/definitions/JobSpecification", + "title": "Details of the jobs to be created on this schedule.", + "description": "Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job schedule as metadata.", + "description": "If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted." + } + }, + "required": [ "schedule", "jobSpecification" ], + "title": "The set of changes to be made to a job schedule." + }, + "JobDisableParameter": { + "properties": { + "disableTasks": { + "type": "string", + "title": "What to do with active tasks associated with the job.", + "enum": [ + "requeue", + "terminate", + "wait" + ], + "x-ms-enum": { + "name": "DisableJobOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running tasks and requeue them. The tasks will run again when the job is enabled." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again." + }, + { + "value": "wait", + "description": "Allow currently running tasks to complete." + } + ] + } + } + }, + "required": [ "disableTasks" ], + "title": "Options when disabling a job." + }, + "JobTerminateParameter": { + "properties": { + "terminateReason": { + "type": "string", + "title": "The text you want to appear as the job's TerminateReason. The default is 'UserTerminate'." + } + }, + "title": "Options when terminating a job." + }, + "JobPatchParameter": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all tasks in the job are in the completed state.", + "description": "If omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).", + "$ref": "#/definitions/OnAllTasksComplete" + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the job.", + "description": "If omitted, the existing execution constraints are left unchanged." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The pool on which the Batch service runs the job's tasks.", + "description": "You may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job as metadata.", + "description": "If omitted, the existing job metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a job." + }, + "JobUpdateParameter": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority of the job.", + "description": "Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0." + }, + "constraints": { + "$ref": "#/definitions/JobConstraints", + "title": "The execution constraints for the job.", + "description": "If omitted, the constraints are cleared." + }, + "poolInfo": { + "$ref": "#/definitions/PoolInformation", + "title": "The pool on which the Batch service runs the job's tasks.", + "description": "You may change the pool for a job only when the job is disabled. The Update Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the job as metadata.", + "description": "If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted." + }, + "onAllTasksComplete": { + "title": "The action the Batch service should take when all tasks in the job are in the completed state.", + "description": "If omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob.", + "$ref": "#/definitions/OnAllTasksComplete" + } + }, + "required": [ "poolInfo" ], + "title": "The set of changes to be made to a job." + }, + "PoolEnableAutoScaleParameter": { + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of compute nodes in the pool.", + "description": "The formula is checked for validity before it is applied to the pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + }, + "autoScaleEvaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued." + } + }, + "title": "Options for enabling automatic scaling on a pool." + }, + "PoolEvaluateAutoScaleParameter": { + "properties": { + "autoScaleFormula": { + "type": "string", + "title": "The formula for the desired number of compute nodes in the pool.", + "description": "The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling)." + } + }, + "required": [ "autoScaleFormula" ], + "title": "Options for evaluating an automatic scaling formula on a pool." + }, + "PoolResizeParameter": { + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "title": "Options for changing the size of a pool." + }, + "PoolUpdatePropertiesParameter": { + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.", + "description": "If this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of certificates to be installed on each compute node in the pool.", + "description": "This list replaces any existing certificate references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of application packages to be installed on each compute node in the pool.", + "description": "The list replaces any existing application package references on the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If omitted, or if you specify an empty collection, any existing application packages references are removed from the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "This list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool." + } + }, + "required": [ "certificateReferences", "metadata", "applicationPackageReferences" ], + "title": "The set of changes to be made to a pool." + }, + "PoolPatchParameter": { + "properties": { + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.", + "description": "If this element is present, it overwrites any existing start task. If omitted, any existing start task is left unchanged." + }, + "certificateReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "A list of certificates to be installed on each compute node in the pool.", + "description": "If this element is present, it replaces any existing certificate references configured on the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackageReferences": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "A list of application packages to be installed on each compute node in the pool.", + "description": "Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "If this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged." + } + }, + "title": "The set of changes to be made to a pool." + }, + "TaskUpdateParameter": { + "properties": { + "constraints": { + "$ref": "#/definitions/TaskConstraints", + "title": "Constraints that apply to this task.", + "description": "If omitted, the task is given the default constraints. For multi-instance tasks, updating the retention time applies only to the primary task and not subtasks." + } + }, + "title": "The set of changes to be made to a task." + }, + "NodeUpdateUserParameter": { + "properties": { + "password": { + "type": "string", + "title": "The password of the account.", + "description": "The password is required for Windows nodes (those created with 'cloudServiceConfiguration', or created with 'virtualMachineConfiguration' using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed." + }, + "expiryTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the account should expire.", + "description": "If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day." + }, + "sshPublicKey": { + "type": "string", + "title": "The SSH public key that can be used for remote login to the compute node.", + "description": "The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed." + } + }, + "title": "The set of changes to be made to a user account on a node." + }, + "NodeRebootParameter": { + "properties": { + "nodeRebootOption": { + "type": "string", + "title": "When to reboot the compute node and what to do with currently running tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeRebootOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Restart the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Restart the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Restart the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Restart the node when all task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for rebooting a compute node." + }, + "NodeReimageParameter": { + "properties": { + "nodeReimageOption": { + "type": "string", + "title": "When to reimage the compute node and what to do with currently running tasks.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeReimageOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Reimage the node as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Reimage the node when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Reimage the node when all task retention periods have expired.", + "name": "retainedData" + } + ] + } + } + }, + "title": "Options for reimaging a compute node." + }, + "NodeDisableSchedulingParameter": { + "properties": { + "nodeDisableSchedulingOption": { + "type": "string", + "title": "What to do with currently running tasks when disabling task scheduling on the compute node.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion" + ], + "x-ms-enum": { + "name": "DisableComputeNodeSchedulingOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks may run again on other compute nodes, or when task scheduling is re-enabled on this node. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Enter offline state as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Enter offline state when all tasks have completed.", + "name": "taskCompletion" + } + ] + } + } + }, + "title": "Options for disabling scheduling on a compute node." + }, + "NodeRemoveParameter": { + "properties": { + "nodeList": { + "type": "array", + "maxItems": 100, + "items": { + "type": "string" + }, + "title": "A list containing the IDs of the compute nodes to be removed from the specified pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for removal of compute nodes to the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "required": [ "nodeList" ], + "title": "Options for removing compute nodes from a pool." + }, + "OutputFile": { + "properties": { + "filePattern": { + "type": "string", + "title": "A pattern indicating which file(s) to upload.", + "description": "Both relative and absolute paths are supported. Relative paths are relative to the task working directory. The following wildcards are supported: * matches 0 or more characters (for example pattern abc* would match abc or abcdef), ** matches any directory, ? matches any single character, [abc] matches one character in the brackets, and [a-c] matches one character in the range. Brackets can include a negation to match any character not specified (for example [!abc] matches any character but a, b, or c). If a file name starts with \".\" it is ignored by default but may be matched by specifying it explicitly (for example *.gif will not match .a.gif, but .*.gif will). A simple example: **\\*.txt matches any file that does not start in '.' and ends with .txt in the task working directory or any subdirectory. If the filename contains a wildcard character it can be escaped using brackets (for example abc[*] would match a file named abc*). Note that both \\ and / are treated as directory separators on Windows, but only / is on Linux. Environment variables (%var% on Windows or $var on Linux) are expanded prior to the pattern being applied." + }, + "destination": { + "title": "The destination for the output file(s).", + "$ref": "#/definitions/OutputFileDestination" + }, + "uploadOptions": { + "title": "Additional options for the upload operation, including under what conditions to perform the upload.", + "$ref": "#/definitions/OutputFileUploadOptions" + } + }, + "required": [ "filePattern", "destination", "uploadOptions" ], + "title": "A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process." + }, + "OutputFileDestination": { + "properties": { + "container": { + "title": "A location in Azure blob storage to which files are uploaded.", + "$ref": "#/definitions/OutputFileBlobContainerDestination" + } + }, + "title": "The destination to which a file should be uploaded." + }, + "OutputFileBlobContainerDestination": { + "properties": { + "path": { + "type": "string", + "title": "The destination blob or virtual directory within the Azure Storage container.", + "description": "If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name." + }, + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the file(s).", + "description": "The URL must include a Shared Access Signature (SAS) granting write permissions to the container." + } + }, + "required": [ "containerUrl" ], + "title": "Specifies a file upload destination within an Azure blob storage container." + }, + "OutputFileUploadOptions": { + "properties": { + "uploadCondition": { + "title": "The conditions under which the task output file or set of files should be uploaded.", + "description": "The default is taskcompletion.", + "$ref": "#/definitions/OutputFileUploadCondition" + } + }, + "required": [ "uploadCondition" ], + "title": "Details about an output file upload operation, including under what conditions to perform the upload." + }, + "ErrorMessage": { + "properties": { + "lang": { + "type": "string", + "title": "The language code of the error message" + }, + "value": { + "type": "string", + "title": "The text of the message." + } + }, + "title": "An error message received in an Azure Batch error response." + }, + "BatchErrorDetail": { + "properties": { + "key": { + "type": "string", + "title": "An identifier specifying the meaning of the Value property." + }, + "value": { + "type": "string", + "title": "The additional information included with the error response." + } + }, + "title": "An item of additional information included in an Azure Batch error response." + }, + "BatchError": { + "properties": { + "code": { + "type": "string", + "title": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "$ref": "#/definitions/ErrorMessage", + "title": "A message describing the error, intended to be suitable for display in a user interface." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchErrorDetail" + }, + "title": "A collection of key-value pairs containing additional details about the error." + } + }, + "title": "An error response received from the Azure Batch service." + }, + "CertificateState": { + "type": "string", + "title": "The state of the certificate.", + "enum": [ + "active", + "deleting", + "deletefailed" + ], + "x-ms-enum": { + "name": "CertificateState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The certificate is available for use in pools." + }, + { + "value": "deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "deletefailed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete.", + "name": "deleteFailed" + } + ] + } + }, + "ElevationLevel": { + "type": "string", + "title": "The elevation level of the user.", + "enum": [ + "nonadmin", + "admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "value": "nonadmin", + "description": "The user is a standard user without elevated access.", + "name": "nonAdmin" + }, + { + "value": "admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "JobScheduleState": { + "type": "string", + "title": "The state of the job schedule.", + "enum": [ + "active", + "completed", + "disabled", + "terminating", + "deleting" + ], + "x-ms-enum": { + "name": "JobScheduleState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job schedule is active and will create jobs as per its schedule." + }, + { + "value": "completed", + "description": "The schedule has terminated, either by reaching its end time or by the user terminating it explicitly." + }, + { + "value": "disabled", + "description": "The user has disabled the schedule. The scheduler will not initiate any new jobs will on this schedule, but any existing active job will continue to run." + }, + { + "value": "terminating", + "description": "The schedule has no more work to do, or has been explicitly terminated by the user, but the termination operation is still in progress. The scheduler will not initiate any new jobs for this schedule, nor is any existing job active." + }, + { + "value": "deleting", + "description": "The user has requested that the schedule be deleted, but the delete operation is still in progress. The scheduler will not initiate any new jobs for this schedule, and will delete any existing jobs and tasks under the schedule, including any active job. The schedule will be deleted when all jobs and tasks under the schedule have been deleted." + } + ] + } + }, + "JobState": { + "type": "string", + "title": "The state of the job.", + "enum": [ + "active", + "disabling", + "disabled", + "enabling", + "terminating", + "completed", + "deleting" + ], + "x-ms-enum": { + "name": "JobState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The job is available to have tasks scheduled." + }, + { + "value": "disabling", + "description": "A user has requested that the job be disabled, but the disable operation is still in progress (for example, waiting for tasks to terminate)." + }, + { + "value": "disabled", + "description": "A user has disabled the job. No tasks are running, and no new tasks will be scheduled." + }, + { + "value": "enabling", + "description": "A user has requested that the job be enabled, but the enable operation is still in progress." + }, + { + "value": "terminating", + "description": "The job is about to complete, either because a Job Manager task has completed or because the user has terminated the job, but the terminate operation is still in progress (for example, because Job Release tasks are running)." + }, + { + "value": "completed", + "description": "All tasks have terminated, and the system will not accept any more tasks or any further changes to the job." + }, + { + "value": "deleting", + "description": "A user has requested that the job be deleted, but the delete operation is still in progress (for example, because the system is still terminating running tasks)." + } + ] + } + }, + "OnAllTasksComplete": { + "type": "string", + "title": "The action the Batch service should take when all tasks in the job are in the completed state.", + "enum": [ + "noaction", + "terminatejob" + ], + "x-ms-enum": { + "name": "OnAllTasksComplete", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "terminatejob", + "description": "Terminate the job. The job's terminateReason is set to 'AllTasksComplete'.", + "name": "terminateJob" + } + ] + } + }, + "OnTaskFailure": { + "type": "string", + "title": "The action the Batch service should take when any task in the job fails.", + "description": "A task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction.", + "enum": [ + "noaction", + "performexitoptionsjobaction" + ], + "x-ms-enum": { + "name": "OnTaskFailure", + "modelAsString": false, + "values": [ + { + "value": "noaction", + "description": "Do nothing. The job remains active unless terminated or disabled by some other means.", + "name": "noAction" + }, + { + "value": "performexitoptionsjobaction", + "description": "Take the action associated with the task exit condition in the task's exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.)", + "name": "performExitOptionsJobAction" + } + ] + } + }, + "ErrorCategory": { + "type": "string", + "title": "The category of the error.", + "enum": [ + "usererror", + "servererror" + ], + "x-ms-enum": { + "name": "ErrorCategory", + "modelAsString": false, + "values": [ + { + "value": "usererror", + "description": "The error is due to a user issue, such as misconfiguration.", + "name": "userError" + }, + { + "value": "servererror", + "description": "The error is due to an internal server issue.", + "name": "serverError" + } + ] + } + }, + "TaskState": { + "type": "string", + "title": "The state of the task.", + "enum": [ + "active", + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "TaskState", + "modelAsString": false, + "values": [ + { + "value": "active", + "description": "The task is queued and able to run, but is not currently assigned to a compute node. A task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run." + }, + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] + } + }, + "SubtaskState": { + "type": "string", + "title": "The state of the subtask.", + "enum": [ + "preparing", + "running", + "completed" + ], + "x-ms-enum": { + "name": "SubtaskState", + "modelAsString": false, + "values": [ + { + "value": "preparing", + "description": "The task has been assigned to a compute node, but is waiting for a required Job Preparation task to complete on the node. If the Job Preparation task succeeds, the task will move to running. If the Job Preparation task fails, the task will return to active and will be eligible to be assigned to a different node." + }, + { + "value": "running", + "description": "The task is running on a compute node. This includes task-level preparation such as downloading resource files or deploying application packages specified on the task - it does not necessarily mean that the task command line has started executing." + }, + { + "value": "completed", + "description": "The task is no longer eligible to run, usually because the task has finished successfully, or the task has finished unsuccessfully and has exhausted its retry limit. A task is also marked as completed if an error occurred launching the task, or when the task has been terminated." + } + ] + } + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "description": "The default value is requeue.", + "enum": [ + "requeue", + "terminate", + "taskcompletion", + "retaineddata" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "value": "requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "taskcompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed.", + "name": "taskCompletion" + }, + { + "value": "retaineddata", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired.", + "name": "retainedData" + } + ] + } + }, + "OutputFileUploadCondition": { + "type": "string", + "title": "The conditions under which a task output file or set of files should be uploaded.", + "enum": [ + "tasksuccess", + "taskfailure", + "taskcompletion" + ], + "x-ms-enum": { + "name": "OutputFileUploadCondition", + "modelAsString": false, + "values": [ + { + "value": "tasksuccess", + "description": "Upload the file(s) only after the task process exits with an exit code of 0.", + "name": "taskSuccess" + }, + { + "value": "taskfailure", + "description": "Upload the file(s) only after the task process exits with a nonzero exit code.", + "name": "taskFailure" + }, + { + "value": "taskcompletion", + "description": "Upload the file(s) after the task process exits, no matter what the exit code was.", + "name": "taskCompletion" + } + ] + } + }, + "TaskExecutionResult": { + "type": "string", + "title": "The result of task execution.", + "enum": [ + "success", + "failure" + ], + "x-ms-enum": { + "name": "TaskExecutionResult", + "modelAsString": false, + "values": [ + { + "value": "success", + "description": "The task ran successfully.", + "name": "success" + }, + { + "value": "failure", + "description": "There was an error during processing of the task. The failure may have occurred before the task process was launched, while the task process was executing, or after the task process exited.", + "name": "failure" + } + ] + } + }, + "InboundEndpointProtocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "tcp", + "description": "Use TCP for the endpoint.", + "name": "tcp" + }, + { + "value": "udp", + "description": "Use UDP for the endpoint.", + "name": "udp" + } + ] + } + }, + "UploadBatchServiceLogsConfiguration": { + "properties": { + "containerUrl": { + "type": "string", + "title": "The URL of the container within Azure Blob Storage to which to upload the Batch Service log file(s).", + "description": "The URL must include a Shared Access Signature (SAS) granting write permissions to the container. The SAS duration must allow enough time for the upload to finish. The start time for SAS is optional and recommended to not be specified." + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The start of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested." + }, + "endTime": { + "type": "string", + "format": "date-time", + "title": "The end of the time range from which to upload Batch Service log file(s).", + "description": "Any log file containing a log message in the time range will be uploaded. This means that the operation might retrieve more logs than have been requested since the entire log file is always uploaded, but the operation should not retrieve fewer logs than have been requested. If omitted, the default is to upload all logs available after the startTime." + } + }, + "required": [ "containerUrl", "startTime" ], + "title": "The Azure Batch service log files upload configuration for a compute node." + }, + "UploadBatchServiceLogsResult": { + "properties": { + "virtualDirectoryName": { + "type": "string", + "title": "The virtual directory within Azure Blob Storage container to which the Batch Service log file(s) will be uploaded.", + "description": "The virtual directory name is part of the blob name for each log file uploaded, and it is built based poolId, nodeId and a unique identifier." + }, + "numberOfFilesUploaded": { + "type": "integer", + "format": "int32", + "title": "The number of log files which will be uploaded." + } + }, + "required": [ "virtualDirectoryName", "numberOfFilesUploaded" ], + "title": "The result of uploading Batch service log files from a specific compute node." + }, + "PoolNodeCountsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PoolNodeCounts" + }, + "description": "A list of node counts by pool." + }, + "odata.nextLink": { + "type": "string", + "title": "The URL to get the next set of results." + } + }, + "title": "The result of listing the node counts in the account." + }, + "PoolNodeCounts": { + "properties": { + "poolId": { + "type": "string", + "title": "The ID of the pool." + }, + "dedicated": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of dedicated nodes in each state." + }, + "lowPriority": { + "$ref": "#/definitions/NodeCounts", + "title": "The number of low priority nodes in each state." + } + }, + "required": [ + "poolId" + ], + "title": "The number of nodes in each state for a pool." + }, + "NodeCounts": { + "properties": { + "creating": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the creating state." + }, + "idle": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the idle state." + }, + "offline": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the offline state." + }, + "preempted": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the preempted state." + }, + "rebooting": { + "type": "integer", + "format": "int32", + "title": "The count of nodes in the rebooting state." + }, + "reimaging": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the reimaging state." + }, + "running": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the running state." + }, + "starting": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the starting state." + }, + "startTaskFailed": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the startTaskFailed state." + }, + "leavingPool": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the leavingPool state." + }, + "unknown": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the unknown state." + }, + "unusable": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the unusable state." + }, + "waitingForStartTask": { + "type": "integer", + "format": "int32", + "title": "The number of nodes in the waitingForStartTask state." + }, + "total": { + "type": "integer", + "format": "int32", + "title": "The total number of nodes." + } + }, + "required": [ + "creating", + "idle", + "offline", + "preempted", + "rebooting", + "reimaging", + "running", + "starting", + "startTaskFailed", + "leavingPool", + "unknown", + "unusable", + "waitingForStartTask", + "total" + ], + "title": "The number of nodes in each node state." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "batchUrl": { + "name": "batchUrl", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "description": "The base URL for all Azure Batch service requests." + } + } +} diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListNodeAgentSkus.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListNodeAgentSkus.json new file mode 100644 index 000000000000..a6e1840f1cdc --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListNodeAgentSkus.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "batch.node.centos 7", + "verifiedImageReferences": [ + { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.2", + "version": "latest" + }, + { + "publisher": "OpenLogic", + "offer": "CentOS", + "sku": "7.1", + "version": "latest" + } + ], + "osType": "linux" + }, + { + "id": "batch.node.debian 8", + "verifiedImageReferences": [ + { + "publisher": "Credativ", + "offer": "Debian", + "sku": "8", + "version": "latest" + } + ], + "osType": "linux" + }, + { + "id": "batch.node.windows amd64", + "verifiedImageReferences": [ + { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "latest" + }, + { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-Datacenter", + "version": "latest" + } + ], + "osType": "windows" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListPoolNodeCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListPoolNodeCounts.json new file mode 100644 index 000000000000..770ba7820fa0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/AccountListPoolNodeCounts.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "pool1", + "dedicated": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 2, + "starting": 1, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 3 + } + }, + { + "poolId": "pool2", + "dedicated": { + "creating": 0, + "idle": 1, + "leavingPool": 0, + "offline": 3, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 4 + }, + "lowPriority": { + "creating": 0, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 0 + } + }, + { + "poolId": "pool3", + "dedicated": { + "creating": 0, + "idle": 5, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 4, + "running": 0, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 9 + }, + "lowPriority": { + "creating": 7, + "idle": 0, + "leavingPool": 0, + "offline": 0, + "preempted": 0, + "rebooting": 0, + "reimaging": 0, + "running": 4, + "starting": 0, + "startTaskFailed": 0, + "unknown": 0, + "unusable": 0, + "waitingForStartTask": 0, + "total": 11 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationGet.json new file mode 100644 index 000000000000..539542c8e977 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "applicationId": "my_application_id" + }, + "responses": { + "200": { + "body": { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationList.json new file mode 100644 index 000000000000..5142275d2a89 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/ApplicationList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "my_application_id", + "versions": [ + "v1.0" + ], + "displayName": "my_display_name" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateAdd.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateAdd.json new file mode 100644 index 000000000000..35c8a183f17c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateAdd.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "certificate": { + "thumbprintAlgorithm":"sha1", + "thumbprint":"0123456789abcdef0123456789abcdef01234567", + "data":"#####...", + "certificateFormat":"pfx", + "password":"certpassword" + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateCancelDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateCancelDelete.json new file mode 100644 index 000000000000..6a083a634e29 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateCancelDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateDelete.json new file mode 100644 index 000000000000..212c01844673 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateGet.json new file mode 100644 index 000000000000..7b660e043c3d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "thumbprintAlgorithm": "sha1", + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateList.json new file mode 100644 index 000000000000..b2ab6fae0dbd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/CertificateList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "url": "https://account.region.batch.azure.com/certificates(thumbprintAlgorithm=sha1,thumbprint=0123456789abcdef0123456789abcdef01234567)", + "state": "deletefailed", + "stateTransitionTime": "2014-07-31T21:12:58.236Z", + "previousState": "deleting", + "previousStateTransitionTime": "2014-07-31T21:11:58.236Z", + "publicData": "#####...", + "deleteCertificateError": { + "code": "PoolsReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned pool(s)", + "values": [ + { + "name": "Pools", + "value": "mypool1" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromNode.json new file mode 100644 index 000000000000..d4f27cdb2d1e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromNode.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromTask.json new file mode 100644 index 000000000000..6d39ecf07cb5 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileDeleteFromTask.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromNode.json new file mode 100644 index 000000000000..25d16205677b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromNode.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromTask.json new file mode 100644 index 000000000000..3784e4020a87 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetFromTask.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "task1", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromNode.json new file mode 100644 index 000000000000..c4edf92d1fe6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromNode.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "nodeId", + "filePath": "workitems\\jobId\\job-1\\task1\\wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromTask.json new file mode 100644 index 000000000000..7ce037488281 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileGetPropertiesFromTask.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "filePath": "wd\\testFile.txt", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "ocp-creation-time": "Fri, 17 Feb 2017 00:00:00 GMT", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT", + "ocp-batch-file-isdirectory": "false", + "Content-Length": "17", + "Content-Type": "application/octet-stream", + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromNode.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromNode.json new file mode 100644 index 000000000000..8d11d3116432 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromNode.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "shared", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/shared", + "isDirectory": true + }, + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_2-20140919t215614z/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromTask.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromTask.json new file mode 100644 index 000000000000..b4c9dcb3012a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/FileListFromTask.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "recursive": false + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "startup\\ProcessEnv.cmd", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\ProcessEnv.cmd", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.679195Z", + "lastModified": "2014-09-19T21:56:17.679195Z", + "contentLength": 1813, + "contentType": "application/octet-stream" + } + }, + { + "name": "startup\\stderr.txt", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId/files/startup\\stderr.txt", + "isDirectory": false, + "properties": { + "creationTime": "2014-09-19T21:56:17.5590855Z", + "lastModified": "2014-09-19T21:56:17.5590855Z", + "contentLength": 0, + "contentType": "application/octet-stream" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Basic.json new file mode 100644 index 000000000000..33c441b849cf --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Basic.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 0, + "poolInfo": { + "poolId": "poolId" + } + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Complex.json new file mode 100644 index 000000000000..805b2c92d5e1 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobAdd_Complex.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "job": { + "id": "jobId", + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "taskId", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "storageContainerUrl": "http://mystorage1.blob.core.windows.net/data?sas", + "filePath": "datafolder" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "killJobOnCompletion": false, + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "job", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "maxTasksPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDelete.json new file mode 100644 index 000000000000..024b9a41ded6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDisable.json new file mode 100644 index 000000000000..4d4553374b0a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobDisable.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobDisableParameter": { + "disableTasks": "terminate" + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobEnable.json new file mode 100644 index 000000000000..024b9a41ded6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobEnable.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGet.json new file mode 100644 index 000000000000..0b3d36095ff8 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC49F0278", + "lastModified": "2016-11-19T00:05:27.5391608Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "completed", + "stateTransitionTime": "2016-11-19T00:05:27.578581Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "endTime": "2016-11-19T00:05:27.578581Z", + "poolId": "poolId", + "terminateReason": "UserTerminate" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetLifetimeStatistics.json new file mode 100644 index 000000000000..408bff54a3d0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetLifetimeStatistics.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url":"https://account.region.batch.core.windows.net/lifetimejobstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "userCPUTime": "PT0S", + "kernelCPUTime": "PT0S", + "wallClockTime": "PT0S", + "readIOps": 0, + "writeIOps": 0, + "readIOGiB": 10.0, + "writeIOGiB": 5.0, + "numSucceededTasks": 0, + "numFailedTasks": 0, + "numTaskRetries": 0, + "waitTime": "PT0S" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetTaskCounts.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetTaskCounts.json new file mode 100644 index 000000000000..55278cf56bd7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobGetTaskCounts.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "active": 5, + "running": 7, + "completed": 4, + "succeeded": 2, + "failed": 2 + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobList.json new file mode 100644 index 000000000000..9d1c8f702477 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListFromJobSchedule.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListFromJobSchedule.json new file mode 100644 index 000000000000..f191a9d4350a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListFromJobSchedule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobId", + "url": "https://account.region.batch.azure.com/jobs/jobId", + "eTag": "0x8D4100FC46D5BF4", + "lastModified": "2016-11-19T00:05:27.2137716Z", + "creationTime": "2016-11-19T00:05:25.311915Z", + "state": "active", + "stateTransitionTime": "2016-11-19T00:05:27.2137716Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-19T00:05:26.88777Z", + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + }, + "executionInfo": { + "startTime": "2016-11-19T00:05:25.3309105Z", + "poolId": "poolId" + }, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListPreparationAndReleaseTaskStatus.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListPreparationAndReleaseTaskStatus.json new file mode 100644 index 000000000000..597059007488 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobListPreparationAndReleaseTaskStatus.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "poolId": "poolId", + "nodeId": "tvm-2167304207_1-20140905t174658z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z", + "jobPreparationTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobpreptask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobpreptask", + "exitCode": 0, + "retryCount": 0 + }, + "jobReleaseTaskExecutionInfo": { + "state": "completed", + "startTime": "2015-05-01T10:20:31Z", + "endTime": "2015-05-02T20:12:42Z", + "taskRootDirectory": "tasks/myjob/job-1/myjobreleasetask", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2167304207_1-20140905t174658z/files/tasks/myjob/job-1/myjobreleasetask", + "exitCode": 0 + } + } + ], + "odata.nextLink": "https://account.region.batch.azure.com/jobs/myjob/jobpreparationandreleasestatus?$skipToken=tvm-2167304207_1-20140905t174658z&api-version=2018-12-01.8.0" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobPatch.json new file mode 100644 index 000000000000..029457c4912d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobPatch.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobPatchParameter": { + "priority":100, + "constraints": { + "maxWallClockTime":"PT1H", + "maxTaskRetryCount":-1 + }, + "poolInfo": { + "poolId":"poolId" + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Basic.json new file mode 100644 index 000000000000..7b31cc83e084 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Basic.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "recurrenceInterval":"PT5M" + }, + "jobSpecification": { + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Complex.json new file mode 100644 index 000000000000..eb61a71e9e06 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleAdd_Complex.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "cloudJobSchedule": { + "id": "jobScheduleId", + "schedule": { + "doNotRunUntil": "2014-09-10T02:30:00.000Z", + "doNotRunAfter": "2014-09-10T06:30:00.000Z", + "startWindow": "PT1M", + "recurrenceInterval": "PT5M" + }, + "jobSpecification": { + "priority": 100, + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": -1 + }, + "jobManagerTask": { + "id": "mytask1", + "commandLine": "myprogram.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram.exe?sas", + "filePath": "myprogram.exe" + }, + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/test.txt?sas", + "filePath": "test.txt" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "constraints": { + "maxWallClockTime": "PT1H", + "maxTaskRetryCount": 0, + "retentionTime": "PT1H" + }, + "killJobOnCompletion": true, + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "runExclusive": true + }, + "poolInfo": { + "autoPoolSpecification": { + "autoPoolIdPrefix": "mypool", + "poolLifetimeOption": "jobschedule", + "pool": { + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + }, + "resizeTimeout": "PT15M", + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "maxTasksPerNode": 2, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "enableAutoScale": false, + "enableInterNodeCommunication": true, + "startTask": { + "commandLine": "myprogram2.exe", + "resourceFiles": [ + { + "httpUrl": "http://mystorage1.blob.core.windows.net/scripts/myprogram2.exe?sas", + "filePath": "myprogram2.exe" + } + ], + "environmentSettings": [ + { + "name": "myvariable", + "value": "myvalue" + } + ], + "userIdentity": { + "autoUser": { + "scope": "task", + "elevationLevel": "admin" + } + }, + "maxTaskRetryCount": 2, + "waitForSuccess": true + }, + "certificateReferences": [ + { + "thumbprint": "0123456789abcdef0123456789abcdef01234567", + "thumbprintAlgorithm": "sha1", + "storeLocation": "localmachine", + "storeName": "Root", + "visibility": [ + "task" + ] + } + ], + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + } + } + }, + "metadata": [ + { + "name": "myproperty", + "value": "myvalue" + } + ] + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDelete.json new file mode 100644 index 000000000000..34dfc39ea549 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDisable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDisable.json new file mode 100644 index 000000000000..522c2680ecbe --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleDisable.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleEnable.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleEnable.json new file mode 100644 index 000000000000..522c2680ecbe --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleEnable.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleExists.json new file mode 100644 index 000000000000..a40dffe40365 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleExists.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + }, + "404": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleGet.json new file mode 100644 index 000000000000..1b997dd3acc3 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "jobScheduleId", + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId", + "eTag": "0x8D40FFD2E848323", + "lastModified": "2016-11-18T21:52:24.7661347Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "completed", + "stateTransitionTime": "2016-11-18T21:52:24.8371778Z", + "previousState": "active", + "previousStateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobschedules/jobScheduleId:job-1", + "id": "jobScheduleId:job-1" + }, + "endTime": "2016-11-18T21:52:24.8371778Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleList.json new file mode 100644 index 000000000000..895c12ac3af9 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleList.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "jobSchedule1", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule1", + "eTag": "0x8D40FFD2E10996A", + "lastModified": "2016-11-18T21:52:24.0064874Z", + "creationTime": "2016-11-18T21:52:22.5431125Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:52:24.0064874Z", + "previousState": "disabled", + "previousStateTransitionTime": "2016-11-18T21:52:23.6471782Z", + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + }, + "executionInfo": { + "recentJob": { + "url": "https://account.region.batch.azure.com/jobs/jobSchedule1:job-1", + "id": "jobSchedule1:job-1" + } + } + }, + { + "id": "jobSchedule2", + "url": "https://account.region.batch.azure.com/jobschedules/jobSchedule2", + "eTag": "0x8D40FFCFF760B51", + "lastModified": "2016-11-18T21:51:05.8184017Z", + "creationTime": "2016-11-18T21:51:05.8184017Z", + "state": "active", + "stateTransitionTime": "2016-11-18T21:51:05.8184017Z", + "schedule": { + "doNotRunUntil": "2020-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "onAllTasksComplete": "noaction", + "onTaskFailure": "noaction", + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "testPool2" + } + }, + "executionInfo": { + "nextRunTime": "2020-01-01T12:30:00Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobSchedulePatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobSchedulePatch.json new file mode 100644 index 000000000000..0351bd5991eb --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobSchedulePatch.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobSchedulePatchParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleTerminate.json new file mode 100644 index 000000000000..34dfc39ea549 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleTerminate.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleUpdate.json new file mode 100644 index 000000000000..a5c6d9ac73a0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobScheduleUpdate.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobScheduleId": "jobScheduleId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobScheduleUpdateParameter": { + "schedule": { + "doNotRunUntil": "2025-01-01T12:30:00Z" + }, + "jobSpecification": { + "priority": 0, + "usesTaskDependencies": false, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "poolInfo": { + "poolId": "poolId" + } + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobTerminate.json new file mode 100644 index 000000000000..ec8dc252f4d7 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobTerminate.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobTerminateParameter": { + "terminateReason": "User supplied termination reason" + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobUpdate.json new file mode 100644 index 000000000000..eb27f96b791c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/JobUpdate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "jobUpdateParameter": { + "priority":100, + "constraints": { + "maxWallClockTime":"PT1H", + "maxTaskRetryCount":-1 + }, + "poolInfo": { + "poolId":"poolId" + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeAddUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeAddUser.json new file mode 100644 index 000000000000..5aadbf37549c --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeAddUser.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "user": { + "name": "userName", + "isAdmin": false, + "expiryTime": "2017-08-01T00:00:00Z", + "password": "Password" + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDeleteUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDeleteUser.json new file mode 100644 index 000000000000..7a8d881aaafd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDeleteUser.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDisableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDisableScheduling.json new file mode 100644 index 000000000000..6ff8ab68c932 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeDisableScheduling.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeDisableSchedulingParameter": { + "nodeDisableSchedulingOption": "terminate" + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeEnableScheduling.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeEnableScheduling.json new file mode 100644 index 000000000000..6d7fc39bc5ad --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeEnableScheduling.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteDesktop.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteDesktop.json new file mode 100644 index 000000000000..20e7b482d66e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteDesktop.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "This is actually a byte stream. This request/response is being presented as a string for readability in the example" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteLoginSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteLoginSettings.json new file mode 100644 index 000000000000..c615304540f6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGetRemoteLoginSettings.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "remoteLoginIPAddress": "1.1.1.1", + "remoteLoginPort": 50000 + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGet_Basic.json new file mode 100644 index 000000000000..39558aac6b67 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeGet_Basic.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "poolId": "poolId", + "nodeId": "tvm-1695681911_2-20161122t193202z", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T19:37:28.623369Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeList.json new file mode 100644 index 000000000000..d43c7b5fba44 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeList.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "tvm-1695681911_1-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_1-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T22:22:27.2236818Z", + "lastBootTime": "2016-11-22T22:22:24.4634125Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_1-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T22:22:27.2236818Z", + "endTime": "2016-11-22T22:22:27.567189Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_2-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_2-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:37:31.4285526Z", + "lastBootTime": "2016-11-22T19:37:28.623369Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_2-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:37:31.4285526Z", + "endTime": "2016-11-22T19:37:31.838028Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + }, + { + "id": "tvm-1695681911_3-20161122t193202z", + "url": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-1695681911_3-20161122t193202z", + "state": "idle", + "schedulingState": "enabled", + "stateTransitionTime": "2016-11-22T19:36:51.0013378Z", + "lastBootTime": "2016-11-22T19:36:48.21721Z", + "allocationTime": "2016-11-22T19:32:02.8155319Z", + "ipAddress": "1.1.1.1", + "affinityId": "TVM:tvm-1695681911_3-20161122t193202z", + "vmSize": "small", + "totalTasksRun": 0, + "totalTasksSucceeded": 0, + "runningTasksCount": 0, + "isDedicated": true, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "startTaskInfo": { + "state": "completed", + "startTime": "2016-11-22T19:36:51.0013378Z", + "endTime": "2016-11-22T19:36:51.2363447Z", + "exitCode": 0, + "retryCount": 0 + }, + "nodeAgentInfo": { + "version": "1.2.0.0", + "lastUpdateTime": "2016-11-22T22:22:24.4634125Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReboot.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReboot.json new file mode 100644 index 000000000000..e8263d59b47e --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReboot.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRebootParameter": { + "nodeRebootOption": "terminate" + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReimage.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReimage.json new file mode 100644 index 000000000000..0fa3d396d9cd --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeReimage.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161122t193202z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeReimageParameter": { + "nodeReimageOption": "terminate" + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUpdateUser.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUpdateUser.json new file mode 100644 index 000000000000..143c1e19372b --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUpdateUser.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "userName": "userName", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeUpdateUserParameter": { + "password": "12345", + "expiryTime": "2016-11-27T00:45:48.7320857Z" + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUploadBatchServiceLogs.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUploadBatchServiceLogs.json new file mode 100644 index 000000000000..ce0173e4e162 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/NodeUploadBatchServiceLogs.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "nodeId": "tvm-1695681911_1-20161121t182739z", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "uploadBatchServiceLogsConfiguration": { + "containerUrl": "https://somestorageacct.blob.core.windows.net/batch-compute-node-logs?se=2017-12-09T18%3A51%3A00Z&sp=w&sv=2016-05-31&sr=c&sig", + "startTime": "2017-11-27T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "virtualDirectoryName": "poolId/tvm-1695681911-1-20161121t182739z/0795539d-82fe-48e3-bbff-2964905b6de0", + "numberOfFilesUploaded": 8 + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_CloudServiceConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_CloudServiceConfiguration.json new file mode 100644 index 000000000000..b8622fff78d6 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_CloudServiceConfiguration.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "poolId", + "vmSize": "small", + "cloudServiceConfiguration": { + "osFamily": "4" + }, + "resizeTimeout":"PT15M", + "targetDedicatedNodes":5, + "targetLowPriorityNodes":0, + "maxTasksPerNode":3, + "taskSchedulingPolicy": { + "nodeFillType":"spread" + }, + "enableAutoScale":false, + "enableInterNodeCommunication":true, + "metadata": [ { + "name":"myproperty", + "value":"myvalue" + } ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfiguration.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..ddbf57d821e3 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfiguration.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04" + }, + "resizeTimeout":"PT15M", + "targetDedicatedNodes":5, + "targetLowPriorityNodes":0, + "maxTasksPerNode":3, + "taskSchedulingPolicy": { + "nodeFillType":"spread" + }, + "enableAutoScale":false, + "enableInterNodeCommunication":true, + "metadata": [ { + "name":"myproperty", + "value":"myvalue" + } ] + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json new file mode 100644 index 000000000000..d11343d1ccd3 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolAdd_VirtualMachineConfigurationWithContainers.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "pool": { + "id": "pool2", + "vmSize": "standard_a1", + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04", + "containerConfiguration": { + "type": "dockerCompatible", + "containerImageNames": [ + "busybox" + ] + } + }, + "resizeTimeout":"PT15M", + "targetDedicatedNodes":5, + "targetLowPriorityNodes":0, + "maxTasksPerNode":3, + "taskSchedulingPolicy": { + "nodeFillType":"spread" + }, + "enableAutoScale":false + } + }, + "responses": { + "201": { + "request-id": "00000000-0000-0000-0000-000000000000", + "ETag": "0x8D45765A6A2DC04", + "Last-Modified": "Fri, 17 Feb 2017 00:00:00 GMT" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDelete.json new file mode 100644 index 000000000000..13ee9041af1f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDisableAutoScale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..b9526004c6eb --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolDisableAutoScale.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEnableAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEnableAutoscale.json new file mode 100644 index 000000000000..42e91abd691a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEnableAutoscale.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEnableAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=0", + "autoScaleEvaluationInterval": "PT8M" + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEvaluateAutoscale.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEvaluateAutoscale.json new file mode 100644 index 000000000000..08b16d6e53aa --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolEvaluateAutoscale.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolEvaluateAutoScaleParameter": { + "autoScaleFormula": "$TargetDedicated=1" + } + }, + "responses": { + "200": { + "body": { + "timestamp": "2016-11-22T19:39:28.5246331Z", + "results": "$TargetDedicated=1;$NodeDeallocationOption=requeue" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolExists.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolExists.json new file mode 100644 index 000000000000..d2c32e138f2a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolExists.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + }, + "404": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGetLifetimeStatistics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGetLifetimeStatistics.json new file mode 100644 index 000000000000..51e9309f2ec5 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGetLifetimeStatistics.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "url":"https://account.region.batch.core.windows.net/lifetimepoolstats", + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "usageStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "dedicatedCoreTime": "PT0S" + }, + "resourceStats": { + "startTime": "2014-08-01T18:30:00.4345729Z", + "lastUpdateTime": "2014-08-04T18:30:00.4345729Z", + "avgCPUPercentage": 40.0, + "avgMemoryGiB": 2.0, + "peakMemoryGiB": 4.0, + "avgDiskGiB": 125.0, + "peakDiskGiB": 240.0, + "diskReadIOps": 0, + "diskWriteIOps": 0, + "diskReadGiB": 10.0, + "diskWriteGiB": 1.0, + "networkReadGiB": 20.0, + "networkWriteGiB": 25.0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGet_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGet_Basic.json new file mode 100644 index 000000000000..eee497c5715a --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolGet_Basic.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "pool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "pool", + "url": "https://account.region.batch.azure.com/pools/pool", + "eTag": "0x8D413091E739A56", + "lastModified": "2016-11-22T18:55:25.2608598Z", + "creationTime": "2016-11-22T18:55:24.2632496Z", + "state": "active", + "stateTransitionTime": "2016-11-22T18:55:24.2632496Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-22T18:55:24.8154041Z", + "vmSize": "standard_a1", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "16.04.0-LTS", + "version": "latest" + }, + "nodeAgentSKUId": "batch.node.ubuntu 16.04" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolListUsageMetrics.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolListUsageMetrics.json new file mode 100644 index 000000000000..0bcbd2f35cf2 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolListUsageMetrics.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "startTime": "2013-04-01T00:00:00Z", + "endTime": "2013-04-01T00:30:00Z", + "poolId": "p1", + "vmSize": "a1", + "totalCoreHours": 39.384838 + }, + { + "startTime": "2013-04-01T00:30:00Z", + "endTime": "2013-04-01T01:00:00Z", + "poolId": "p2", + "vmSize": "a8", + "totalCoreHours": 3039.384838 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolList_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolList_Basic.json new file mode 100644 index 000000000000..57f02845f600 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolList_Basic.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testPool", + "url": "https://accountname.region.batch.azure.com/pools/testPool", + "eTag": "0x8D4123BEF87D233", + "lastModified": "2016-11-21T18:26:39.7108787Z", + "creationTime": "2016-11-21T18:26:39.7108787Z", + "state": "active", + "stateTransitionTime": "2016-11-21T18:26:39.7108787Z", + "allocationState": "steady", + "allocationStateTransitionTime": "2016-11-21T18:27:40.287803Z", + "vmSize": "small", + "resizeTimeout": "PT15M", + "currentDedicatedNodes": 3, + "currentLowPriorityNodes": 0, + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "enableAutoScale": false, + "enableInterNodeCommunication": false, + "startTask": { + "commandLine": "cmd /c echo hello", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "maxTaskRetryCount": 0, + "waitForSuccess": false + }, + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "spread" + }, + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "*" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolPatch.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolPatch.json new file mode 100644 index 000000000000..b7dbb4cc5c33 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolPatch.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolPatchParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolRemoveNodes.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolRemoveNodes.json new file mode 100644 index 000000000000..8cb2f9dbac62 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolRemoveNodes.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "nodeRemoveParameter": { + "nodeList": [ + "tvm-1695681911_1-20161122t224741z", + "tvm-1695681911_2-20161122t224741z" + ] + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolResize.json new file mode 100644 index 000000000000..05aea09c4547 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolResize.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "resizePool", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolResizeParameter": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0 + } + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolStopResize.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolStopResize.json new file mode 100644 index 000000000000..13ee9041af1f --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolStopResize.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "202": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolUpdate.json new file mode 100644 index 000000000000..a2b69e44a7a0 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/PoolUpdate.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "poolId": "poolId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "poolUpdatePropertiesParameter": { + "startTask": { + "commandLine": "/bin/bash -c 'echo start task'" + }, + "certificateReferences": [], + "applicationPackageReferences": [], + "metadata": [] + } + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Basic.json new file mode 100644 index 000000000000..91ab5af06dda --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Basic.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "simple1", + "commandLine": "cmd /c dir /s" + }, + { + "id": "simple2", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "status": "success", + "taskId": "simple1", + "eTag": "0x8D3D623CD661246", + "lastModified": "2016-09-06T07:02:44.7589958Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple1" + }, + { + "status": "success", + "taskId": "simple2", + "eTag": "0x8D3D623CD7072CC", + "lastModified": "2016-09-06T07:02:44.8270028Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple2" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Complex.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Complex.json new file mode 100644 index 000000000000..55f7e334ca48 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAddCollection_Complex.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskCollection": { + "value": [ + { + "id": "complex1", + "commandLine": "cmd /c dir /s", + "resourceFiles": [ + { + "autoStorageContainerName": "containerName", + "filePath": "data" + } + ], + "environmentSettings": [ + { + "name": "env1", + "value": "value1" + }, + { + "name": "env2", + "value": "value2" + } + ], + "affinityInfo": { + "affinityId": "affinityId" + }, + "constraints": { + "maxWallClockTime": "P1D", + "retentionTime": "P2D", + "maxTaskRetryCount": 5 + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating", + "commonResourceFiles": [ + { + "httpUrl": "https://common.blob.core.windows.net/", + "filePath": "common.exe" + } + ] + } + }, + { + "id": "simple3", + "commandLine": "cmd /c dir /s" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "taskId": "simple3", + "status": "success", + "eTag": "0x8D3D623CE295629", + "lastModified": "2016-09-06T07:02:46.0386857Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/simple3" + }, + { + "taskId": "complex1", + "status": "success", + "eTag": "0x8D3D623CE29A412", + "lastModified": "2016-09-06T07:02:46.0406802Z", + "location": "https://account.region.batch.azure.com/jobs/jobId/tasks/complex1" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_Basic.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_Basic.json new file mode 100644 index 000000000000..291f4b51137d --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_Basic.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "task1", + "commandLine": "cmd /c echo task1" + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ContainerSettings.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ContainerSettings.json new file mode 100644 index 000000000000..e8aeed87c856 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ContainerSettings.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "bash -c 'echo hello'", + "containerSettings": { + "imageName": "ubuntu", + "containerRunOptions": "--rm" + }, + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ExitConditions.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ExitConditions.json new file mode 100644 index 000000000000..6b5d1464bb98 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskAdd_ExitConditions.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "task": { + "id": "taskId", + "commandLine": "cmd /c exit 3", + "exitConditions": { + "exitCodeRanges": [ + { + "start": 2, + "end": 4, + "exitOptions": { + "jobAction": "terminate" + } + } + ] + }, + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + } + } + }, + "responses": { + "201": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskDelete.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskDelete.json new file mode 100644 index 000000000000..a3aea6d28715 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskGet.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskGet.json new file mode 100644 index 000000000000..8d68fac9c1be --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "id": "testTask", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId", + "eTag": "0x8D3D62350711C55", + "creationTime": "2016-09-06T06:59:15.1161429Z", + "lastModified": "2016-09-06T06:59:15.1161429Z", + "state": "active", + "stateTransitionTime": "2016-09-06T06:59:15.1161429Z", + "commandLine": "cmd /c hostname", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "multiInstanceSettings": { + "numberOfInstances": 3, + "coordinationCommandLine": "cmd /c echo coordinating" + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskList.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskList.json new file mode 100644 index 000000000000..bb0bd5c0c940 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskList.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "task1", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1", + "eTag": "0x8D4125FD1A825A4", + "creationTime": "2016-11-21T22:43:31.4733476Z", + "lastModified": "2016-11-21T22:43:31.4733476Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.4733476Z", + "commandLine": "cmd /c echo task1", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 0 + }, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + }, + { + "id": "task2", + "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2", + "eTag": "0x8D4125FD2153345", + "creationTime": "2016-11-21T22:43:31.6736345Z", + "lastModified": "2016-11-21T22:43:32.1880389Z", + "state": "active", + "stateTransitionTime": "2016-11-21T22:43:31.6736345Z", + "commandLine": "cmd /c echo task2", + "userIdentity":{ + "autoUser": { + "scope": "task", + "elevationLevel": "nonadmin" + } + }, + "constraints": { + "maxWallClockTime": "P10675199DT2H48M5.4775807S", + "retentionTime": "P10675199DT2H48M5.4775807S", + "maxTaskRetryCount": 3 + }, + "executionInfo": { + "retryCount": 0, + "requeueCount": 0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskListSubtasks.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskListSubtasks.json new file mode 100644 index 000000000000..904d69561054 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskListSubtasks.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": 1, + "startTime": "2016-09-06T06:59:16.3139271Z", + "endTime": "2016-09-06T06:59:20.0242024Z", + "state": "completed", + "stateTransitionTime": "2016-09-06T06:59:20.0242024Z", + "previousState": "running", + "previousStateTransitionTime": "2016-09-06T06:59:16.3139271Z", + "exitCode": 0, + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_3-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_3-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\1", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_3-20160905t051718z/files//workitems/jobId/job-1/taskId/1" + } + }, + { + "id": 2, + "startTime": "2016-09-06T06:59:16.9702844Z", + "state": "running", + "stateTransitionTime": "2016-09-06T06:59:16.9702844Z", + "nodeInfo": { + "affinityId": "TVM:tvm-2544493925_2-20160905t051718z", + "nodeUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z", + "poolId": "mpiPool", + "nodeId": "tvm-2544493925_2-20160905t051718z", + "taskRootDirectory": "\\workitems\\jobId\\job-1\\taskId\\2", + "taskRootDirectoryUrl": "https://account.region.batch.azure.com/pools/poolId/nodes/tvm-2544493925_2-20160905t051718z/files//workitems/jobId/job-1/taskId/2" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskReactivate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskReactivate.json new file mode 100644 index 000000000000..9f3a2373a458 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskReactivate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskTerminate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskTerminate.json new file mode 100644 index 000000000000..9f3a2373a458 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskTerminate.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT" + }, + "responses": { + "204": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskUpdate.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskUpdate.json new file mode 100644 index 000000000000..f5924b047016 --- /dev/null +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/examples/TaskUpdate.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "batchUrl": "account.region.batch.azure.com", + "api-version": "2018-12-01.8.0", + "jobId": "jobId", + "taskId": "taskId", + "client-request-id": "00000000-0000-0000-0000-000000000000", + "ocp-date": "Fri, 17 Feb 2017 00:00:00 GMT", + "taskUpdateParameter": { + "constraints": { + "maxWallClockTime":"PT1H", + "maxTaskRetryCount":3, + "retentionTime":"PT1H" + } + } + }, + "responses": { + "200": { + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/batch/data-plane/readme.go.md b/specification/batch/data-plane/readme.go.md index 8a4fd8de3a49..6a65f3fb0155 100644 --- a/specification/batch/data-plane/readme.go.md +++ b/specification/batch/data-plane/readme.go.md @@ -16,6 +16,16 @@ batch: - tag: package-2017-05.5.0 - tag: package-2018-03.6.1 - tag: package-2018-08.7.0 + - tag: package-2018-12.8.0 +``` + +### Tag: package-2018-12.8.0 and go + +These settings apply only when `--tag=package-2018-12.8.0 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2018-12.8.0' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/2018-12-01.8.0/$(namespace) ``` ### Tag: package-2018-08.7.0 and go diff --git a/specification/batch/data-plane/readme.md b/specification/batch/data-plane/readme.md index d4b574b3817e..1a02fcd81584 100644 --- a/specification/batch/data-plane/readme.md +++ b/specification/batch/data-plane/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Batch API. ``` yaml openapi-type: data-plane -tag: package-2018-08.7.0 +tag: package-2018-12.8.0 +``` + +### Tag: package-2018-12.8.0 + +These settings apply only when `--tag=package-2018-12.8.0` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12.8.0' +input-file: +- Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json ``` ### Tag: package-2018-08.7.0 From 115710d5a6f7f7ab6854c34c588064f3ca91d91d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 19:55:01 -0500 Subject: [PATCH 383/464] fix: Example storsimple8000series\resource-manager\Microsoft.StorSimple (#4853) --- .../stable/2017-06-01/examples/AlertsClear.json | 2 +- .../stable/2017-06-01/examples/AlertsListByManager.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsClear.json b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsClear.json index 0da52db17861..82ca7d973a2f 100644 --- a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsClear.json +++ b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsClear.json @@ -5,7 +5,7 @@ "managerName": "ManagerForSDKTest1", "api-version": "2017-06-01", "$filter": "status%20eq%20'Active'%20and%20appearedOnTime%20ge%20'2017-06-09T18:30:00Z'%20and%20appearedOnTime%20le%20'2017-06-19T18:30:00Z'%20and%20sourceType%20eq%20'Device'%20and%20sourceName%20eq%20'Device05ForSDKTest'", - "$top": "100", + "$top": 100, "parameters": { "alerts": [ "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/ResourceGroupForSDKTest/providers/Microsoft.StorSimple/managers/ManagerForSDKTest1/devices/Device05ForSDKTest/alerts/308b5bd2-824b-436f-840e-44bde075ef33" diff --git a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsListByManager.json b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsListByManager.json index 7ad5ed6e5f3b..ea388ee04d39 100644 --- a/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsListByManager.json +++ b/specification/storsimple8000series/resource-manager/Microsoft.StorSimple/stable/2017-06-01/examples/AlertsListByManager.json @@ -5,7 +5,7 @@ "managerName": "ManagerForSDKTest1", "api-version": "2017-06-01", "$filter": "status%20eq%20'Active'%20and%20appearedOnTime%20ge%20'2017-06-09T18:30:00Z'%20and%20appearedOnTime%20le%20'2017-06-19T18:30:00Z'%20and%20sourceType%20eq%20'Device'%20and%20sourceName%20eq%20'Device05ForSDKTest'", - "$top": "100" + "$top": 100 }, "responses": { "200": { From 1661ead6a54525b59ee90a6ed97598bd19291705 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 19:56:02 -0500 Subject: [PATCH 384/464] fix: Examples adhybridhealthservice\resource-manager\Microsoft.ADHybridHealthService (#4845) - takeCount is defined as integer - additionalInformation is object not array - normalize indentation --- .../examples/AddomainServiceMembers.json | 150 +++++++++--------- .../stable/2014-01-01/examples/Alerts.json | 120 +++++++------- .../2014-01-01/examples/Server_Alerts.json | 44 +++-- 3 files changed, 155 insertions(+), 159 deletions(-) diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json index c48d90f0e049..b9ddec1b0d2d 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/AddomainServiceMembers.json @@ -2,7 +2,7 @@ "parameters": { "serviceName": "sampleServiceName", "isGroupbySite": true, - "takeCount": "1", + "takeCount": 1, "nextPartitionKey": " ", "nextRowKey": " ", "api-version": "2014-01-01" @@ -10,80 +10,80 @@ "responses": { "200": { "body": { - "value": [ - { - "domainName": "sampleDomainName", - "siteName": "Default-First-Site-Name", - "addsRoles": [ - "sampleRole" - ], - "gcReachable": true, - "isAdvertising": true, - "pdcReachable": true, - "sysvolState": true, - "dcTypes": [ - "GC" - ], - "lastReboot": "2018-04-28T23:17:00.511864Z", - "lastDisabled": "2018-04-28T23:17:00.511864Z", - "lastUpdated": "2018-04-30T18:00:41.6956022Z", - "activeAlerts": 0, - "resolvedAlerts": 0, - "createdDate": "2018-04-28T23:17:00.511864Z", - "disabled": false, - "dimensions": [ - { - "key": "key1", - "value": "value1" - } - ], - "additionalInformation": "SampleAdditionalInformation", - "tenantId": "00000000-0000-0000-0000-000000000000", - "serviceId": "serviceIdGuid", - "serviceMemberId": "ServiceMemberIdGuid", - "machineId": "machineIdGuid", - "machineName": "sampleMachineName", - "role": "SampleRole", - "status": "Healthy", - "properties": [ - { - "key": "key1", - "value": "value1" - } - ], - "installedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "recommendedQfes": [{ - "kbName": "KB3019978", - "link": "SampleLink", - "installedDate": "2016-11-06T04:00:00Z" - }], - "monitoringConfigurationsComputed": [ - { - "key": "key1", - "value": "value1" - } - ], - "monitoringConfigurationsCustomized": [ - { - "key": "key1", - "value": "value1" - } - ], - "osVersion": "osVersion", - "osName": "osName", - "disabledReason": 0, - "serverReportedMonitoringLevel": "Off", - "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null - } + "value": [ + { + "domainName": "sampleDomainName", + "siteName": "Default-First-Site-Name", + "addsRoles": [ + "sampleRole" + ], + "gcReachable": true, + "isAdvertising": true, + "pdcReachable": true, + "sysvolState": true, + "dcTypes": [ + "GC" + ], + "lastReboot": "2018-04-28T23:17:00.511864Z", + "lastDisabled": "2018-04-28T23:17:00.511864Z", + "lastUpdated": "2018-04-30T18:00:41.6956022Z", + "activeAlerts": 0, + "resolvedAlerts": 0, + "createdDate": "2018-04-28T23:17:00.511864Z", + "disabled": false, + "dimensions": [ + { + "key": "key1", + "value": "value1" + } + ], + "additionalInformation": "SampleAdditionalInformation", + "tenantId": "00000000-0000-0000-0000-000000000000", + "serviceId": "serviceIdGuid", + "serviceMemberId": "ServiceMemberIdGuid", + "machineId": "machineIdGuid", + "machineName": "sampleMachineName", + "role": "SampleRole", + "status": "Healthy", + "properties": [ + { + "key": "key1", + "value": "value1" + } + ], + "installedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "recommendedQfes": [{ + "kbName": "KB3019978", + "link": "SampleLink", + "installedDate": "2016-11-06T04:00:00Z" + }], + "monitoringConfigurationsComputed": [ + { + "key": "key1", + "value": "value1" + } + ], + "monitoringConfigurationsCustomized": [ + { + "key": "key1", + "value": "value1" + } + ], + "osVersion": "osVersion", + "osName": "osName", + "disabledReason": 0, + "serverReportedMonitoringLevel": "Off", + "lastServerReportedMonitoringLevelChange": "2018-04-30T18:00:41.6956022Z" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null } } + } } diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json index 416e472d17bb..7fd6f4aa31d6 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Alerts.json @@ -1,73 +1,71 @@ { "parameters": { "serviceName": "sampleServiceName", - "state": "Active", + "state": "Active", "api-version": "2014-01-01" }, "responses": { "200": { "body": { - "value": [ - { - "alertId": "SampleAlertId", - "level": "Error", - "state": "Active", - "shortName": "SampleAlertName", - "displayName": "SampleAlertDisplayName", - "description": "SampleAlertDescription", - "remediation": "SampleAlertRemediation", - "relatedLinks": [ - { - "title": "SampleTitle1", - "url": "SampleUrl1" - }, - { - "title": "SampleTilte2", - "url": "SampleUrl2" - } - ], - "scope": "SampleScope", - "additionalInformation": [ - { - "titleName": "SampleAdditionalInfo", - "titleValue": "SampleTitle", - "properties": [ - { - "key": "Property1", - "value": "Value1" + "value": [ + { + "alertId": "SampleAlertId", + "level": "Error", + "state": "Active", + "shortName": "SampleAlertName", + "displayName": "SampleAlertDisplayName", + "description": "SampleAlertDescription", + "remediation": "SampleAlertRemediation", + "relatedLinks": [ + { + "title": "SampleTitle1", + "url": "SampleUrl1" + }, + { + "title": "SampleTilte2", + "url": "SampleUrl2" + } + ], + "scope": "SampleScope", + "additionalInformation": { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true }, - { - "key": "Property2", - "value": "Value2" - } - ], - "hasProperties": true - } - ], - "createdDate": "2018-04-10T03:12:23.4408944Z", - "resolvedDate": "2018-04-10T03:12:23.4408944Z", - "lastUpdated": "2018-04-30T19:24:42.1946017Z", - "monitorRoleType": "SampleRole", - "activeAlertProperties": [ - { - "key": "ActiveProperty1", - "value": "Value1" - } - ], - "resolvedAlertProperties": [ - { - "key": "ResolvedProperty1", - "value": "Value1" - } - ], - "tenantId": "SampleTenantId", - "serviceId": "SampleServiceId", - "serviceMemberId": "SampleServiceMemberId" - } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null + "createdDate": "2018-04-10T03:12:23.4408944Z", + "resolvedDate": "2018-04-10T03:12:23.4408944Z", + "lastUpdated": "2018-04-30T19:24:42.1946017Z", + "monitorRoleType": "SampleRole", + "activeAlertProperties": [ + { + "key": "ActiveProperty1", + "value": "Value1" + } + ], + "resolvedAlertProperties": [ + { + "key": "ResolvedProperty1", + "value": "Value1" + } + ], + "tenantId": "SampleTenantId", + "serviceId": "SampleServiceId", + "serviceMemberId": "SampleServiceMemberId" + } + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null } } } diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json index a2836858b7bb..d22bfaa9d6ea 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/examples/Server_Alerts.json @@ -2,13 +2,13 @@ "parameters": { "serviceName": "sampleServiceName", "serviceMemberId": "SampleServiceMemberId", - "state": "Active", + "state": "Active", "api-version": "2014-01-01" }, "responses": { "200": { "body": { - "value": [ + "value": [ { "alertId": "SampleAlertId", "level": "Error", @@ -28,23 +28,21 @@ } ], "scope": "SampleScope", - "additionalInformation": [ - { - "titleName": "SampleAdditionalInfo", - "titleValue": "SampleTitle", - "properties": [ - { - "key": "Property1", - "value": "Value1" - }, - { - "key": "Property2", - "value": "Value2" - } - ], - "hasProperties": true - } - ], + "additionalInformation": { + "titleName": "SampleAdditionalInfo", + "titleValue": "SampleTitle", + "properties": [ + { + "key": "Property1", + "value": "Value1" + }, + { + "key": "Property2", + "value": "Value2" + } + ], + "hasProperties": true + }, "createdDate": "2018-04-10T03:12:23.4408944Z", "resolvedDate": "2018-04-10T03:12:23.4408944Z", "lastUpdated": "2018-04-30T19:24:42.1945017Z", @@ -65,10 +63,10 @@ "serviceId": "SampleServiceId", "serviceMemberId": "SampleServiceMemberId" } - ], - "nextLink": null, - "totalCount": 0, - "continuationToken": null + ], + "nextLink": null, + "totalCount": 0, + "continuationToken": null } } } From 4e8a3a2baeb4fc1707764290138f723b8028f7e0 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 19:56:37 -0500 Subject: [PATCH 385/464] typo: cognitiveservices/data-plane/VisualSearch (#4829) - Inisghts -> Insights --- .../data-plane/VisualSearch/preview/v1.0/VisualSearch.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json index 8c89311b367b..d26e8478ee01 100644 --- a/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json +++ b/specification/cognitiveservices/data-plane/VisualSearch/preview/v1.0/VisualSearch.json @@ -293,7 +293,7 @@ "type": "string" }, "insightsMetadata": { - "description": "A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInisghtsToken in a subsequent Visual Search API call to get the list of shopping websites.", + "description": "A count of the number of websites where you can shop or perform other actions related to the image. For example, if the image is of an apple pie, this object includes a count of the number of websites where you can buy an apple pie. To indicate the number of offers in your UX, include badging such as a shopping cart icon that contains the count. When the user clicks on the icon, use imageInsightsToken in a subsequent Visual Search API call to get the list of shopping websites.", "$ref": "#/definitions/ImagesImageMetadata", "readOnly": true }, @@ -308,7 +308,7 @@ "type": "string" }, "visualWords": { - "description": "For interal use only.", + "description": "For internal use only.", "readOnly": true, "type": "string" } From 33a086facc04b1a932e81bb30650b141518220f8 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 10 Dec 2018 19:57:13 -0500 Subject: [PATCH 386/464] fix: Package name for Microsoft Docs Authoring (#4826) --- .vscode/extensions.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index d4550a2026f8..d09daa2d55e0 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,6 +1,6 @@ { "recommendations": [ "EditorConfig.EditorConfig", - "vscode-docs-authoring" + "docsmsft.docs-authoring-pack" ] } From 6d123b9013ca8fe4897b86e6a88eafa31869ab88 Mon Sep 17 00:00:00 2001 From: Mahsa Mirza Date: Mon, 10 Dec 2018 17:05:18 -0800 Subject: [PATCH 387/464] Add areaOfInterest and detectObject to CV API (#4771) * Add areaOfInterest and detectObject * Replace the current swagger with an auto-generated one. * Add example files for areaOfInterest and detectObject. * Fix example validation errors for analyze and describe. * A few fixes for generating java sdk * Addressing commets: reorder some keys * fix formatting * Changing modelAsString parameter to ture to be able to add new values ComputerVisonErrors enum --- .../stable/v2.0/ComputerVision.json | 1915 ++++++++++------- .../ComputerVision/stable/v2.0/Ocr.json | 38 +- .../SuccessfulAnalyzeImageWithStream.json | 22 +- .../SuccessfulAnalyzeImageWithUrl.json | 22 +- .../SuccessfulDescribeImageWithStream.json | 2 +- .../SuccessfulDescribeImageWithUrl.json | 2 +- .../SuccessfulDetectObjectsWithStream.json | 35 + .../SuccessfulDetectObjectsWithUrl.json | 35 + ...SuccessfulGetAreaOfInterestWithStream.json | 26 + .../SuccessfulGetAreaOfInterestWithUrl.json | 26 + 10 files changed, 1328 insertions(+), 795 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithUrl.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithStream.json create mode 100644 specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithUrl.json diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json index 2d01aade02f9..7be89405de6a 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json @@ -32,37 +32,9 @@ "https" ], "paths": { - "/models": { - "get": { - "description": "This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API only supports one domain-specific model: a celebrity recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", - "operationId": "ListModels", - "produces": [ - "application/json" - ], - "responses": { - "200": { - "description": "List of available domain models.", - "schema": { - "$ref": "#/definitions/ListModelsResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/ComputerVisionError" - } - } - }, - "x-ms-examples": { - "Successful ListModels request": { - "$ref": "./examples/SuccessfulListModels.json" - } - } - } - }, "/analyze": { "post": { - "description": "This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.", + "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", "operationId": "AnalyzeImage", "consumes": [ "application/json" @@ -77,22 +49,23 @@ { "name": "details", "in": "query", - "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include:Celebrities - identifies celebrities if detected in the image.", - "type": "array", + "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.", "required": false, - "collectionFormat": "csv", + "type": "array", "items": { "type": "string", + "enum": [ + "Celebrities", + "Landmarks" + ], "x-nullable": false, "x-ms-enum": { "name": "Details", "modelAsString": false - }, - "enum": [ - "Celebrities", - "Landmarks" - ] - } + } + }, + "collectionFormat": "csv", + "x-nullable": true }, { "$ref": "#/parameters/ServiceLanguage" @@ -103,7 +76,7 @@ ], "responses": { "200": { - "description": "The response include the extracted features in JSON format.Here is the definitions for enumeration typesClipartTypeNon-clipart = 0, ambiguous = 1, normal-clipart = 2, good-clipart = 3.LineDrawingTypeNon-LineDrawing = 0,LineDrawing = 1.", + "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.", "schema": { "$ref": "#/definitions/ImageAnalysis" } @@ -122,52 +95,39 @@ } } }, - "/generateThumbnail": { + "/describe": { "post": { - "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.", - "operationId": "GenerateThumbnail", + "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DescribeImage", "consumes": [ "application/json" ], "produces": [ - "application/octet-stream" + "application/json" ], "parameters": [ { - "name": "width", - "type": "integer", + "name": "maxCandidates", "in": "query", - "required": true, - "minimum": 1, - "maximum": 1023, - "description": "Width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." - }, - { - "name": "height", + "description": "Maximum number of candidate descriptions to be returned. The default is 1.", + "required": false, "type": "integer", - "in": "query", - "required": true, - "minimum": 1, - "maximum": 1023, - "description": "Height of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + "format": "int32", + "default": 1, + "x-nullable": true }, { - "$ref": "#/parameters/ImageUrl" + "$ref": "#/parameters/ServiceLanguage" }, { - "name": "smartCropping", - "type": "boolean", - "in": "query", - "required": false, - "default": false, - "description": "Boolean flag for enabling smart cropping." + "$ref": "#/parameters/ImageUrl" } ], "responses": { "200": { - "description": "The generated thumbnail in binary format.", + "description": "Image description object.", "schema": { - "type": "file" + "$ref": "#/definitions/ImageDescription" } }, "default": { @@ -178,16 +138,16 @@ } }, "x-ms-examples": { - "Successful GenerateThumbnail request": { - "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json" + "Successful DescribeImage request": { + "$ref": "./examples/SuccessfulDescribeImageWithUrl.json" } } } }, - "/ocr": { + "/detect": { "post": { - "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", - "operationId": "RecognizePrintedText", + "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DetectObjects", "consumes": [ "application/json" ], @@ -195,21 +155,15 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/DetectOrientation" - }, { "$ref": "#/parameters/ImageUrl" - }, - { - "$ref": "#/parameters/OcrLanguage" } ], "responses": { "200": { - "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words.textAngleThe angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "description": "The response include the detected objects in JSON format.", "schema": { - "$ref": "#/definitions/OcrResult" + "$ref": "#/definitions/DetectResult" } }, "default": { @@ -220,43 +174,25 @@ } }, "x-ms-examples": { - "Successful RecognizePrintedText request": { - "$ref": "./examples/SuccessfulRecognizePrintedTextWithUrl.json" + "Successful DetectObjects request": { + "$ref": "./examples/SuccessfulDetectObjectsWithUrl.json" } } } }, - "/describe": { - "post": { - "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", - "operationId": "DescribeImage", - "consumes": [ - "application/json" - ], + "/models": { + "get": { + "description": "This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "ListModels", + "consumes": [], "produces": [ "application/json" ], - "parameters": [ - { - "name": "maxCandidates", - "in": "query", - "description": "Maximum number of candidate descriptions to be returned. The default is 1.", - "type": "integer", - "required": false, - "default": 1 - }, - { - "$ref": "#/parameters/ServiceLanguage" - }, - { - "$ref": "#/parameters/ImageUrl" - } - ], "responses": { "200": { - "description": "Image description object.", + "description": "List of available domain models.", "schema": { - "$ref": "#/definitions/ImageDescription" + "$ref": "#/definitions/ListModelsResult" } }, "default": { @@ -267,16 +203,16 @@ } }, "x-ms-examples": { - "Successful DescribeImage request": { - "$ref": "./examples/SuccessfulDescribeImageWithUrl.json" + "Successful ListModels request": { + "$ref": "./examples/SuccessfulListModels.json" } } } }, - "/tag": { + "/models/{model}/analyze": { "post": { - "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", - "operationId": "TagImage", + "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageByDomain", "consumes": [ "application/json" ], @@ -284,6 +220,14 @@ "application/json" ], "parameters": [ + { + "name": "model", + "in": "path", + "description": "The domain-specific content to recognize.", + "required": true, + "type": "string", + "x-nullable": true + }, { "$ref": "#/parameters/ServiceLanguage" }, @@ -293,9 +237,9 @@ ], "responses": { "200": { - "description": "Image tags object.", + "description": "Analysis result based on the domain model.", "schema": { - "$ref": "#/definitions/TagResult" + "$ref": "#/definitions/DomainModelResults" } }, "default": { @@ -306,16 +250,16 @@ } }, "x-ms-examples": { - "Successful TagImage request": { - "$ref": "./examples/SuccessfulTagImageWithUrl.json" + "Successful AnalyzeImageByDomain request": { + "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithUrl.json" } } } }, - "/models/{model}/analyze": { + "/ocr": { "post": { - "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", - "operationId": "AnalyzeImageByDomain", + "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", + "operationId": "RecognizePrintedText", "consumes": [ "application/json" ], @@ -324,14 +268,10 @@ ], "parameters": [ { - "name": "model", - "in": "path", - "description": "The domain-specific content to recognize.", - "required": true, - "type": "string" + "$ref": "#/parameters/DetectOrientation" }, { - "$ref": "#/parameters/ServiceLanguage" + "$ref": "#/parameters/OcrLanguage" }, { "$ref": "#/parameters/ImageUrl" @@ -339,9 +279,9 @@ ], "responses": { "200": { - "description": "Analysis result based on the domain model", + "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", "schema": { - "$ref": "#/definitions/DomainModelResults" + "$ref": "#/definitions/OcrResult" } }, "default": { @@ -352,61 +292,35 @@ } }, "x-ms-examples": { - "Successful AnalyzeImageByDomain request": { - "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithUrl.json" + "Successful RecognizePrintedText request": { + "$ref": "./examples/SuccessfulRecognizePrintedTextWithUrl.json" } } } - } - }, - "x-ms-paths": { - "/analyze?overload=stream": { + }, + "/tag": { "post": { - "description": "This operation extracts a rich set of visual features based on the image content.", - "operationId": "AnalyzeImageInStream", + "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"cello\" may be accompanied by the hint \"musical instrument\". All tags are in English.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "TagImage", "consumes": [ - "application/octet-stream", - "multipart/form-data" + "application/json" ], "produces": [ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/VisualFeatures" - }, - { - "name": "details", - "in": "query", - "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include:Celebrities - identifies celebrities if detected in the image.", - "type": "array", - "required": false, - "collectionFormat": "csv", - "items": { - "type": "string", - "x-nullable": false, - "x-ms-enum": { - "name": "Details", - "modelAsString": false - }, - "enum": [ - "Celebrities", - "Landmarks" - ] - } - }, { "$ref": "#/parameters/ServiceLanguage" }, { - "$ref": "#/parameters/ImageStream" + "$ref": "#/parameters/ImageUrl" } ], "responses": { "200": { - "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types clipart = 0, ambiguous = 1, normal-clipart = 2, good-clipart = 3. Non-LineDrawing = 0,LineDrawing = 1.", + "description": "Image tags object.", "schema": { - "$ref": "#/definitions/ImageAnalysis" + "$ref": "#/definitions/TagResult" } }, "default": { @@ -417,19 +331,18 @@ } }, "x-ms-examples": { - "Successful AnalyzeImage request": { - "$ref": "./examples/SuccessfulAnalyzeImageWithStream.json" + "Successful TagImage request": { + "$ref": "./examples/SuccessfulTagImageWithUrl.json" } } } }, - "/generateThumbnail?overload=stream": { + "/generateThumbnail": { "post": { - "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.", - "operationId": "GenerateThumbnailInStream", + "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GenerateThumbnail", "consumes": [ - "application/octet-stream", - "multipart/form-data" + "application/json" ], "produces": [ "application/octet-stream" @@ -437,32 +350,37 @@ "parameters": [ { "name": "width", - "type": "integer", "in": "query", + "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, "minimum": 1, - "maximum": 1023, - "description": "Width of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." + "x-nullable": false }, { "name": "height", - "type": "integer", "in": "query", + "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, "minimum": 1, - "maximum": 1023, - "description": "Height of the thumbnail. It must be between 1 and 1024. Recommended minimum of 50." - }, - { - "$ref": "#/parameters/ImageStream" + "x-nullable": false }, { "name": "smartCropping", - "type": "boolean", "in": "query", + "description": "Boolean flag for enabling smart cropping.", "required": false, + "type": "boolean", "default": false, - "description": "Boolean flag for enabling smart cropping." + "x-nullable": true + }, + { + "$ref": "#/parameters/ImageUrl" } ], "responses": { @@ -481,38 +399,31 @@ }, "x-ms-examples": { "Successful GenerateThumbnail request": { - "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json" + "$ref": "./examples/SuccessfulGenerateThumbnailWithUrl.json" } } } }, - "/ocr?overload=stream": { + "/areaOfInterest": { "post": { - "description": "Optical Character Recognition (OCR) detects printed text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", - "operationId": "RecognizePrintedTextInStream", + "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GetAreaOfInterest", "consumes": [ - "application/octet-stream", - "multipart/form-data" + "application/json" ], "produces": [ "application/json" ], "parameters": [ { - "$ref": "#/parameters/OcrLanguage" - }, - { - "$ref": "#/parameters/DetectOrientation" - }, - { - "$ref": "#/parameters/ImageStream" + "$ref": "#/parameters/ImageUrl" } ], "responses": { "200": { - "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "description": "The response includes the extracted area of interest in JSON format.", "schema": { - "$ref": "#/definitions/OcrResult" + "$ref": "#/definitions/AreaOfInterestResult" } }, "default": { @@ -523,143 +434,8 @@ } }, "x-ms-examples": { - "Successful RecognizePrintedText request": { - "$ref": "./examples/SuccessfulRecognizePrintedTextWithStream.json" - } - } - } - }, - "/describe?overload=stream": { - "post": { - "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL.A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", - "operationId": "DescribeImageInStream", - "consumes": [ - "application/octet-stream", - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "maxCandidates", - "in": "query", - "description": "Maximum number of candidate descriptions to be returned. The default is 1.", - "type": "integer", - "required": false, - "default": 1 - }, - { - "$ref": "#/parameters/ServiceLanguage" - }, - { - "$ref": "#/parameters/ImageStream" - } - ], - "responses": { - "200": { - "description": "Image description object.", - "schema": { - "$ref": "#/definitions/ImageDescription" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/ComputerVisionError" - } - } - }, - "x-ms-examples": { - "Successful DescribeImage request": { - "$ref": "./examples/SuccessfulDescribeImageWithStream.json" - } - } - } - }, - "/tag?overload=stream": { - "post": { - "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag 'cello' may be accompanied by the hint 'musical instrument'. All tags are in English.", - "operationId": "TagImageInStream", - "consumes": [ - "application/octet-stream", - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ServiceLanguage" - }, - { - "$ref": "#/parameters/ImageStream" - } - ], - "responses": { - "200": { - "description": "Image tags object.", - "schema": { - "$ref": "#/definitions/TagResult" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/ComputerVisionError" - } - } - }, - "x-ms-examples": { - "Successful TagImage request": { - "$ref": "./examples/SuccessfulTagImageWithStream.json" - } - } - } - }, - "/models/{model}/analyze?overload=stream": { - "post": { - "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", - "operationId": "AnalyzeImageByDomainInStream", - "consumes": [ - "application/octet-stream", - "multipart/form-data" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "model", - "in": "path", - "description": "The domain-specific content to recognize.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ServiceLanguage" - }, - { - "$ref": "#/parameters/ImageStream" - } - ], - "responses": { - "200": { - "description": "Analysis result based on the domain model", - "schema": { - "$ref": "#/definitions/DomainModelResults" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "#/definitions/ComputerVisionError" - } - } - }, - "x-ms-examples": { - "Successful AnalyzeImageByDomain request": { - "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithStream.json" + "Successful GetAreaOfInterest request": { + "$ref": "./examples/SuccessfulGetAreaOfInterestWithUrl.json" } } } @@ -667,619 +443,858 @@ }, "definitions": { "ImageAnalysis": { - "type": "object", "description": "Result of AnalyzeImage operation.", + "type": "object", "properties": { "categories": { - "type": "array", "description": "An array indicating identified categories.", + "type": "array", "items": { "$ref": "#/definitions/Category" - } + }, + "x-nullable": true }, "adult": { - "$ref": "#/definitions/AdultInfo" + "$ref": "#/definitions/AdultInfo", + "description": "An object describing whether the image contains adult-oriented content and/or is racy." }, "color": { - "$ref": "#/definitions/ColorInfo" + "$ref": "#/definitions/ColorInfo", + "description": "An object providing additional metadata describing color attributes." }, "imageType": { - "$ref": "#/definitions/ImageType" + "$ref": "#/definitions/ImageType", + "description": "An object providing possible image types and matching confidence levels." }, "tags": { - "type": "array", "description": "A list of tags with confidence level.", + "type": "array", "items": { "$ref": "#/definitions/ImageTag" - } + }, + "x-nullable": true }, "description": { - "$ref": "#/definitions/ImageDescriptionDetails" + "$ref": "#/definitions/ImageDescriptionDetails", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata." }, "faces": { - "type": "array", "description": "An array of possible faces within the image.", + "type": "array", "items": { "$ref": "#/definitions/FaceDescription" - } + }, + "x-nullable": true + }, + "objects": { + "description": "Array of objects describing what was detected in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedObject" + }, + "x-nullable": true }, "requestId": { + "description": "Id of the REST API request.", "type": "string", - "description": "Id of the request for tracking purposes." + "x-nullable": true }, "metadata": { "$ref": "#/definitions/ImageMetadata" } - } + }, + "x-nullable": true }, - "OcrResult": { + "Category": { + "description": "An object describing identified category.", "type": "object", "properties": { - "language": { + "name": { + "description": "Name of the category.", "type": "string", - "description": "The BCP-47 language code of the text in the image." + "x-nullable": true }, - "textAngle": { - "type": "number", + "score": { "format": "double", - "x-nullable": false, - "description": "The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly." + "description": "Scoring of the category.", + "type": "number", + "x-nullable": false }, - "orientation": { - "type": "string", - "description": "Orientation of the text recognized in the image. The value (up,down,left, or right) refers to the direction that the top of the recognized text is facing, after the image has been rotated around its center according to the detected text angle (see textAngle property)." + "detail": { + "$ref": "#/definitions/CategoryDetail", + "description": "Details of the identified category." + } + }, + "x-nullable": true + }, + "AdultInfo": { + "description": "An object describing whether the image contains adult-oriented content and/or is racy.", + "type": "object", + "properties": { + "isAdultContent": { + "description": "A value indicating if the image contains adult-oriented content.", + "type": "boolean", + "x-nullable": false }, - "regions": { - "type": "array", - "description": "An array of objects, where each object represents a region of recognized text.", - "items": { - "$ref": "#/definitions/OcrRegion" - } + "isRacyContent": { + "description": "A value indicating if the image is racy.", + "type": "boolean", + "x-nullable": false + }, + "adultScore": { + "format": "double", + "description": "Score from 0 to 1 that indicates how much the content is considered adult-oriented within the image.", + "type": "number", + "x-nullable": false + }, + "racyScore": { + "format": "double", + "description": "Score from 0 to 1 that indicates how suggestive is the image.", + "type": "number", + "x-nullable": false } - } + }, + "x-nullable": true }, - "OcrRegion": { + "ColorInfo": { + "description": "An object providing additional metadata describing color attributes.", "type": "object", - "description": "A region consists of multiple lines (e.g. a column of text in a multi-column document).", "properties": { - "boundingBox": { + "dominantColorForeground": { + "description": "Possible dominant foreground color.", "type": "string", - "description": "Bounding box of a recognized region. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down." + "x-nullable": true }, - "lines": { + "dominantColorBackground": { + "description": "Possible dominant background color.", + "type": "string", + "x-nullable": true + }, + "dominantColors": { + "description": "An array of possible dominant colors.", "type": "array", "items": { - "$ref": "#/definitions/OcrLine" - } + "type": "string", + "x-nullable": true + }, + "x-nullable": true + }, + "accentColor": { + "description": "Possible accent color.", + "type": "string", + "x-nullable": true + }, + "isBWImg": { + "description": "A value indicating if the image is black and white.", + "type": "boolean", + "x-nullable": false } - } + }, + "x-nullable": true }, - "OcrLine": { + "ImageType": { + "description": "An object providing possible image types and matching confidence levels.", "type": "object", - "description": "An object describing a single recognized line of text.", "properties": { - "boundingBox": { - "type": "string", - "description": "Bounding box of a recognized line. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down." + "clipArtType": { + "format": "int32", + "description": "Confidence level that the image is a clip art.", + "type": "integer", + "x-nullable": false }, - "words": { - "type": "array", - "description": "An array of objects, where each object represents a recognized word.", - "items": { - "$ref": "#/definitions/OcrWord" - } + "lineDrawingType": { + "format": "int32", + "description": "Confidence level that the image is a line drawing.", + "type": "integer", + "x-nullable": false } - } + }, + "x-nullable": true }, - "OcrWord": { + "ImageTag": { + "description": "An entity observation in the image, along with the confidence score.", "type": "object", - "description": "Information on a recognized word.", "properties": { - "boundingBox": { + "name": { + "description": "Name of the entity.", "type": "string", - "description": "Bounding box of a recognized word. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down." + "x-nullable": true }, - "text": { + "confidence": { + "format": "double", + "description": "The level of confidence that the entity was observed.", + "type": "number", + "x-nullable": false + }, + "hint": { + "description": "Optional hint/details for this tag.", "type": "string", - "description": "String value of a recognized word." + "x-nullable": true } - } + }, + "x-nullable": true }, - "ListModelsResult": { + "ImageDescriptionDetails": { + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", "type": "object", - "description": "Result of the List Domain Models operation.", "properties": { - "models": { + "tags": { + "description": "A collection of image tags.", "type": "array", - "readOnly": true, - "description": "An array of supported models.", "items": { - "$ref": "#/definitions/ModelDescription" - } - } - } - }, - "ModelDescription": { - "type": "object", - "description": "An object describing supported model by name and categories.", - "properties": { - "name": { - "type": "string" + "type": "string", + "x-nullable": true + }, + "x-nullable": true }, - "categories": { + "captions": { + "description": "A list of captions, sorted by confidence level.", "type": "array", "items": { - "type": "string" - } + "$ref": "#/definitions/ImageCaption" + }, + "x-nullable": true } - } + }, + "x-nullable": true }, - "DomainModelResults": { + "FaceDescription": { + "description": "An object describing a face identified in the image.", "type": "object", - "description": "Result of image analysis using a specific domain model including additional metadata.", "properties": { - "result": { - "x-ms-client-flatten": true, - "type": "object", - "description": "Model-specific response" + "age": { + "format": "int32", + "description": "Possible age of the face.", + "type": "integer", + "x-nullable": false }, - "requestId": { + "gender": { + "description": "Possible gender of the face.", + "enum": [ + "Male", + "Female" + ], "type": "string", - "description": "Id of the REST API request." + "x-ms-enum": { + "name": "Gender", + "modelAsString": false + }, + "x-nullable": true }, - "metadata": { - "$ref": "#/definitions/ImageMetadata" + "faceRectangle": { + "$ref": "#/definitions/FaceRectangle", + "description": "Rectangle in the image containing the identified face." } - } + }, + "x-nullable": true }, - "CelebrityResults": { + "DetectedObject": { + "description": "An object detected in an image.", "type": "object", - "description": "List of celebrities recognized in the image.", "properties": { - "celebrities": { - "type": "array", - "items": { - "$ref": "#/definitions/CelebritiesModel" - } + "rectangle": { + "$ref": "#/definitions/BoundingRect", + "description": "Approximate location of the detected object.", + "readOnly": true }, - "requestId": { + "object": { + "description": "Label for the object.", "type": "string", - "description": "Id of the REST API request." - }, - "metadata": { - "$ref": "#/definitions/ImageMetadata" - } - } - }, - "LandmarkResults": { - "type": "object", - "description": "List of landmarks recognized in the image.", - "properties": { - "landmarks": { - "type": "array", - "items": { - "$ref": "#/definitions/LandmarksModel" - } + "x-nullable": true }, - "requestId": { - "type": "string", - "description": "Id of the REST API request." + "confidence": { + "format": "double", + "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false }, - "metadata": { - "$ref": "#/definitions/ImageMetadata" + "parent": { + "$ref": "#/definitions/ObjectHierarchy", + "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'." } - } + }, + "x-nullable": true }, - "ImageDescription": { + "ImageMetadata": { + "description": "Image metadata.", "type": "object", - "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", "properties": { - "description": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ImageDescriptionDetails" - }, - "requestId": { - "type": "string", - "description": "Id of the REST API request." + "width": { + "format": "int32", + "description": "Image width, in pixels.", + "type": "integer", + "x-nullable": false }, - "metadata": { - "$ref": "#/definitions/ImageMetadata" - } - } - }, - "TagResult": { - "type": "object", - "description": "The results of a image tag operation, including any tags and image metadata.", - "properties": { - "tags": { - "type": "array", - "description": "A list of tags with confidence level.", - "items": { - "$ref": "#/definitions/ImageTag" - } + "height": { + "format": "int32", + "description": "Image height, in pixels.", + "type": "integer", + "x-nullable": false }, - "requestId": { + "format": { + "description": "Image format.", "type": "string", - "description": "Id of the REST API request." - }, - "metadata": { - "$ref": "#/definitions/ImageMetadata" + "x-nullable": true } - } + }, + "x-nullable": true }, - "ImageDescriptionDetails": { + "CategoryDetail": { + "description": "An object describing additional category details.", "type": "object", - "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", "properties": { - "tags": { + "celebrities": { + "description": "An array of celebrities if any identified.", "type": "array", - "description": "A collection of image tags.", "items": { - "type": "string" - } + "$ref": "#/definitions/CelebritiesModel" + }, + "x-nullable": true }, - "captions": { + "landmarks": { + "description": "An array of landmarks if any identified.", "type": "array", - "description": "A list of captions, sorted by confidence level.", "items": { - "$ref": "#/definitions/ImageCaption" - } + "$ref": "#/definitions/LandmarksModel" + }, + "x-nullable": true } - } + }, + "x-nullable": true }, "ImageCaption": { - "type": "object", "description": "An image caption, i.e. a brief description of what the image depicts.", + "type": "object", "properties": { "text": { + "description": "The text of the caption.", "type": "string", - "description": "The text of the caption" + "x-nullable": true }, "confidence": { - "type": "number", "format": "double", - "x-nullable": false, - "description": "The level of confidence the service has in the caption" + "description": "The level of confidence the service has in the caption.", + "type": "number", + "x-nullable": false } - } + }, + "x-nullable": true }, - "ImageTag": { + "FaceRectangle": { + "description": "An object describing face rectangle.", "type": "object", - "description": "An image caption, i.e. a brief description of what the image depicts.", "properties": { - "name": { - "type": "string", - "description": "The tag value" + "left": { + "format": "int32", + "description": "X-coordinate of the top left point of the face, in pixels.", + "type": "integer", + "x-nullable": false }, - "confidence": { - "type": "number", - "format": "double", - "x-nullable": false, - "description": "The level of confidence the service has in the caption" + "top": { + "format": "int32", + "description": "Y-coordinate of the top left point of the face, in pixels.", + "type": "integer", + "x-nullable": false }, - "hint": { - "type": "string", - "description": "Optional categorization for the tag" + "width": { + "format": "int32", + "description": "Width measured from the top-left point of the face, in pixels.", + "type": "integer", + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Height measured from the top-left point of the face, in pixels.", + "type": "integer", + "x-nullable": false } - } + }, + "x-nullable": true }, - "ImageMetadata": { + "BoundingRect": { + "description": "A bounding box for an area inside an image.", "type": "object", - "description": "Image metadata", "properties": { - "width": { - "type": "integer", + "x": { "format": "int32", - "x-nullable": false, - "description": "Image width" + "description": "X-coordinate of the top left point of the area, in pixels.", + "type": "integer", + "x-nullable": false }, - "height": { + "y": { + "format": "int32", + "description": "Y-coordinate of the top left point of the area, in pixels.", "type": "integer", + "x-nullable": false + }, + "w": { "format": "int32", - "x-nullable": false, - "description": "Image height" + "description": "Width measured from the top-left point of the area, in pixels.", + "type": "integer", + "x-nullable": false }, - "format": { + "h": { + "format": "int32", + "description": "Height measured from the top-left point of the area, in pixels.", + "type": "integer", + "x-nullable": false + } + }, + "x-nullable": false + }, + "ObjectHierarchy": { + "description": "An object detected inside an image.", + "type": "object", + "properties": { + "object": { + "description": "Label for the object.", "type": "string", - "description": "Image format" + "x-nullable": true + }, + "confidence": { + "format": "double", + "description": "Confidence score of having observed the object in the image, as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false + }, + "parent": { + "$ref": "#/definitions/ObjectHierarchy", + "description": "The parent object, from a taxonomy perspective.\r\nThe parent object is a more generic form of this object. For example, a 'bulldog' would have a parent of 'dog'." } - } + }, + "x-nullable": true }, "CelebritiesModel": { - "type": "object", "description": "An object describing possible celebrity identification.", + "type": "object", "properties": { "name": { + "description": "Name of the celebrity.", "type": "string", - "description": "Name of the celebrity." + "x-nullable": true }, "confidence": { - "type": "number", "format": "double", - "x-nullable": false, - "description": "Level of confidence ranging from 0 to 1." + "description": "Confidence level for the celebrity recognition as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false }, "faceRectangle": { - "$ref": "#/definitions/FaceRectangle" + "$ref": "#/definitions/FaceRectangle", + "description": "Location of the identified face in the image." } - } + }, + "x-nullable": true }, "LandmarksModel": { + "description": "A landmark recognized in the image.", "type": "object", - "description": "A landmark recognized in the image", "properties": { "name": { + "description": "Name of the landmark.", "type": "string", - "description": "Name of the landmark." + "x-nullable": true }, "confidence": { - "type": "number", "format": "double", - "x-nullable": false, - "description": "Confidence level for the landmark recognition." + "description": "Confidence level for the landmark recognition as a value ranging from 0 to 1.", + "type": "number", + "x-nullable": false } - } + }, + "x-nullable": true }, - "FaceRectangle": { + "ImageDescription": { + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", "type": "object", - "description": "An object describing face rectangle.", "properties": { - "left": { - "type": "integer", - "x-nullable": false, - "description": "X-coordinate of the top left point of the face." - }, - "top": { - "type": "integer", - "x-nullable": false, - "description": "Y-coordinate of the top left point of the face." + "description": { + "$ref": "#/definitions/ImageDescriptionDetails", + "description": "A collection of content tags, along with a list of captions sorted by confidence level, and image metadata.", + "x-ms-client-flatten": true }, - "width": { - "type": "integer", - "x-nullable": false, - "description": "Width measured from the top-left point of the face." + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true }, - "height": { - "type": "integer", - "x-nullable": false, - "description": "Height measured from the top-left point of the face." + "metadata": { + "$ref": "#/definitions/ImageMetadata" } - } + }, + "x-nullable": true }, - "FaceDescription": { + "DetectResult": { + "description": "Result of a DetectImage call.", "type": "object", - "description": "An object describing a face identified in the image.", "properties": { - "age": { - "type": "integer", - "x-nullable": false, - "description": "Possible age of the face." + "objects": { + "description": "An array of detected objects.", + "type": "array", + "items": { + "$ref": "#/definitions/DetectedObject" + }, + "readOnly": true, + "x-nullable": true }, - "gender": { + "requestId": { + "description": "Id of the REST API request.", "type": "string", - "description": "Possible gender of the face.", - "x-ms-enum": { - "name": "Gender-", - "modelAsString": false - }, - "enum": [ - "Male", - "Female" - ] + "x-nullable": true }, - "faceRectangle": { - "$ref": "#/definitions/FaceRectangle" + "metadata": { + "$ref": "#/definitions/ImageMetadata" } - } + }, + "x-nullable": true }, - "ImageType": { + "ListModelsResult": { + "description": "Result of the List Domain Models operation.", "type": "object", - "description": "An object providing possible image types and matching confidence levels.", "properties": { - "clipArtType": { - "type": "integer", - "x-nullable": false, - "description": "Confidence level that the image is a clip art." - }, - "lineDrawingType": { - "type": "integer", - "x-nullable": false, - "description": "Confidence level that the image is a line drawing." + "models": { + "description": "An array of supported models.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelDescription" + }, + "readOnly": true, + "x-nullable": true } - } + }, + "x-nullable": true }, - "ColorInfo": { + "ModelDescription": { + "description": "An object describing supported model by name and categories.", "type": "object", - "description": "An object providing additional metadata describing color attributes.", "properties": { - "dominantColorForeground": { - "type": "string", - "description": "Possible dominant foreground color." - }, - "dominantColorBackground": { + "name": { + "description": "The name of the model.", "type": "string", - "description": "Possible dominant background color." + "x-nullable": true }, - "dominantColors": { + "categories": { + "description": "Categories of the model.", "type": "array", - "description": "An array of possible dominant colors.", "items": { - "type": "string" - } - }, - "accentColor": { - "type": "string", - "description": "Possible accent color." - }, - "isBWImg": { - "type": "boolean", - "x-nullable": false, - "description": "A value indicating if the image is black and white." + "type": "string", + "x-nullable": true + }, + "x-nullable": true } - } + }, + "x-nullable": true }, - "AdultInfo": { + "DomainModelResults": { + "description": "Result of image analysis using a specific domain model including additional metadata.", "type": "object", - "description": "An object describing whether the image contains adult-oriented content and/or is racy.", "properties": { - "isAdultContent": { - "type": "boolean", - "x-nullable": false, - "description": "A value indicating if the image contains adult-oriented content." + "result": { + "description": "Model-specific response.", + "type": "object", + "x-ms-client-flatten": true }, - "isRacyContent": { - "type": "boolean", - "x-nullable": false, - "description": "A value indicating if the image is race." - }, - "adultScore": { - "type": "number", - "format": "double", - "x-nullable": false, - "description": "Score from 0 to 1 that indicates how much of adult content is within the image." + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true }, - "racyScore": { - "type": "number", - "format": "double", - "x-nullable": false, - "description": "Score from 0 to 1 that indicates how suggestive is the image." + "metadata": { + "$ref": "#/definitions/ImageMetadata" } - } + }, + "x-nullable": true }, - "Category": { + "OcrResult": { "type": "object", - "description": "An object describing identified category.", "properties": { - "name": { + "language": { + "description": "The BCP-47 language code of the text in the image.", "type": "string", - "description": "Name of the category." + "x-nullable": true }, - "score": { - "type": "number", + "textAngle": { "format": "double", - "x-nullable": false, - "description": "Scoring of the category." + "description": "The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "type": "number", + "x-nullable": false }, - "detail": { - "$ref": "#/definitions/CategoryDetail" + "orientation": { + "description": "Orientation of the text recognized in the image. The value (up, down, left, or right) refers to the direction that the top of the recognized text is facing, after the image has been rotated around its center according to the detected text angle (see textAngle property).", + "type": "string", + "x-nullable": true + }, + "regions": { + "description": "An array of objects, where each object represents a region of recognized text.", + "type": "array", + "items": { + "$ref": "#/definitions/OcrRegion" + }, + "x-nullable": true } - } + }, + "x-nullable": true }, - "CategoryDetail": { + "OcrRegion": { + "description": "A region consists of multiple lines (e.g. a column of text in a multi-column document).", "type": "object", - "description": "An object describing additional category details.", "properties": { - "celebrities": { + "boundingBox": { + "description": "Bounding box of a recognized region. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true + }, + "lines": { + "description": "An array of recognized lines of text.", "type": "array", - "description": "An array of celebrities if any identified.", "items": { - "$ref": "#/definitions/CelebritiesModel" - } + "$ref": "#/definitions/OcrLine" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "OcrLine": { + "description": "An object describing a single recognized line of text.", + "type": "object", + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized line. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true }, - "landmarks": { + "words": { + "description": "An array of objects, where each object represents a recognized word.", "type": "array", - "description": "An array of landmarks if any identified.", "items": { - "$ref": "#/definitions/LandmarksModel" - } + "$ref": "#/definitions/OcrWord" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "OcrWord": { + "description": "Information on a recognized word.", + "type": "object", + "properties": { + "boundingBox": { + "description": "Bounding box of a recognized word. The four integers represent the x-coordinate of the left edge, the y-coordinate of the top edge, width, and height of the bounding box, in the coordinate system of the input image, after it has been rotated around its center according to the detected text angle (see textAngle property), with the origin at the top-left corner, and the y-axis pointing down.", + "type": "string", + "x-nullable": true + }, + "text": { + "description": "String value of a recognized word.", + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "TagResult": { + "description": "The results of a image tag operation, including any tags and image metadata.", + "type": "object", + "properties": { + "tags": { + "description": "A list of tags with confidence level.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "AreaOfInterestResult": { + "description": "Result of AreaOfInterest operation.", + "type": "object", + "properties": { + "areaOfInterest": { + "$ref": "#/definitions/BoundingRect", + "description": "A bounding box for an area of interest inside an image.", + "readOnly": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true + }, + "ImageUrl": { + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "Publicly reachable URL of an image.", + "type": "string" } } }, "ComputerVisionError": { - "type": "object", + "description": "Details about the API request error.", "required": [ "code", "message" ], + "type": "object", "properties": { "code": { - "type": "string", "description": "The error code.", "enum": [ - "InvalidImageUrl", "InvalidImageFormat", - "InvalidImageSize", - "NotSupportedVisualFeature", + "UnsupportedMediaType", + "InvalidImageUrl", + "NotSupportedFeature", "NotSupportedImage", - "InvalidDetails", - "NotSupportedLanguage", - "BadArgument", - "FailedToProcess", "Timeout", "InternalServerError", + "InvalidImageSize", + "BadArgument", + "DetectFaceError", + "NotSupportedLanguage", + "InvalidThumbnailSize", + "InvalidDetails", + "InvalidModel", + "CancelledRequest", + "NotSupportedVisualFeature", + "FailedToProcess", "Unspecified", "StorageException" ], "x-ms-enum": { "name": "ComputerVisionErrorCodes", - "modelAsString": false + "modelAsString": true } }, "message": { - "type": "string", - "description": "A message explaining the error reported by the service." + "description": "A message explaining the error reported by the service.", + "type": "string" }, "requestId": { - "type": "string", - "description": "A unique request identifier." + "description": "A unique request identifier.", + "type": "string" } } }, - "ServiceLanguage": { - "type": "string" + "LandmarkResults": { + "description": "Result of domain-specific classifications for the domain of landmarks.", + "type": "object", + "properties": { + "landmarks": { + "description": "List of landmarks recognized in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/LandmarksModel" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" + } + }, + "x-nullable": true }, - "ImageUrl": { + "CelebrityResults": { + "description": "Result of domain-specific classifications for the domain of celebrities.", "type": "object", - "required": [ - "url" - ], "properties": { - "url": { - "description": "Publicly reachable URL of an image", - "type": "string" + "celebrities": { + "description": "List of celebrities recognized in the image.", + "type": "array", + "items": { + "$ref": "#/definitions/CelebritiesModel" + }, + "x-nullable": true + }, + "requestId": { + "description": "Id of the REST API request.", + "type": "string", + "x-nullable": true + }, + "metadata": { + "$ref": "#/definitions/ImageMetadata" } - } + }, + "x-nullable": true } }, "parameters": { - "VisualFeatures": { - "name": "visualFeatures", - "in": "query", - "description": "A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include:Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white.Adult - detects if the image is pornographic in nature (depicts nudity or a sex act). Sexually suggestive content is also detected.", - "type": "array", + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + }, + "ImageStream": { + "name": "Image", + "in": "body", + "description": "An image stream.", + "required": true, + "schema": { + "format": "file", + "type": "object" + }, + "x-ms-parameter-location": "method" + }, + "ImageUrl": { + "name": "ImageUrl", + "in": "body", + "description": "A JSON document with a URL pointing to the image that is to be analyzed.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + }, "x-ms-parameter-location": "method", + "x-ms-client-flatten": true + }, + "ServiceLanguage": { + "name": "language", + "in": "query", + "description": "The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.", "required": false, - "collectionFormat": "csv", - "items": { - "type": "string", - "x-nullable": false, - "x-ms-enum": { - "name": "VisualFeatureTypes", - "modelAsString": false - }, - "enum": [ - "ImageType", - "Faces", - "Adult", - "Categories", - "Color", - "Tags", - "Description" - ] - } + "type": "string", + "default": "en", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ], + "x-ms-parameter-location": "method", + "x-nullable": false }, "OcrLanguage": { "name": "language", "in": "query", - "description": "The BCP-47 language code of the text to be detected in the image. The default value is 'unk'", - "type": "string", + "description": "The BCP-47 language code of the text to be detected in the image. The default value is 'unk'.", "required": false, - "x-ms-parameter-location": "method", - "x-nullable": false, - "x-ms-enum": { - "name": "OcrLanguages", - "modelAsString": false - }, + "type": "string", "default": "unk", "enum": [ "unk", @@ -1309,80 +1324,438 @@ "sr-Cyrl", "sr-Latn", "sk" - ] + ], + "x-ms-parameter-location": "method", + "x-nullable": false, + "x-ms-enum": { + "name": "OcrLanguages", + "modelAsString": false + } }, - "DetectOrientation": { - "name": "detectOrientation", + "VisualFeatures": { + "name": "visualFeatures", "in": "query", - "description": "Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down). ", - "required": true, - "x-ms-parameter-location": "method", - "type": "boolean", - "default": true + "description": "A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act). Sexually suggestive content is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "ImageType", + "Faces", + "Adult", + "Categories", + "Color", + "Tags", + "Description", + "Objects" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "VisualFeatureTypes", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-ms-parameter-location": "method" }, - "TextRecognitionMode": { - "name": "mode", + "DetectOrientation": { + "name": "detectOrientation", "in": "query", - "description": "Type of text to recognize.", + "description": "Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).", "required": true, - "x-ms-parameter-location": "method", - "type": "string", - "x-ms-enum": { - "name": "TextRecognitionMode", - "modelAsString": false - }, - "enum": [ - "Handwritten", - "Printed" - ] + "type": "boolean", + "default": true, + "x-ms-parameter-location": "method" + } + }, + "x-ms-paths": { + "/analyze?overload=stream": { + "post": { + "description": "This operation extracts a rich set of visual features based on the image content.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/VisualFeatures" + }, + { + "name": "details", + "in": "query", + "description": "A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "Celebrities", + "Landmarks" + ], + "x-nullable": false, + "x-ms-enum": { + "name": "Details", + "modelAsString": false + } + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response include the extracted features in JSON format. Here is the definitions for enumeration types:\r\n ClipartType\r\n Non - clipart = 0, ambiguous = 1, normal - clipart = 2, good - clipart = 3. LineDrawingTypeNon - LineDrawing = 0, LineDrawing = 1.", + "schema": { + "$ref": "#/definitions/ImageAnalysis" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImage request": { + "$ref": "./examples/SuccessfulAnalyzeImageWithStream.json" + } + } + } }, - "ServiceLanguage": { - "name": "language", - "in": "query", - "description": "The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese.", - "type": "string", - "required": false, - "x-ms-parameter-location": "method", - "x-nullable": false, - "default": "en", - "enum": [ - "en", - "es", - "ja", - "pt", - "zh" - ] + "/areaOfInterest?overload=stream": { + "post": { + "description": "This operation returns a bounding box around the most important area of the image.\r\nA successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GetAreaOfInterestInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response includes the extracted area of interest in JSON format.", + "schema": { + "$ref": "#/definitions/AreaOfInterestResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetAreaOfInterest request": { + "$ref": "./examples/SuccessfulGetAreaOfInterestWithStream.json" + } + } + } }, - "ImageUrl": { - "name": "ImageUrl", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "x-ms-client-flatten": true, - "description": "A JSON document with a URL pointing to the image that is to be analyzed.", - "schema": { - "$ref": "#/definitions/ImageUrl" + "/describe?overload=stream": { + "post": { + "description": "This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. All descriptions are in English.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DescribeImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "maxCandidates", + "in": "query", + "description": "Maximum number of candidate descriptions to be returned. The default is 1.", + "required": false, + "type": "integer", + "format": "int32", + "default": 1, + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Image description object.", + "schema": { + "$ref": "#/definitions/ImageDescription" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DescribeImage request": { + "$ref": "./examples/SuccessfulDescribeImageWithStream.json" + } + } } }, - "ImageStream": { - "name": "Image", - "in": "body", - "required": true, - "x-ms-parameter-location": "method", - "description": "An image stream.", - "schema": { - "type": "object", - "format": "file" + "/detect?overload=stream": { + "post": { + "description": "Performs object detection on the specified image.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "DetectObjectsInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The response include the detected objects in JSON format.", + "schema": { + "$ref": "#/definitions/DetectResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectObjects request": { + "$ref": "./examples/SuccessfulDetectObjectsWithStream.json" + } + } } }, - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true + "/generateThumbnail?overload=stream": { + "post": { + "description": "This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image.\r\nA successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong.\r\nUpon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.", + "operationId": "GenerateThumbnailInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "width", + "in": "query", + "description": "Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "height", + "in": "query", + "description": "Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.", + "required": true, + "type": "integer", + "format": "int32", + "maximum": 1024, + "minimum": 1, + "x-nullable": false + }, + { + "name": "smartCropping", + "in": "query", + "description": "Boolean flag for enabling smart cropping.", + "required": false, + "type": "boolean", + "default": false, + "x-nullable": true + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The generated thumbnail in binary format.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful GenerateThumbnail request": { + "$ref": "./examples/SuccessfulGenerateThumbnailWithStream.json" + } + } + } + }, + "/models/{model}/analyze?overload=stream": { + "post": { + "description": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON.\r\nIf the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "AnalyzeImageByDomainInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "model", + "in": "path", + "description": "The domain-specific content to recognize.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Analysis result based on the domain model.", + "schema": { + "$ref": "#/definitions/DomainModelResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful AnalyzeImageByDomain request": { + "$ref": "./examples/SuccessfulAnalyzeImageByDomainWithStream.json" + } + } + } + }, + "/ocr?overload=stream": { + "post": { + "description": "Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream.\r\nUpon success, the OCR results will be returned.\r\nUpon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.", + "operationId": "RecognizePrintedTextInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/DetectOrientation" + }, + { + "$ref": "#/parameters/OcrLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "The OCR results in the hierarchy of region/line/word. The results include text, bounding box for regions, lines and words. The angle, in degrees, of the detected text with respect to the closest horizontal or vertical direction. After rotating the input image clockwise by this angle, the recognized text lines become horizontal or vertical. In combination with the orientation property it can be used to overlay recognition results correctly on the original image, by rotating either the original image or recognition results by a suitable angle around the center of the original image. If the angle cannot be confidently detected, this property is not present. If the image contains text at different angles, only part of the text will be recognized correctly.", + "schema": { + "$ref": "#/definitions/OcrResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful RecognizePrintedText request": { + "$ref": "./examples/SuccessfulRecognizePrintedTextWithStream.json" + } + } + } + }, + "/tag?overload=stream": { + "post": { + "description": "This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag \"cello\" may be accompanied by the hint \"musical instrument\". All tags are in English.\r\nTwo input methods are supported -- (1) Uploading an image or (2) specifying an image URL.\r\nA successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.", + "operationId": "TagImageInStream", + "consumes": [ + "application/octet-stream", + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ServiceLanguage" + }, + { + "$ref": "#/parameters/ImageStream" + } + ], + "responses": { + "200": { + "description": "Image tags object.", + "schema": { + "$ref": "#/definitions/TagResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ComputerVisionError" + } + } + }, + "x-ms-examples": { + "Successful TagImage request": { + "$ref": "./examples/SuccessfulTagImageWithStream.json" + } + } + } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json index cec25885d414..b1fc20f55143 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/Ocr.json @@ -227,42 +227,48 @@ } }, "ComputerVisionError": { - "type": "object", + "description": "Details about the API request error.", "required": [ "code", "message" ], + "type": "object", "properties": { "code": { - "type": "string", "description": "The error code.", "enum": [ - "InvalidImageUrl", "InvalidImageFormat", - "InvalidImageSize", - "NotSupportedVisualFeature", + "UnsupportedMediaType", + "InvalidImageUrl", + "NotSupportedFeature", "NotSupportedImage", - "InvalidDetails", - "NotSupportedLanguage", - "BadArgument", - "FailedToProcess", "Timeout", "InternalServerError", + "InvalidImageSize", + "BadArgument", + "DetectFaceError", + "NotSupportedLanguage", + "InvalidThumbnailSize", + "InvalidDetails", + "InvalidModel", + "CancelledRequest", + "NotSupportedVisualFeature", + "FailedToProcess", "Unspecified", "StorageException" ], "x-ms-enum": { "name": "ComputerVisionErrorCodes", - "modelAsString": false + "modelAsString": true } }, "message": { - "type": "string", - "description": "A message explaining the error reported by the service." + "description": "A message explaining the error reported by the service.", + "type": "string" }, "requestId": { - "type": "string", - "description": "A unique request identifier." + "description": "A unique request identifier.", + "type": "string" } } }, @@ -273,7 +279,7 @@ ], "properties": { "url": { - "description": "Publicly reachable URL of an image", + "description": "Publicly reachable URL of an image.", "type": "string" } } @@ -320,7 +326,7 @@ }, "Endpoint": { "name": "Endpoint", - "description": "Supported Cognitive Services endpoints", + "description": "Supported Cognitive Services endpoints.", "x-ms-parameter-location": "client", "required": true, "type": "string", diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json index d0f29538c213..25563786840a 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithStream.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType"], - "details": "Celebrities", + "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects"], + "details": ["Celebrities", "Landmarks"], "language": "en", "Image": "{binary}" }, @@ -116,7 +116,23 @@ "imageType": { "clipArtType": 0, "lineDrawingType": 0 - } + }, + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ] } } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json index 6d926348b297..8bd63c44fe61 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulAnalyzeImageWithUrl.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "visualFeatures": "Categories,Adult,Tags,Description,Faces,Color,ImageType", - "details": "Celebrities,Landmarks", + "visualFeatures": ["Categories", "Adult", "Tags", "Description", "Faces", "Color", "ImageType", "Objects"], + "details": ["Celebrities", "Landmarks"], "language": "en", "ImageUrl": "{url}" }, @@ -122,7 +122,23 @@ "imageType": { "clipArtType": 0, "lineDrawingType": 0 - } + }, + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ] } } } diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithStream.json index 39ebe227d6c0..15853ad77b33 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithStream.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithStream.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "maxCandidates": "1", + "maxCandidates": 1, "Image": "{binary}" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithUrl.json index 11321cb00337..928b2e7720f9 100644 --- a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithUrl.json +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDescribeImageWithUrl.json @@ -2,7 +2,7 @@ "parameters": { "Endpoint": "https://westus.api.cognitive.microsoft.com", "Ocp-Apim-Subscription-Key": "{API key}", - "maxCandidates": "1", + "maxCandidates": 1, "ImageUrl": "{url}" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithStream.json new file mode 100644 index 000000000000..432d17aa3562 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithStream.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "Image": "{binary}" + }, + "responses": { + "200": { + "body": { + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 100, + "height": 100, + "format": "Jpeg" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithUrl.json new file mode 100644 index 000000000000..060b21be371c --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulDetectObjectsWithUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": "{url}" + }, + "responses": { + "200": { + "body": { + "objects": [ + { + "rectangle": { + "x": 0, + "y": 0, + "w": 50, + "h": 50 + }, + "object": "tree", + "confidence": 0.9, + "parent": { + "object": "plant", + "confidence": 0.95 + } + } + ], + "requestId": "1ad0e45e-b7b4-4be3-8042-53be96103337", + "metadata": { + "width": 100, + "height": 100, + "format": "Jpeg" + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithStream.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithStream.json new file mode 100644 index 000000000000..a2a6bb37639c --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithStream.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "Image": "{binary}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "areaOfInterest": { + "h": 951, + "w": 950, + "x": 160, + "y": 0 + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "format": "Jpeg", + "height": 951, + "width": 1378 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithUrl.json b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithUrl.json new file mode 100644 index 000000000000..c30916ff4d5d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/examples/SuccessfulGetAreaOfInterestWithUrl.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Ocp-Apim-Subscription-Key": "{API key}", + "ImageUrl": "{url}" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "areaOfInterest": { + "h": 951, + "w": 950, + "x": 160, + "y": 0 + }, + "requestId": "ed2de1c6-fb55-4686-b0da-4da6e05d283f", + "metadata": { + "format": "Jpeg", + "height": 951, + "width": 1378 + } + } + } + } +} \ No newline at end of file From 026fdc7cdb739680a471ebc951c95c3e4737fe5c Mon Sep 17 00:00:00 2001 From: Meiyan Li <40255037+meiyan-Li@users.noreply.github.com> Date: Tue, 11 Dec 2018 11:53:38 +0800 Subject: [PATCH 388/464] [Azure Data Factory] Adding refresh and get IntegrationRuntimeObjectMetadata API (#4724) * Adding refresh and get IntegrationRuntimeObjectMetadata API * Change ssis to upper case * Fix model validation issue --- .../stable/2018-06-01/datafactory.json | 135 ++++++ .../entityTypes/IntegrationRuntime.json | 55 +++ .../IntegrationRuntimeObjectMetadata_Get.json | 432 ++++++++++++++++++ ...egrationRuntimeObjectMetadata_Refresh.json | 39 ++ 4 files changed, 661 insertions(+) create mode 100644 specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Get.json create mode 100644 specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Refresh.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 649a6e4a54d1..6224a1915b1d 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 @@ -1269,6 +1269,109 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata": { + "post": { + "tags": [ + "integrationRuntimeObjectMetadata" + ], + "operationId": "IntegrationRuntimeObjectMetadata_Refresh", + "x-ms-examples": { + "IntegrationRuntimeObjectMetadata_Refresh": { + "$ref": "./examples/IntegrationRuntimeObjectMetadata_Refresh.json" + } + }, + "description": "Refresh a SSIS integration runtime object metadata.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SsisObjectMetadataStatusResponse" + } + }, + "202": { + "description": "Accepted." + }, + "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}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata": { + "post": { + "tags": [ + "integrationRuntimeObjectMetadata" + ], + "operationId": "IntegrationRuntimeObjectMetadata_Get", + "x-ms-examples": { + "IntegrationRuntimeObjectMetadata_Get": { + "$ref": "./examples/IntegrationRuntimeObjectMetadata_Get.json" + } + }, + "description": "Get a SSIS integration runtime object metadata by specified path. The return is pageable metadata list.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/factoryName" + }, + { + "$ref": "#/parameters/integrationRuntimeName" + }, + { + "name": "getMetadataRequest", + "description": "The parameters for getting a SSIS object metadata.", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/GetSsisObjectMetadataRequest" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "./entityTypes/IntegrationRuntime.json#/definitions/SsisObjectMetadataListResponse" + } + }, + "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}/integrationRuntimes/{integrationRuntimeName}/nodes/{nodeName}": { "get": { "tags": [ @@ -4558,6 +4661,38 @@ "type": "boolean" } } + }, + "GetSsisObjectMetadataRequest": { + "type": "object", + "description": "The request payload of get SSIS object metadata.", + "properties": { + "metadataPath": { + "type": "string", + "description": "Metadata path." + } + } + }, + "SsisObjectMetadataStatusResponse": { + "type": "object", + "description": "The status of the operation.", + "properties": { + "status": { + "type": "string", + "description": "The status of the operation." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "properties": { + "type": "string", + "description": "The operation properties." + }, + "error": { + "type": "string", + "description": "The operation error message." + } + } } }, "parameters": { diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json index 4efad3ae9660..ce9e4f16e2a6 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/IntegrationRuntime.json @@ -956,6 +956,61 @@ "readOnly": true } } + }, + "SsisObjectMetadataListResponse": { + "type": "object", + "description": "A list of SSIS object metadata.", + "properties": { + "value": { + "type": "array", + "description": "List of SSIS object metadata.", + "items": { + "$ref": "#/definitions/SsisObjectMetadata" + } + }, + "nextLink": { + "type": "string", + "description": "The link to the next page of results, if any remaining results exist." + } + } + }, + "SsisObjectMetadata": { + "type": "object", + "description": "SSIS object metadata.", + "discriminator": "type", + "properties": { + "type": { + "description": "Type of metadata.", + "$ref": "#/definitions/SsisObjectMetadataType" + }, + "id": { + "type": "integer", + "format": "int64", + "description": "Metadata id." + }, + "name": { + "type": "string", + "description": "Metadata name." + }, + "description": { + "type": "string", + "description": "Metadata description." + } + } + }, + "SsisObjectMetadataType": { + "description": "The type of SSIS object metadata.", + "type": "string", + "enum": [ + "Folder", + "Project", + "Package", + "Environment" + ], + "x-ms-enum": { + "name": "SsisObjectMetadataType", + "modelAsString": true + } } } } diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Get.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Get.json new file mode 100644 index 000000000000..7d701fa745b8 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Get.json @@ -0,0 +1,432 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "testactivityv2", + "getMetadataRequest": { + "metadataPath": "ssisFolders" + }, + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "headers": { + "Date": "Mon, 03 Dec 2018 06:24:54 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1198", + "x-ms-request-id": "0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd", + "x-ms-correlation-request-id": "0cbc67c4-60e7-4d49-97d9-e4bc4f9851cd" + }, + "body": { + "value": [ + { + "id": 1, + "name": "TestFolder", + "description": "" + }, + { + "id": 2, + "name": "EnvironmentFolder", + "description": "" + }, + { + "id": 3, + "name": "ActivityTest", + "description": "" + }, + { + "id": 4, + "name": "这是文件夹", + "description": "" + }, + { + "id": 5, + "name": "1" + }, + { + "id": 6, + "name": "2" + }, + { + "id": 7, + "name": "3" + }, + { + "id": 8, + "name": "4" + }, + { + "id": 9, + "name": "5" + }, + { + "id": 10, + "name": "6" + }, + { + "id": 11, + "name": "7" + }, + { + "id": 12, + "name": "8" + }, + { + "id": 13, + "name": "9" + }, + { + "id": 14, + "name": "10" + }, + { + "id": 15, + "name": "11" + }, + { + "id": 16, + "name": "12" + }, + { + "id": 17, + "name": "13" + }, + { + "id": 18, + "name": "14" + }, + { + "id": 19, + "name": "15" + }, + { + "id": 20, + "name": "16" + }, + { + "id": 21, + "name": "17" + }, + { + "id": 22, + "name": "18" + }, + { + "id": 23, + "name": "19" + }, + { + "id": 24, + "name": "20" + }, + { + "id": 25, + "name": "21" + }, + { + "id": 26, + "name": "22" + }, + { + "id": 27, + "name": "23" + }, + { + "id": 28, + "name": "24" + }, + { + "id": 29, + "name": "25" + }, + { + "id": 30, + "name": "26" + }, + { + "id": 31, + "name": "27" + }, + { + "id": 32, + "name": "28" + }, + { + "id": 33, + "name": "29" + }, + { + "id": 34, + "name": "30" + }, + { + "id": 35, + "name": "31" + }, + { + "id": 36, + "name": "32" + }, + { + "id": 37, + "name": "33" + }, + { + "id": 38, + "name": "34" + }, + { + "id": 39, + "name": "35" + }, + { + "id": 40, + "name": "36" + }, + { + "id": 41, + "name": "37" + }, + { + "id": 42, + "name": "38" + }, + { + "id": 43, + "name": "39" + }, + { + "id": 44, + "name": "40" + }, + { + "id": 45, + "name": "41" + }, + { + "id": 46, + "name": "42" + }, + { + "id": 47, + "name": "43" + }, + { + "id": 48, + "name": "44" + }, + { + "id": 49, + "name": "45" + }, + { + "id": 50, + "name": "46" + }, + { + "id": 51, + "name": "47" + }, + { + "id": 52, + "name": "48" + }, + { + "id": 53, + "name": "49" + }, + { + "id": 54, + "name": "50" + }, + { + "id": 55, + "name": "51" + }, + { + "id": 56, + "name": "52" + }, + { + "id": 57, + "name": "53" + }, + { + "id": 58, + "name": "54" + }, + { + "id": 59, + "name": "55" + }, + { + "id": 60, + "name": "56" + }, + { + "id": 61, + "name": "57" + }, + { + "id": 62, + "name": "58" + }, + { + "id": 63, + "name": "59" + }, + { + "id": 64, + "name": "60" + }, + { + "id": 65, + "name": "61" + }, + { + "id": 66, + "name": "62" + }, + { + "id": 67, + "name": "63" + }, + { + "id": 68, + "name": "64" + }, + { + "id": 69, + "name": "65" + }, + { + "id": 70, + "name": "66" + }, + { + "id": 71, + "name": "67" + }, + { + "id": 72, + "name": "68" + }, + { + "id": 73, + "name": "69" + }, + { + "id": 74, + "name": "70" + }, + { + "id": 75, + "name": "71" + }, + { + "id": 76, + "name": "72" + }, + { + "id": 77, + "name": "73" + }, + { + "id": 78, + "name": "74" + }, + { + "id": 79, + "name": "75" + }, + { + "id": 80, + "name": "76" + }, + { + "id": 81, + "name": "77" + }, + { + "id": 82, + "name": "78" + }, + { + "id": 83, + "name": "79" + }, + { + "id": 84, + "name": "80" + }, + { + "id": 85, + "name": "81" + }, + { + "id": 86, + "name": "82" + }, + { + "id": 87, + "name": "83" + }, + { + "id": 88, + "name": "84" + }, + { + "id": 89, + "name": "85" + }, + { + "id": 90, + "name": "86" + }, + { + "id": 91, + "name": "87" + }, + { + "id": 92, + "name": "88" + }, + { + "id": 93, + "name": "89" + }, + { + "id": 94, + "name": "90" + }, + { + "id": 95, + "name": "91" + }, + { + "id": 96, + "name": "92" + }, + { + "id": 97, + "name": "93" + }, + { + "id": 98, + "name": "94" + }, + { + "id": 99, + "name": "95" + }, + { + "id": 100, + "name": "96" + } + ], + "nextLink": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/testactivityv2/getObjectMetadata?api-version=2018-06-01&%24skipToken=https%3a%2f%2fwcu.frontend.clouddatahub.net%2fsubscriptions%2f12345678-1234-1234-1234-12345678abc%2fdatafactories%2f6C8E7C90-FD45-4010-8B7C-B5227D0F0CB7%2fintegrationruntimes%2fTESTACTIVITYV2%2fgetSsisObjectMetadata%3f%24skipToken%3dc3Npc0ZvbGRlcnNAQDIwMTgtMTEtMjlUMDM6NTk6MzIuMDQ1Mzc1MiswMDowMEBAZm9sZGVyQEAwMDAwMDAwMDAwMDAwMDAwMTAx0%26api-version%3d1.0" + } + } + } +} \ No newline at end of file diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json new file mode 100644 index 000000000000..5a8cdeb4c8c7 --- /dev/null +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimeObjectMetadata_Refresh.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-12345678abc", + "resourceGroupName": "exampleResourceGroup", + "factoryName": "exampleFactoryName", + "integrationRuntimeName": "testactivityv2", + "api-version": "2018-06-01" + }, + "responses": { + "202": { + "headers": { + "Date": "Mon, 03 Dec 2018 06:24:38 GMT", + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/testactivityv2/refreshObjectMetadata/operationresults/ca63c855b72d44959653ffcc6eb0b96c?api-version=2018-06-01", + "Retry-After": "15", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/testactivityv2/refreshObjectMetadata/operationstatuses/ca63c855b72d44959653ffcc6eb0b96c?api-version=2018-06-01", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-writes": "1199", + "x-ms-request-id": "abf136ad-39c8-4ee8-9098-7866f9433d13", + "x-ms-correlation-request-id": "abf136ad-39c8-4ee8-9098-7866f9433d13" + }, + "body": null + }, + "200": { + "headers": { + "Date": "Mon, 03 Dec 2018 06:24:53 GMT", + "X-Content-Type-Options": "nosniff", + "x-ms-ratelimit-remaining-subscription-reads": "11999", + "x-ms-request-id": "20708242-215c-4101-9437-44590b27cdbf", + "x-ms-correlation-request-id": "20708242-215c-4101-9437-44590b27cdbf" + }, + "body": { + "status": "Succeeded", + "name": "ca63c855b72d44959653ffcc6eb0b96c", + "properties": null, + "error": null + } + } + } +} \ No newline at end of file From ac84d2729a899a5ceb8b306576efb93ed6ec9de7 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 11 Dec 2018 12:57:02 -0500 Subject: [PATCH 389/464] typo: batch/data-plane/Microsoft.Batch (#4884) - updateable -> updatable - Double word "a" --- .../stable/2018-12-01.8.0/BatchService.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json index 3e91d04cadf1..6ac4c2f7e671 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json @@ -3287,7 +3287,7 @@ "JobSchedule update": { "$ref": "./examples/JobScheduleUpdate.json" } }, "summary": "Updates the properties of the specified job schedule.", - "description": "This fully replaces all the updateable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", + "description": "This fully replaces all the updatable properties of the job schedule. For example, if the schedule property is not specified with this request, then the Batch service will remove the existing schedule. Changes to a job schedule only impact jobs created by the schedule after the update has taken place; currently running jobs are unaffected.", "x-ms-request-id": "request-id", "parameters": [ { @@ -4605,7 +4605,7 @@ "Job update": { "$ref": "./examples/JobUpdate.json" } }, "summary": "Updates the properties of the specified job.", - "description": "This fully replaces all the updateable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", + "description": "This fully replaces all the updatable properties of the job. For example, if the job has constraints associated with it and if constraints is not specified with this request, then the Batch service will remove the existing constraints.", "x-ms-request-id": "request-id", "parameters": [ { @@ -7441,7 +7441,7 @@ "Pool update": { "$ref": "./examples/PoolUpdate.json" } }, "summary": "Updates the properties of the specified pool.", - "description": "This fully replaces all the updateable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", + "description": "This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.", "x-ms-request-id": "request-id", "parameters": [ { @@ -9245,7 +9245,7 @@ "Node update user": { "$ref": "./examples/NodeUpdateUser.json" } }, "summary": "Updates the password and expiration time of a user account on the specified compute node.", - "description": "This operation replaces of all the updateable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", + "description": "This operation replaces of all the updatable properties of the account. For example, if the expiryTime element is not specified, the current value is replaced with the default value, not left unmodified. You can update a user account on a node only when it is in the idle or running state.", "x-ms-request-id": "request-id", "parameters": [ { @@ -11576,7 +11576,7 @@ "userIdentity": { "$ref": "#/definitions/UserIdentity", "title": "The user identity under which the Job Preparation task runs.", - "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a a non-administrative user unique to the pool on Linux nodes." + "description": "If omitted, the task runs as a non-administrative user unique to the task on Windows nodes, or a non-administrative user unique to the pool on Linux nodes." }, "rerunOnNodeRebootAfterSuccess": { "type": "boolean", @@ -12462,7 +12462,7 @@ "networkConfiguration": { "$ref": "#/definitions/JobNetworkConfiguration", "title": "The network configuration for the job." - }, + }, "metadata": { "type": "array", "items": { @@ -12556,7 +12556,7 @@ "networkConfiguration": { "$ref": "#/definitions/JobNetworkConfiguration", "title": "The network configuration for the job." - } + } }, "required": [ "id", "poolInfo" ], "title": "An Azure Batch job to add." From d39a349839d2cb1d3ee73f879940b4680ff75d0e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 11 Dec 2018 13:29:08 -0500 Subject: [PATCH 390/464] typo: azsadmin/resource-manager/storage/Microsoft.Storage.Admin (#4887) - servie -> service --- .../preview/2016-05-01/tableServices.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json index 528e83417535..edfb7523ccaa 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json @@ -19,14 +19,14 @@ "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Storage.Admin/farms/{farmId}/tableservices/{serviceType}": { "get": { "x-ms-examples": { - "Returns the table servie.": { + "Returns the table service.": { "$ref": "./examples/TableService/Get.json" } }, "tags": [ "TableServices" ], - "description": "Returns the table servie.", + "description": "Returns the table service.", "operationId": "TableServices_Get", "parameters": [ { From 13b129edcba5ef2f126c3e7a85a46266dcc2f2f0 Mon Sep 17 00:00:00 2001 From: Julien Stroheker Date: Tue, 11 Dec 2018 10:30:27 -0800 Subject: [PATCH 391/464] ContainerServices - OpenShift - Add new routes and update (#4597) * Add the OpenShiftManagedClusters_ListByResourceGroup and OpenShiftManagedClusters_List route + Examples Update the Examples Add the new supported SKUs * Fix API Version in example * remove private preview count limitations * Update description to remove min and max limitations --- ...OpenShiftManagedClustersCreate_Update.json | 68 ++--- .../examples/OpenShiftManagedClustersGet.json | 27 +- .../OpenShiftManagedClustersList.json | 74 +++++ ...iftManagedClustersListByResourceGroup.json | 75 +++++ .../OpenShiftManagedClustersUpdateTags.json | 22 +- .../openShiftManagedClusters.json | 257 ++++++++++++------ 6 files changed, 379 insertions(+), 144 deletions(-) create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json index 01bff520aec2..c783cccc34bf 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersCreate_Update.json @@ -13,13 +13,13 @@ "properties": { "openShiftVersion": "v3.10", "fqdn": "clustername1.location1.cloudapp.azure.com", - "networkProfile":{ - "vnetCidr":"10.0.0.0/8" + "networkProfile": { + "vnetCidr": "10.0.0.0/8" }, "masterPoolProfile": { "name": "master", "count": 3, - "vmSize": "Standard_D2s_v3", + "vmSize": "Standard_D4s_v3", "osType": "Linux", "subnetCidr": "10.0.0.0/24" }, @@ -47,15 +47,17 @@ } ], "authProfile": { - "identityProviders": [{ - "name": "Azure AD", - "provider": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { "kind": "AADIdentityProvider", "clientId": "clientId", "secret": "secret", "tenantId": "tenantId" - } - }] + } + } + ] } } } @@ -75,13 +77,13 @@ "provisioningState": "Succeeded", "openShiftVersion": "v3.10", "fqdn": "clustername1.location1.cloudapp.azure.com", - "networkProfile":{ - "vnetCidr":"10.0.0.0/8" + "networkProfile": { + "vnetCidr": "10.0.0.0/8" }, "masterPoolProfile": { - "count": 3, - "vmSize": "Standard_D2s_v3", - "subnetCidr": "10.0.0.0/24" + "count": 3, + "vmSize": "Standard_D4s_v3", + "subnetCidr": "10.0.0.0/24" }, "agentPoolProfiles": [ { @@ -109,14 +111,16 @@ } ], "authProfile": { - "identityProviders": [{ - "name": "Azure AD", - "provider": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { "kind": "AADIdentityProvider", "clientId": "clientId", "tenantId": "tenantId" - } - }] + } + } + ] } } } @@ -135,15 +139,15 @@ "provisioningState": "Creating", "openShiftVersion": "v3.10", "fqdn": "clustername1.location1.cloudapp.azure.com", - "networkProfile":{ - "vnetCidr":"10.0.0.0/8" + "networkProfile": { + "vnetCidr": "10.0.0.0/8" }, "masterPoolProfile": { - "name": "master", - "count": 3, - "vmSize": "Standard_D2s_v3", - "osType": "Linux", - "subnetCidr": "10.0.0.0/24" + "name": "master", + "count": 3, + "vmSize": "Standard_D4s_v3", + "osType": "Linux", + "subnetCidr": "10.0.0.0/24" }, "agentPoolProfiles": [ { @@ -169,16 +173,18 @@ } ], "authProfile": { - "identityProviders": [{ - "name": "Azure AD", - "provider": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { "kind": "AADIdentityProvider", "clientId": "clientId", "tenantId": "tenantId" - } - }] + } + } + ] } - } + } } } } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json index d54e3a4110bb..395f2a33e128 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersGet.json @@ -20,13 +20,13 @@ "provisioningState": "Succeeded", "openShiftVersion": "v3.10", "fqdn": "clustername1.location1.cloudapp.azure.com", - "networkProfile":{ - "vnetCidr":"10.0.0.0/8" + "networkProfile": { + "vnetCidr": "10.0.0.0/8" }, "masterPoolProfile": { - "count": 3, - "vmSize": "Standard_D2s_v3", - "subnetCidr": "10.0.0.0/24" + "count": 3, + "vmSize": "Standard_D4s_v3", + "subnetCidr": "10.0.0.0/24" }, "agentPoolProfiles": [ { @@ -55,14 +55,15 @@ ], "authProfile": { "identityProviders": [ - { - "name": "Azure AD", - "provider": { - "kind": "AADIdentityProvider", - "clientId": "clientId", - "tenantId": "tenantId" - } - }] + { + "name": "Azure AD", + "provider": { + "kind": "AADIdentityProvider", + "clientId": "clientId", + "tenantId": "tenantId" + } + } + ] } } } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json new file mode 100644 index 000000000000..977c544c54aa --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersList.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-09-30-preview", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/openShiftManagedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/OpenShiftManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "openShiftVersion": "v3.10", + "fqdn": "clustername1.location1.cloudapp.azure.com", + "networkProfile": { + "vnetCidr": "10.0.0.0/8" + }, + "masterPoolProfile": { + "count": 3, + "vmSize": "Standard_D4s_v3", + "subnetCidr": "10.0.0.0/24" + }, + "agentPoolProfiles": [ + { + "name": "infra", + "role": "infra", + "count": 2, + "vmSize": "Standard_D4s_v3", + "osType": "Linux", + "subnetCidr": "10.0.0.0/24" + }, + { + "name": "compute", + "role": "compute", + "count": 4, + "vmSize": "Standard_D4s_v3", + "osType": "Linux", + "subnetCidr": "10.0.0.0/24" + } + ], + "routerProfiles": [ + { + "fqdn": "dce5faa189c841b99f8a.location1.cloudapp.azure.com", + "name": "default", + "publicSubdomain": "b788fade68d345da9b77.location1.int.aksapp.io" + } + ], + "authProfile": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { + "kind": "AADIdentityProvider", + "clientId": "clientId", + "tenantId": "tenantId" + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..b6c9654f549a --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersListByResourceGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2018-09-30-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/openShiftManagedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/OpenShiftManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "openShiftVersion": "v3.10", + "fqdn": "clustername1.location1.cloudapp.azure.com", + "networkProfile": { + "vnetCidr": "10.0.0.0/8" + }, + "masterPoolProfile": { + "count": 3, + "vmSize": "Standard_D4s_v3", + "subnetCidr": "10.0.0.0/24" + }, + "agentPoolProfiles": [ + { + "name": "infra", + "role": "infra", + "count": 2, + "vmSize": "Standard_D4s_v3", + "osType": "Linux", + "subnetCidr": "10.0.0.0/24" + }, + { + "name": "compute", + "role": "compute", + "count": 4, + "vmSize": "Standard_D4s_v3", + "osType": "Linux", + "subnetCidr": "10.0.0.0/24" + } + ], + "routerProfiles": [ + { + "fqdn": "dce5faa189c841b99f8a.location1.cloudapp.azure.com", + "name": "default", + "publicSubdomain": "b788fade68d345da9b77.location1.int.aksapp.io" + } + ], + "authProfile": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { + "kind": "AADIdentityProvider", + "clientId": "clientId", + "tenantId": "tenantId" + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json index fc939f348e06..bacae0cab82f 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/examples/OpenShiftManagedClustersUpdateTags.json @@ -26,13 +26,13 @@ "provisioningState": "Succeeded", "openShiftVersion": "v3.10", "fqdn": "clustername1.location1.cloudapp.azure.com", - "networkProfile":{ - "vnetCidr":"10.0.0.0/8" + "networkProfile": { + "vnetCidr": "10.0.0.0/8" }, "masterPoolProfile": { - "count": 3, - "vmSize": "Standard_D2s_v3", - "subnetCidr": "10.0.0.0/24" + "count": 3, + "vmSize": "Standard_D4s_v3", + "subnetCidr": "10.0.0.0/24" }, "agentPoolProfiles": [ { @@ -60,14 +60,16 @@ } ], "authProfile": { - "identityProviders": [{ - "name": "Azure AD", - "provider": { + "identityProviders": [ + { + "name": "Azure AD", + "provider": { "kind": "AADIdentityProvider", "clientId": "clientId", "tenantId": "tenantId" - } - }] + } + } + ] } } } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json index f43a0f78f1cb..3c0f404db22a 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json @@ -6,20 +6,12 @@ "version": "2018-09-30-preview" }, "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], "security": [ { - "azure_auth": [ - "user_impersonation" - ] + "azure_auth": ["user_impersonation"] } ], "securityDefinitions": { @@ -34,11 +26,80 @@ } }, "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters/{resourceName}": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/openShiftManagedClusters": { "get": { - "tags": [ - "OpenShiftManagedClusters" + "tags": ["OpenShiftManagedClusters"], + "operationId": "OpenShiftManagedClusters_List", + "summary": "Gets a list of OpenShift managed clusters in the specified subscription.", + "description": "Gets a list of OpenShift managed clusters in the specified subscription. The operation returns properties of each OpenShift managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/OpenShiftManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters": { + "get": { + "tags": ["OpenShiftManagedClusters"], + "operationId": "OpenShiftManagedClusters_ListByResourceGroup", + "summary": "Lists OpenShift managed clusters in the specified subscription and resource group.", + "description": "Lists OpenShift managed clusters in the specified subscription and resource group. The operation returns properties of each OpenShift managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OpenShiftManagedClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/OpenShiftManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/openShiftManagedClusters/{resourceName}": { + "get": { + "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_Get", "summary": "Gets a openshift managed cluster.", "description": "Gets the details of the managed openshift cluster with a specified resource group and name.", @@ -85,9 +146,7 @@ } }, "put": { - "tags": [ - "OpenShiftManagedClusters" - ], + "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_CreateOrUpdate", "summary": "Creates or updates an openshift managed cluster.", "description": "Creates or updates a openshift managed cluster with the specified configuration for agents and OpenShift version.", @@ -150,9 +209,7 @@ } }, "patch": { - "tags": [ - "OpenShiftManagedClusters" - ], + "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_UpdateTags", "summary": "Updates tags on an openshift managed cluster.", "description": "Updates an openshift managed cluster with the specified tags.", @@ -209,9 +266,7 @@ } }, "delete": { - "tags": [ - "OpenShiftManagedClusters" - ], + "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_Delete", "summary": "Deletes an openshift managed cluster.", "description": "Deletes the openshift managed cluster with a specified resource group and name.", @@ -282,10 +337,7 @@ "location": { "type": "string", "description": "Resource location", - "x-ms-mutability": [ - "read", - "create" - ] + "x-ms-mutability": ["read", "create"] }, "tags": { "type": "object", @@ -295,16 +347,15 @@ "description": "Resource tags" } }, - "required": [ - "location" - ], + "required": ["location"], "x-ms-azure-resource": true }, "CloudError": { "x-ms-external": true, "properties": { "error": { - "$ref": "#/definitions/CloudErrorBody" + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." } }, "description": "An error response from the Container service." @@ -361,7 +412,7 @@ "type": "string", "description": "Name of the router profile." }, - "publicSubdomain" : { + "publicSubdomain": { "type": "string", "description": "DNS subdomain for openshift router." }, @@ -380,7 +431,7 @@ "description": "CIDR for the OpenShift Vnet.", "default": "10.0.0.0/8" }, - "peerVnetId" : { + "peerVnetId": { "type": "string", "description": "CIDR of the Vnet to peer." } @@ -390,10 +441,7 @@ "OSType": { "type": "string", "default": "Linux", - "enum": [ - "Linux", - "Windows" - ], + "enum": ["Linux", "Windows"], "x-ms-enum": { "name": "OSType", "modelAsString": true @@ -409,15 +457,43 @@ "description": "Size of OpenShift VMs.", "enum": [ "Standard_D2s_v3", - "Standard_D4s_v3" + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8s", + "Standard_F16s", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E20s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s" ] }, "OpenShiftAgentPoolProfileRole": { "type": "string", - "enum": [ - "compute", - "infra" - ], + "enum": ["compute", "infra"], "x-ms-enum": { "name": "OpenShiftAgentPoolProfileRole", "modelAsString": true @@ -433,10 +509,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 10, - "minimum": 1, - "description": "Number of masters (VMs) to host docker containers. The default value is 3.", - "default": 3 + "description": "Number of masters (VMs) to host docker containers. The default value is 3." }, "vmSize": { "$ref": "#/definitions/OpenShiftContainerServiceVMSize", @@ -451,10 +524,7 @@ "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." } }, - "required": [ - "count", - "vmSize" - ], + "required": ["count", "vmSize"], "description": "OpenShiftManagedClusterMaterPoolProfile contains configuration for OpenShift master VMs." }, "OpenShiftManagedClusterAgentPoolProfile": { @@ -466,10 +536,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 5, - "minimum": 1, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 5 (inclusive). The default value is 2. ", - "default": 2 + "description": "Number of agents (VMs) to host docker containers." }, "vmSize": { "$ref": "#/definitions/OpenShiftContainerServiceVMSize", @@ -484,16 +551,12 @@ "$ref": "#/definitions/OSType", "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." }, - "role" : { + "role": { "description": "Define the role of the AgentPoolProfile.", "$ref": "#/definitions/OpenShiftAgentPoolProfileRole" } }, - "required": [ - "name", - "count", - "vmSize" - ], + "required": ["name", "count", "vmSize"], "description": "Defines the configuration of the OpenShift cluster VMs." }, "OpenShiftManagedClusterIdentityProvider": { @@ -513,7 +576,7 @@ "properties": { "identityProviders": { "type": "array", - "items" : { + "items": { "$ref": "#/definitions/OpenShiftManagedClusterIdentityProvider" }, "description": "Type of authentication profile to use." @@ -567,9 +630,7 @@ "description": "Configures OpenShift authentication." } }, - "required": [ - "openShiftVersion" - ], + "required": ["openShiftVersion"], "description": "Properties of the openshift managed cluster." }, "OpenShiftManagedCluster": { @@ -579,7 +640,7 @@ }, { "properties": { - "plan" : { + "plan": { "description": "Define the resource plan as required by ARM for billing purposes", "$ref": "#/definitions/PurchasePlan" }, @@ -593,40 +654,39 @@ ], "description": "OpenShift Managed cluster." }, - "OpenShiftManagedClusterBaseIdentityProvider": - { + "OpenShiftManagedClusterBaseIdentityProvider": { "discriminator": "kind", "required": ["kind"], "properties": { - "kind": { - "type": "string", - "description": "The kind of the provider." - } - }, - "description": "Structure for any Identity provider." + "kind": { + "type": "string", + "description": "The kind of the provider." + } + }, + "description": "Structure for any Identity provider." }, "OpenShiftManagedClusterAADIdentityProvider": { "x-ms-discriminator-value": "AADIdentityProvider", "allOf": [ - { + { "$ref": "#/definitions/OpenShiftManagedClusterBaseIdentityProvider" - }, - { - "properties": { - "clientId": { - "type": "string", - "description": "The clientId password associated with the provider." - }, - "secret": { - "type": "string", - "description": "The secret password associated with the provider." - }, - "tenantId": { - "type": "string", - "description": "The tenantId associated with the provider." + }, + { + "properties": { + "clientId": { + "type": "string", + "description": "The clientId password associated with the provider." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the provider." + }, + "tenantId": { + "type": "string", + "description": "The tenantId associated with the provider." + } } } - } ], "description": "Defines the Identity provider for MS AAD." }, @@ -641,6 +701,23 @@ } }, "description": "Tags object for patch operations." + }, + "OpenShiftManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OpenShiftManagedCluster" + }, + "description": "The list of OpenShift managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of OpenShift managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List OpenShift Managed Clusters operation." } }, "parameters": { From 7d78a66184bbc5bcb0b3140e3586af957cffef51 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 11 Dec 2018 13:44:28 -0500 Subject: [PATCH 392/464] typo: apimanagement/resource-manager/Microsoft.ApiManagement (#4881) - Petstore -> PetStore - reponse ->response - assosiated -> associated - dignostic -> diagnostic --- .../preview/2018-06-01-preview/apimapis.json | 4 ++-- ...ApiManagementGetApiOperationPetStore.json} | 0 .../stable/2017-03-01/apimapis.json | 20 +++++++++---------- 3 files changed, 12 insertions(+), 12 deletions(-) rename specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/{ApiManagementGetApiOperationPetstore.json => ApiManagementGetApiOperationPetStore.json} (100%) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json index 77b2b292b596..e79c7e9f84bc 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/apimapis.json @@ -920,8 +920,8 @@ "ApiManagementGetApiOperation": { "$ref": "./examples/ApiManagementGetApiOperation.json" }, - "ApiManagementGetApiOperationPetstore": { - "$ref": "./examples/ApiManagementGetApiOperationPetstore.json" + "ApiManagementGetApiOperationPetStore": { + "$ref": "./examples/ApiManagementGetApiOperationPetStore.json" } }, "parameters": [ diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetStore.json similarity index 100% rename from specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetstore.json rename to specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2018-06-01-preview/examples/ApiManagementGetApiOperationPetStore.json diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json index c0131325dd01..a844d40dd12e 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2017-03-01/apimapis.json @@ -2038,7 +2038,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of diagnostics for an API.", + "description": "Paged Result response of diagnostics for an API.", "schema": { "$ref": "./apimdiagnostics.json#/definitions/DiagnosticCollection" } @@ -2342,7 +2342,7 @@ "ApiDiagnosticLoggers" ], "operationId": "ApiDiagnosticLogger_ListByService", - "description": "Lists all loggers assosiated with the specified Diagnostic of an API.", + "description": "Lists all loggers associated with the specified Diagnostic of an API.", "x-ms-examples": { "ApiManagementListApiDiagnosticLoggers": { "$ref": "./examples/ApiManagementListApiDiagnosticLoggers.json" @@ -2383,7 +2383,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of loggers assigned to the specified Diagnostic.", + "description": "Paged Result response of loggers assigned to the specified Diagnostic.", "schema": { "$ref": "./apimloggers.json#/definitions/LoggerCollection" } @@ -2453,7 +2453,7 @@ "ApiDiagnosticLoggers" ], "operationId": "ApiDiagnosticLogger_CreateOrUpdate", - "description": "Attaches a logger to a dignostic for an API.", + "description": "Attaches a logger to a diagnostic for an API.", "x-ms-examples": { "ApiManagementCreateApiDiagnosticLogger": { "$ref": "./examples/ApiManagementCreateApiDiagnosticLogger.json" @@ -2556,7 +2556,7 @@ "ApiIssues" ], "operationId": "ApiIssues_ListByService", - "description": "Lists all issues assosiated with the specified API.", + "description": "Lists all issues associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssues": { "$ref": "./examples/ApiManagementListApiIssues.json" @@ -2594,7 +2594,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issues for the API.", + "description": "Paged Result response of issues for the API.", "schema": { "$ref": "#/definitions/IssueCollection" } @@ -2839,7 +2839,7 @@ "ApiIssueComments" ], "operationId": "ApiIssueComments_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueComments": { "$ref": "./examples/ApiManagementListApiIssueComments.json" @@ -2880,7 +2880,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueCommentCollection" } @@ -3137,7 +3137,7 @@ "ApiIssueAttachments" ], "operationId": "ApiIssueAttachments_ListByService", - "description": "Lists all comments for the Issue assosiated with the specified API.", + "description": "Lists all comments for the Issue associated with the specified API.", "x-ms-examples": { "ApiManagementListApiIssueAttachments": { "$ref": "./examples/ApiManagementListApiIssueAttachments.json" @@ -3178,7 +3178,7 @@ ], "responses": { "200": { - "description": "Paged Result reponse of issue comments for the API.", + "description": "Paged Result response of issue comments for the API.", "schema": { "$ref": "#/definitions/IssueAttachmentCollection" } From a2323a5bf8cd642bee954f7b49ff4fe1976cdeec Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 11 Dec 2018 13:56:24 -0500 Subject: [PATCH 393/464] typo: machinelearningservices/resource-manager/Microsoft.MachineLearningServices (#4889) * typo: machinelearningservices/resource-manager/Microsoft.MachineLearningServices - configugation -> configuration - creadentials -> credentials * fix: Examples machinelearningservices/resource-manager/Microsoft.MachineLearningServices - "Succeeded" casing --- .../stable/2018-11-19/examples/getAmlCompute.json | 2 +- .../2018-11-19/examples/listAmlComputeByWorkspace.json | 4 ++-- .../stable/2018-11-19/machineLearningServices.json | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json index 9e25f6eecf60..4b52399c1dc0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/getAmlCompute.json @@ -17,7 +17,7 @@ "description": "some compute", "computeType": "AmlCompute", "createdOn": "2017-09-26T22:28:08.327Z", - "provisioningState": "succeeded", + "provisioningState": "Succeeded", "properties": { "vmSize": "STANDARD_NC6", "vmPriority": "Dedicated", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json index bf00f5370e39..8a0dfd9d0af8 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/listAmlComputeByWorkspace.json @@ -15,7 +15,7 @@ "type": "Microsoft.MachineLearningServices/workspaces/computes", "properties": { "createdOn": "2017-09-26T22:28:08.327Z", - "provisioningState": "succeeded", + "provisioningState": "Succeeded", "properties": { "allocationState": "Resizing", "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", @@ -38,7 +38,7 @@ "leavingNodeCount": 0, "preemptedNodeCount": 0 } - } + } } } ] diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json index 55c2232bad05..be8e353ed03a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json @@ -439,7 +439,7 @@ "nextLinkName": null } } - }, + }, "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { "get": { "tags": [ @@ -1782,7 +1782,7 @@ }, "SslConfiguration": { "type": "object", - "description": "The ssl configugation for scoring", + "description": "The ssl configuration for scoring", "properties": { "status": { "description": "Enable or disable ssl for scoring", @@ -2082,7 +2082,7 @@ "type": "object", "properties": { "administratorAccount": { - "description": "Admin creadentials for virtual machine.", + "description": "Admin credentials for virtual machine.", "$ref": "#/definitions/VirtualMachineSshCredentials" } } From bdb2d959553f32c6dd73db023b21c56b6392d927 Mon Sep 17 00:00:00 2001 From: wengjn Date: Tue, 11 Dec 2018 15:10:50 -0800 Subject: [PATCH 394/464] Add three new APIs to microsoft.resourcehealth (#4796) * Add three new APIs to microsoft.resourcehealth * fix the schema for new apis reuse the old schema instead of creating new ones * fix schema another error * Change resource type name as suggested from ARM review Change resource type name as suggested from ARM review: childAvailabilityStatuses and childResources --- ...ChildAvailabilityStatus_GetByResource.json | 36 +++++ .../ChildAvailabilitystatuses_List.json | 149 +++++++++++++++++ .../examples/ChildResources_List.json | 94 +++++++++++ .../stable/2015-01-01/resourcehealth.json | 153 ++++++++++++++++++ ...ChildAvailabilityStatus_GetByResource.json | 36 +++++ .../ChildAvailabilitystatuses_List.json | 149 +++++++++++++++++ .../examples/ChildResources_List.json | 94 +++++++++++ .../stable/2017-07-01/resourcehealth.json | 148 +++++++++++++++++ 8 files changed, 859 insertions(+) create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatus_GetByResource.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildResources_List.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatus_GetByResource.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildResources_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatus_GetByResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatus_GetByResource.json new file mode 100644 index 000000000000..15a75ad64031 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatus_GetByResource.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceUri":"resourceUri", + "api-version": "2015-01-01", + "$expand": "recommendedactions" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:19:11.955255Z", + "RecommendedActions": [{ + "Action": "To start this virtual machine, open the resource blade and click Start", + "ActionUrl": "<#ResourceBlade>", + "ActionUrlText": "resource blade" + }, + { + "Action": "If you are experiencing problems you believe are caused by Azure, contact support", + "ActionUrl": "<#SupportCase>", + "ActionUrlText": "contact support" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json new file mode 100644 index 000000000000..915d7aca5c0e --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json @@ -0,0 +1,149 @@ +{ + "parameters":{ + "resourceUri":"resourceUri", + "api-version":"2015-01-01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Transient", + "reportedTime": "2018-12-05T19:45:45.6640838Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+23%3a36%3a03Z", + "name": "2018-11-30+23%3a36%3a03Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Unavailable", + "summary": "This virtual machine is rebooting as requested by an authorized user or process. It will be back online after the reboot completes.", + "detailedStatus": "", + "reasonType": "Customer Initiated", + "rootCauseAttributionTime": "2018-11-30T23:36:02.514Z", + "recommendedActions": [ + { + "action": "Check back here for status updates", + "actionUrl": "", + "actionUrlText": "" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T23:36:03Z", + "reasonChronicity": "Transient", + "resolutionETA": "2018-11-30T23:56:03Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+22%3a32%3a12Z", + "name": "2018-11-30+22%3a32%3a12Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T22:32:12Z", + "reasonChronicity": "Transient" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+22%3a30%3a23Z", + "name": "2018-11-30+22%3a30%3a23Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Unavailable", + "summary": "This virtual machine is rebooting as requested by an authorized user or process. It will be back online after the reboot completes.", + "detailedStatus": "", + "reasonType": "Customer Initiated", + "rootCauseAttributionTime": "2018-11-30T22:30:22.256Z", + "recommendedActions": [ + { + "action": "Check back here for status updates", + "actionUrl": "", + "actionUrlText": "" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T22:30:23Z", + "reasonChronicity": "Transient", + "resolutionETA": "2018-11-30T22:50:23Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-21+00%3a00%3a00Z", + "name": "2018-11-21+00%3a00%3a00Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-21T00:00:00Z", + "reasonChronicity": "Transient" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildResources_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildResources_List.json new file mode 100644 index 000000000000..4583b7e15b39 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildResources_List.json @@ -0,0 +1,94 @@ +{ + "parameters":{ + "resourceUri":"resourceUri", + "api-version":"2015-01-01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/0/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_0", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:43Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/3/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_3", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:41Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/1/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_1", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:48Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/2/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_2", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:43Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_4", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json index 65286861885f..c4aec6044b53 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json @@ -164,6 +164,7 @@ } } }, + "x-ms-examples": { "GetCurrentHealthByResource": { "$ref": "./examples/AvailabilityStatus_GetByResource.json" @@ -221,6 +222,154 @@ } } }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current": { + "get": { + "tags": [ + "ChildAvailabilityStatuses" + ], + "operationId": "ChildAvailabilityStatuses_GetByResource", + "description": "Gets current availability status for a single resource", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the current availability status for a single resource", + "schema": { + "$ref": "#/definitions/availabilityStatus" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + + "x-ms-examples": { + "GetCurrentHealthByResource": { + "$ref": "./examples/ChildAvailabilityStatus_GetByResource.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses": { + "get": { + "tags": [ + "ChildAvailabilityStatuses" + ], + "operationId": "ChildAvailabilityStatuses_List", + "description": "Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the list of the historical availability statuses for a single child resource", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetHealthHistoryByResource": { + "$ref": "./examples/ChildAvailabilitystatuses_List.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childResources": { + "get": { + "tags": [ + "ChildResources" + ], + "operationId": "ChildResources_List", + "description": "Lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the list of the children's current availability statuses for a single resource which contains children", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetHealthHistoryByResource": { + "$ref": "./examples/ChildResources_List.json" + } + } + } + }, "/providers/Microsoft.ResourceHealth/operations": { "get": { "tags": [ @@ -351,6 +500,10 @@ "description": "Timestamp for when the health was last checked. ", "format": "date-time" }, + "isArmResource": { + "type": "boolean", + "description": "flag to show if child resource need detail health. " + }, "recentlyResolvedState": { "type": "object", "description": "An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned", diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatus_GetByResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatus_GetByResource.json new file mode 100644 index 000000000000..15a75ad64031 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatus_GetByResource.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "resourceUri":"resourceUri", + "api-version": "2015-01-01", + "$expand": "recommendedactions" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:19:11.955255Z", + "RecommendedActions": [{ + "Action": "To start this virtual machine, open the resource blade and click Start", + "ActionUrl": "<#ResourceBlade>", + "ActionUrlText": "resource blade" + }, + { + "Action": "If you are experiencing problems you believe are caused by Azure, contact support", + "ActionUrl": "<#SupportCase>", + "ActionUrlText": "contact support" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json new file mode 100644 index 000000000000..915d7aca5c0e --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json @@ -0,0 +1,149 @@ +{ + "parameters":{ + "resourceUri":"resourceUri", + "api-version":"2015-01-01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Transient", + "reportedTime": "2018-12-05T19:45:45.6640838Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+23%3a36%3a03Z", + "name": "2018-11-30+23%3a36%3a03Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Unavailable", + "summary": "This virtual machine is rebooting as requested by an authorized user or process. It will be back online after the reboot completes.", + "detailedStatus": "", + "reasonType": "Customer Initiated", + "rootCauseAttributionTime": "2018-11-30T23:36:02.514Z", + "recommendedActions": [ + { + "action": "Check back here for status updates", + "actionUrl": "", + "actionUrlText": "" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T23:36:03Z", + "reasonChronicity": "Transient", + "resolutionETA": "2018-11-30T23:56:03Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+22%3a32%3a12Z", + "name": "2018-11-30+22%3a32%3a12Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T22:32:12Z", + "reasonChronicity": "Transient" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-30+22%3a30%3a23Z", + "name": "2018-11-30+22%3a30%3a23Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Unavailable", + "summary": "This virtual machine is rebooting as requested by an authorized user or process. It will be back online after the reboot completes.", + "detailedStatus": "", + "reasonType": "Customer Initiated", + "rootCauseAttributionTime": "2018-11-30T22:30:22.256Z", + "recommendedActions": [ + { + "action": "Check back here for status updates", + "actionUrl": "", + "actionUrlText": "" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-30T22:30:23Z", + "reasonChronicity": "Transient", + "resolutionETA": "2018-11-30T22:50:23Z" + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/availabilityStatuses/2018-11-21+00%3a00%3a00Z", + "name": "2018-11-21+00%3a00%3a00Z", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "recommendedActions": [ + { + "action": "If you're having problems, use the Troubleshoot tool to get recommended solutions.", + "actionUrl": "<#TroubleshootV2Blade>", + "actionUrlText": "Troubleshoot tool" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + } + ], + "occuredTime": "2018-11-21T00:00:00Z", + "reasonChronicity": "Transient" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildResources_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildResources_List.json new file mode 100644 index 000000000000..4583b7e15b39 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildResources_List.json @@ -0,0 +1,94 @@ +{ + "parameters":{ + "resourceUri":"resourceUri", + "api-version":"2015-01-01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/0/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_0", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:43Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/3/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_3", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:41Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/1/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_1", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:48Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/2/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_2", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:43Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + }, + { + "id": "/subscriptions/227b734f-e14f-4de6-b7fc-3190c21e69f6/resourceGroups/JUHACKETRHCTEST/providers/Microsoft.Compute/virtualMachineScaleSets/rhctest/virtualMachines/4/providers/Microsoft.ResourceHealth/child/availabilityStatuses/current", + "name": "rhctest_4", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "southcentralus", + "properties": { + "availabilityState": "Available", + "summary": "There aren't any known Azure platform problems affecting this virtual machine", + "detailedStatus": "", + "reasonType": "", + "occuredTime": "2018-11-30T23:37:44Z", + "reasonChronicity": "Persistent", + "reportedTime": "2018-12-04T01:18:25.575477Z", + "isArmResource": true + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json index 51cbc405f81f..e6cade97e1e7 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json @@ -221,6 +221,154 @@ } } }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses/current": { + "get": { + "tags": [ + "ChildAvailabilityStatuses" + ], + "operationId": "ChildAvailabilityStatuses_GetByResource", + "description": "Gets current availability status for a single resource", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the current availability status for a single resource", + "schema": { + "$ref": "#/definitions/availabilityStatus" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + + "x-ms-examples": { + "GetCurrentHealthByResource": { + "$ref": "./examples/ChildAvailabilityStatus_GetByResource.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childAvailabilityStatuses": { + "get": { + "tags": [ + "ChildAvailabilityStatuses" + ], + "operationId": "ChildAvailabilityStatuses_List", + "description": "Lists the historical availability statuses for a single child resource. Use the nextLink property in the response to get the next page of availability status", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the list of the historical availability statuses for a single child resource", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetHealthHistoryByResource": { + "$ref": "./examples/ChildAvailabilitystatuses_List.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/childResources": { + "get": { + "tags": [ + "ChildResources" + ], + "operationId": "ChildResources_List", + "description": "Lists the all the children and its current health status for a parent resource. Use the nextLink property in the response to get the next page of children current health", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API only support not nested parent resource type: /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The body contains the list of the children's current availability statuses for a single resource which contains children", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetHealthHistoryByResource": { + "$ref": "./examples/ChildResources_List.json" + } + } + } + }, "/providers/Microsoft.ResourceHealth/operations": { "get": { "tags": [ From 470c548872bf64ad3872746004b91f79e4d7ec2d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Tue, 11 Dec 2018 18:12:32 -0500 Subject: [PATCH 395/464] typo: commerce/resource-manager/Microsoft.Commerce (#4888) - Ratecard -> RateCard --- .../Microsoft.Commerce/preview/2015-06-01-preview/commerce.json | 2 +- .../examples/{GetRatecard.json => GetRateCard.json} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/examples/{GetRatecard.json => GetRateCard.json} (100%) diff --git a/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json b/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json index 15ba153a1219..56df44f80259 100644 --- a/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json +++ b/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/commerce.json @@ -112,7 +112,7 @@ }, "x-ms-examples": { "GetRateCard": { - "$ref": "./examples/GetRatecard.json" + "$ref": "./examples/GetRateCard.json" } }, "parameters": [ diff --git a/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/examples/GetRatecard.json b/specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/examples/GetRateCard.json similarity index 100% rename from specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/examples/GetRatecard.json rename to specification/commerce/resource-manager/Microsoft.Commerce/preview/2015-06-01-preview/examples/GetRateCard.json From 8751b9ca1071b51f56d823e6d121ad54b9c2ccae Mon Sep 17 00:00:00 2001 From: Sapan Saxena <31940305+anusapan@users.noreply.github.com> Date: Tue, 11 Dec 2018 16:01:15 -0800 Subject: [PATCH 396/464] Add package-2018-12-preview (#4868) * Add package-2018-12 to Go SDK build * fixed PR failure * Adding 2018-12-01-preview package to GO * removing preview from Go * fixed PR comment --- .../iothub/resource-manager/readme.go.md | 10 ++++++++ .../iothub/resource-manager/readme.md | 25 ++++++++++++++++++- 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/specification/iothub/resource-manager/readme.go.md b/specification/iothub/resource-manager/readme.go.md index 843e1a155609..3cc41c079f70 100644 --- a/specification/iothub/resource-manager/readme.go.md +++ b/specification/iothub/resource-manager/readme.go.md @@ -13,12 +13,22 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-12-preview - tag: package-2018-04 - tag: package-2018-01 - tag: package-2017-07 - tag: package-2017-01 - tag: package-2016-02 ``` +### Tag: package-2018-12-preview and go + +These settings apply only when `--tag=package-2018-12-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-12-preview' && $(go) +output-folder: $(go-sdk-folder)/services/iothub/mgmt/2018-12-01-preview/$(namespace) +``` + ### Tag: package-2018-04 and go These settings apply only when `--tag=package-2018-04 --go` is specified on the command line. diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index 50314ea060fe..c2036b642074 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the IotHub API. ``` yaml openapi-type: arm -tag: package-2018-04 +tag: package-2018-12-preview +``` + +### Tag: package-2018-12-preview + +These settings apply only when `--tag=package-2018-12-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12-preview' +input-file: +- Microsoft.Devices/preview/2018-12-01-preview/iothub.json ``` ### Tag: package-2018-04 @@ -132,9 +141,23 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-iothub ``` yaml $(java) && $(multiapi) batch: + - tag: package-2018-12-preview - tag: package-2018-04 ``` +### Tag: package-2018-12-preview and java + +These settings apply only when `--tag=package-2018-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2018-12-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.iothub.v2018_12_01_preview + output-folder: $(azure-libraries-for-java-folder)/iothub/resource-manager/v2018_12_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2018-04 and java These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. From 84f31a412411aa017ccf48bbc1a0e308be1806c0 Mon Sep 17 00:00:00 2001 From: HimanshuMisra1 <32584077+HimanshuMisra1@users.noreply.github.com> Date: Wed, 12 Dec 2018 10:22:03 -0800 Subject: [PATCH 397/464] =?UTF-8?q?Resource=20Health=20RP=20changes=20for?= =?UTF-8?q?=20new=20resource=20type=20/events=20and=20/impacte=E2=80=A6=20?= =?UTF-8?q?(#4601)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Resource Health RP changes for new resource type /events and /impactedResources * Update with additional properties * Add additional path for single resource * Fixing examples * More model validator fixes * Model validator fixes --- .../preview/2018-08-01/ResourceHealth.json | 1097 +++++++++++++++++ .../AvailabilityStatus_GetByResource.json | 38 + ...ilabilityStatuses_ListByResourceGroup.json | 67 + ...labilityStatuses_ListBySubscriptionId.json | 66 + .../examples/Availabilitystatuses_List.json | 58 + .../examples/Events_ListBySingleResource.json | 92 ++ .../examples/Events_ListBySubscriptionId.json | 93 ++ ...mpactedResources_ListBySubscriptionId.json | 38 + 8 files changed, 1549 insertions(+) create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatus_GetByResource.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListByResourceGroup.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListBySubscriptionId.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json create mode 100644 specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/ImpactedResources_ListBySubscriptionId.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json new file mode 100644 index 000000000000..4cd7b2d047cf --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json @@ -0,0 +1,1097 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-07-01-preview", + "title": "Microsoft.ResourceHealth", + "description": "The Resource Health Client." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/events": { + "get": { + "tags": [ + "Events" + ], + "operationId": "Events_ListBySubscriptionId", + "description": "Lists current service health events in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of current service health events in the subscription", + "schema": { + "$ref": "#/definitions/events" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListEventsBySubscriptionId": { + "$ref": "./examples/Events_ListBySubscriptionId.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/events": { + "get": { + "tags": [ + "Events" + ], + "operationId": "Events_ListBySingleResource", + "description": "Lists current service health events for given resource.", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + } + ], + "responses": { + "200": { + "description": "The list of current service health events for given resource", + "schema": { + "$ref": "#/definitions/events" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListEventsBySingleResource": { + "$ref": "./examples/Events_ListBySingleResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/impactedResources": { + "get": { + "tags": [ + "ImpactedResources" + ], + "operationId": "ImpactedResources_ListBySubscriptionId", + "description": "Lists the current availability status for impacted resources in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The list of current availability status for impacted resources in the subscription", + "schema": { + "$ref": "#/definitions/impactedResourceListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListHealthBySubscriptionId": { + "$ref": "./examples/ImpactedResources_ListBySubscriptionId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ResourceHealth/availabilityStatuses": { + "get": { + "tags": [ + "AvailabilityStatuses" + ], + "operationId": "AvailabilityStatuses_ListBySubscriptionId", + "description": "Lists the current availability status for all the resources in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The list of current availability status for all the resources in the subscription", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListHealthBySubscriptionId": { + "$ref": "./examples/AvailabilityStatuses_ListBySubscriptionId.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ResourceHealth/availabilityStatuses": { + "get": { + "tags": [ + "AvailabilityStatuses" + ], + "operationId": "AvailabilityStatuses_ListByResourceGroup", + "description": "Lists the current availability status for all the resources in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The list of current availability status for all the resources in the resource group", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ListByResourceGroup": { + "$ref": "./examples/AvailabilityStatuses_ListByResourceGroup.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses/current": { + "get": { + "tags": [ + "AvailabilityStatuses" + ], + "operationId": "AvailabilityStatuses_GetByResource", + "description": "Gets current availability status for a single resource", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The current availability status for a single resource", + "schema": { + "$ref": "#/definitions/availabilityStatus" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "GetCurrentHealthByResource": { + "$ref": "./examples/AvailabilityStatus_GetByResource.json" + } + } + } + }, + "/{resourceUri}/providers/Microsoft.ResourceHealth/availabilityStatuses": { + "get": { + "tags": [ + "AvailabilityStatuses" + ], + "operationId": "AvailabilityStatuses_List", + "description": "Lists all historical availability transitions and impacting events for a single resource.", + "parameters": [ + { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types : /subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/{resource-type}/{resource-name} and /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + } + ], + "responses": { + "200": { + "description": "The list of historical availability statuses for a single resource", + "schema": { + "$ref": "#/definitions/availabilityStatusListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetHealthHistoryByResource": { + "$ref": "./examples/Availabilitystatuses_List.json" + } + } + } + }, + "/providers/Microsoft.ResourceHealth/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists available operations for the resourcehealth resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of available operations for the resourcehealth resource provider", + "schema": { + "$ref": "#/definitions/operationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "events": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/event" + }, + "description": "The list of event." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of events. Call ListNext() with this URI to fetch the next page of events." + } + }, + "required": [ + "value" + ], + "description": "The List events operation response." + }, + "event": { + "type": "object", + "description": "Service health event", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "Properties of event.", + "properties": { + "eventType": { + "type": "string", + "description": "Type of event.", + "enum": [ + "ServiceIssue", + "PlannedMaintenance", + "HealthAdvisory", + "RCA" + ], + "x-ms-enum": { + "name": "EventTypeValues", + "modelAsString": true + } + }, + "eventSource": { + "type": "string", + "description": "Source of event.", + "enum": [ + "ResourceHealth", + "ServiceHealth" + ], + "x-ms-enum": { + "name": "EventSourceValues", + "modelAsString": true + } + }, + "status": { + "type": "string", + "description": "Current status of event.", + "enum": [ + "Active", + "Resolved" + ], + "x-ms-enum": { + "name": "EventStatusValues", + "modelAsString": true + } + }, + "title": { + "type": "string", + "description": "Title text of event." + }, + "summary": { + "type": "string", + "description": "Summary text of event." + }, + "header": { + "type": "string", + "description": "Header text of event." + }, + "level": { + "type": "string", + "description": "Level of event.", + "enum": [ + "Critical", + "Warning" + ], + "x-ms-enum": { + "name": "LevelValues", + "modelAsString": true + } + }, + "article": { + "type": "object", + "description": "Article of event.", + "properties": { + "articleContent": { + "type": "string", + "description": "Article content of event." + } + } + }, + "links": { + "type": "array", + "description": "Useful links of event.", + "items": { + "$ref": "#/definitions/link" + } + }, + "impactStartTime": { + "type": "string", + "description": "It provides the Timestamp for when the health impacting event started.", + "format": "date-time" + }, + "impactMitigationTime": { + "type": "string", + "description": "It provides the Timestamp for when the health impacting event resolved.", + "format": "date-time" + }, + "impact": { + "type": "array", + "description": "List services impacted by the service health event.", + "items": { + "$ref": "#/definitions/impact" + } + }, + "recommendedActions": { + "type": "object", + "description": "Recommended actions of event.", + "properties": { + "groupId": { + "type": "integer", + "description": "Recommended action group Id for the service health event." + }, + "title": { + "type": "string", + "description": "Recommended action title for the service health event." + }, + "actions": { + "type": "array", + "description": "Recommended actions for the service health event.", + "items": { + "type": "string", + "description": "Recommended action for the service health event." + } + }, + "localeCode": { + "type": "string", + "description": "Recommended action locale for the service health event." + } + } + }, + "faqs": { + "type": "array", + "description": "Frequently asked questions for the service health event.", + "items": { + "$ref": "#/definitions/faq" + } + } + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "link": { + "description": "Useful links for service health event.", + "properties": { + "type": { + "type": "string", + "description": "Type of link.", + "enum": [ + "Button", + "Hyperlink" + ], + "x-ms-enum": { + "name": "LinkTypeValues", + "modelAsString": true + } + }, + "displayText": { + "type": "object", + "description": "Display text of link.", + "properties": { + "value": { + "type": "string", + "description": "Display text of link." + }, + "localizedValue": { + "type": "string", + "description": "Localized display text of link." + } + } + }, + "extensionName": { + "type": "string", + "description": "It provides the name of portal extension to produce link for given service health event." + }, + "bladeName": { + "type": "string", + "description": "It provides the name of portal extension blade to produce link for given service health event." + }, + "parameters": { + "type": "object", + "description": "It provides a map of parameter name and value for portal extension blade to produce lik for given service health event." + } + } + }, + "faq": { + "description": "Frequently asked question for the service health event", + "properties": { + "question": { + "type": "string", + "description": "FAQ question for the service health event." + }, + "answer": { + "type": "string", + "description": "FAQ answer for the service health event." + }, + "localeCode": { + "type": "string", + "description": "FAQ locale for the service health event." + } + } + }, + "impact": { + "description": "Azure service impacted by the service health event.", + "properties": { + "impactedService": { + "type": "string", + "description": "Impacted service name." + }, + "impactedRegions": { + "type": "array", + "description": "List regions impacted by the service health event.", + "items": { + "$ref": "#/definitions/impactedServiceRegion" + } + } + } + }, + "impactedServiceRegion": { + "description": "Azure region impacted by the service health event.", + "properties": { + "impactedRegion": { + "type": "string", + "description": "Impacted region name." + }, + "status": { + "type": "string", + "description": "Current status of event in the region.", + "enum": [ + "Active", + "Resolved" + ], + "x-ms-enum": { + "name": "EventStatusValues", + "modelAsString": true + } + }, + "impactedSubscriptions": { + "type": "array", + "description": "List subscription impacted by the service health event.", + "items": { + "type": "string", + "description": "Subscription impacted by the service health event." + } + }, + "lastUpdateTime": { + "type": "string", + "description": "It provides the Timestamp for when the last update for the service health event.", + "format": "date-time" + }, + "updates": { + "type": "array", + "description": "List of updates for given servie health event.", + "items": { + "$ref": "#/definitions/update" + } + } + } + }, + "update": { + "description": "Update for service health event.", + "properties": { + "summary": { + "type": "string", + "description": "Summary text for the given update for the service health event." + }, + "updateDateTime": { + "type": "string", + "description": "It provides the Timestamp for the given update for the service health event.", + "format": "date-time" + } + } + }, + "impactedResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/impactedResourceStatus" + }, + "description": "The list of impactedResourceStatus." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of impactedResourceStatus." + } + }, + "required": [ + "value" + ], + "description": "The List impactedResourceStatus operation response." + }, + "impactedResourceStatus": { + "type": "object", + "description": "impactedResource with health status", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "Properties of impacted resource status.", + "properties": { + "availabilityState": { + "type": "string", + "description": "Impacted resource status of the resource.", + "enum": [ + "Available", + "Unavailable", + "Degraded", + "Unknown" + ], + "x-ms-enum": { + "name": "AvailabilityStateValues", + "modelAsString": true + } + }, + "title": { + "type": "string", + "description": "Title description of the impacted resource status." + }, + "summary": { + "type": "string", + "description": "Summary description of the impacted resource status." + }, + "reasonType": { + "type": "string", + "description": "When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated.", + "enum": [ + "Unplanned", + "Planned", + "UserInitiated" + ], + "x-ms-enum": { + "name": "ReasonTypeValues", + "modelAsString": true + } + }, + "occuredTime": { + "type": "string", + "description": "Timestamp for when last change in health status occurred.", + "format": "date-time" + } + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ] + }, + "availabilityStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/availabilityStatus" + }, + "description": "The list of availabilityStatuses." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of availabilityStatuses. Call ListNext() with this URI to fetch the next page of availabilityStatuses." + } + }, + "required": [ + "value" + ], + "description": "The List availabilityStatus operation response." + }, + "availabilityStatus": { + "type": "object", + "description": "availabilityStatus of a resource.", + "properties": { + "id": { + "type": "string", + "description": "Azure Resource Manager Identity for the availabilityStatuses resource." + }, + "name": { + "type": "string", + "description": "current." + }, + "type": { + "type": "string", + "description": "Microsoft.ResourceHealth/AvailabilityStatuses." + }, + "location": { + "type": "string", + "description": "Azure Resource Manager geo location of the resource." + }, + "properties": { + "type": "object", + "description": "Properties of availability state.", + "properties": { + "availabilityState": { + "type": "string", + "description": "Availability status of the resource. When it is null, this availabilityStatus object represents an availability impacting event", + "enum": [ + "Available", + "Unavailable", + "Degraded", + "Unknown" + ], + "x-ms-enum": { + "name": "AvailabilityStateValues", + "modelAsString": true + } + }, + "summary": { + "type": "string", + "description": "Summary description of the availability status." + }, + "detailedStatus": { + "type": "string", + "description": "Details of the availability status." + }, + "reasonType": { + "type": "string", + "description": "When the resource's availabilityState is Unavailable, it describes where the health impacting event was originated. Examples are planned, unplanned, user initiated or an outage etc." + }, + "rootCauseAttributionTime": { + "type": "string", + "description": "When the resource's availabilityState is Unavailable, it provides the Timestamp for when the health impacting event was received.", + "format": "date-time" + }, + "healthEventType": { + "type": "string", + "description": "In case of an availability impacting event, it describes when the health impacting event was originated. Examples are Lifecycle, Downtime, Fault Analysis etc." + }, + "healthEventCause": { + "type": "string", + "description": "In case of an availability impacting event, it describes where the health impacting event was originated. Examples are PlatformInitiated, UserInitiated etc." + }, + "healthEventCategory": { + "type": "string", + "description": "In case of an availability impacting event, it describes the category of a PlatformInitiated health impacting event. Examples are Planned, Unplanned etc." + }, + "healthEventId": { + "type": "string", + "description": "It is a unique Id that identifies the event" + }, + "resolutionETA": { + "type": "string", + "description": "When the resource's availabilityState is Unavailable and the reasonType is not User Initiated, it provides the date and time for when the issue is expected to be resolved.", + "format": "date-time" + }, + "occuredTime": { + "type": "string", + "description": "Timestamp for when last change in health status occurred.", + "format": "date-time" + }, + "reasonChronicity": { + "type": "string", + "description": "Chronicity of the availability transition.", + "enum": [ + "Transient", + "Persistent" + ], + "x-ms-enum": { + "name": "reasonChronicityTypes", + "modelAsString": true + } + }, + "reportedTime": { + "type": "string", + "description": "Timestamp for when the health was last checked. ", + "format": "date-time" + }, + "recentlyResolved": { + "type": "object", + "description": "An annotation describing a change in the availabilityState to Available from Unavailable with a reasonType of type Unplanned", + "properties": { + "unavailableOccurredTime": { + "type": "string", + "description": "Timestamp for when the availabilityState changed to Unavailable", + "format": "date-time" + }, + "resolvedTime": { + "type": "string", + "description": "Timestamp when the availabilityState changes to Available.", + "format": "date-time" + }, + "unavailabilitySummary": { + "type": "string", + "description": "Brief description of cause of the resource becoming unavailable." + } + } + }, + "recommendedActions": { + "type": "array", + "description": "Lists actions the user can take based on the current availabilityState of the resource.", + "items": { + "$ref": "#/definitions/recommendedAction" + } + }, + "serviceImpactingEvents": { + "type": "array", + "description": "Lists the service impacting events that may be affecting the health of the resource.", + "items": { + "$ref": "#/definitions/serviceImpactingEvent" + } + } + } + } + } + }, + "recommendedAction": { + "description": "Lists actions the user can take based on the current availabilityState of the resource.", + "properties": { + "action": { + "type": "string", + "description": "Recommended action." + }, + "actionUrl": { + "type": "string", + "description": "Link to the action" + }, + "actionUrlText": { + "type": "string", + "description": "Substring of action, it describes which text should host the action url." + } + } + }, + "serviceImpactingEvent": { + "description": "Lists the service impacting events that may be affecting the health of the resource.", + "properties": { + "eventStartTime": { + "type": "string", + "description": "Timestamp for when the event started.", + "format": "date-time" + }, + "eventStatusLastModifiedTime": { + "type": "string", + "description": "Timestamp for when event was submitted/detected.", + "format": "date-time" + }, + "correlationId": { + "type": "string", + "description": "Correlation id for the event" + }, + "status": { + "type": "object", + "description": "Status of the service impacting event.", + "properties": { + "value": { + "type": "string", + "description": "Current status of the event" + } + } + }, + "incidentProperties": { + "type": "object", + "description": "Properties of the service impacting event.", + "properties": { + "title": { + "type": "string", + "description": "Title of the incident." + }, + "service": { + "type": "string", + "description": "Service impacted by the event." + }, + "region": { + "type": "string", + "description": "Region impacted by the event." + }, + "incidentType": { + "type": "string", + "description": "Type of Event." + } + } + } + } + }, + "operationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/operation" + }, + "description": "List of operations available in the resourcehealth resource provider." + } + }, + "required": [ + "value" + ], + "description": "Lists the operations response." + }, + "operation": { + "description": "Operation available in the resourcehealth resource provider.", + "properties": { + "name": { + "type": "string", + "description": "Name of the operation." + }, + "display": { + "type": "object", + "description": "Properties of the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Provider name." + }, + "resource": { + "type": "string", + "description": "Resource name." + }, + "operation": { + "type": "string", + "description": "Operation name." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + } + }, + "ErrorResponse": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For more information please see https://docs.microsoft.com/en-us/rest/api/apimanagement/apis?redirectedfrom=MSDN", + "x-ms-parameter-location": "method" + }, + "ExpandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Setting $expand=recommendedactions in url query expands the recommendedactions in the response.", + "x-ms-parameter-location": "method" + }, + "EventIdParameter": { + "name": "eventId", + "in": "path", + "required": true, + "type": "string", + "description": "EventId for the Service health event" + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatus_GetByResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatus_GetByResource.json new file mode 100644 index 000000000000..6433edfd92ba --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatus_GetByResource.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "resourceUri":"resourceUri", + "api-version": "2015-01-01", + "$expand": "recommendedactions" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.ClassicCompute/virtualMachines /rhctestenvV1PI/providers/Microsoft.ResourceHealth/availabilityStatuses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "eastus", + "properties": { + "availabilityState": "Unavailable", + "summary": "We're sorry, we couldn't automatically recover your virtual machine", + "reasonType": "Unplanned", + "reasonChronicity": "Persistent", + "detailedStatus": "Disk problems are preventing us from automatically recovering your virtual machine", + "occuredTime": "2016-03-29T09:12:00Z", + "reportedTime": "2016-05-04T14:11:29.7598931Z", + "rootCauseAttributionTime": "2016-03-29T09:13:00Z", + "resolutionETA": "2016-03-29T09:37:00Z", + "recommendedActions": [{ + "action": "To start this virtual machine, open the resource blade and click Start", + "actionUrl": "<#ResourceBlade>", + "actionUrlText": "resource blade" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contact support" + }] + } + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListByResourceGroup.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListByResourceGroup.json new file mode 100644 index 000000000000..e32ebc96da73 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListByResourceGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "resourceGroupName": "resourceGroupName", + "api-version": "2015-01-01", + "$expand": "recommendedactions" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "eastus", + "properties": { + "availabilityState": "Available", + "summary": "Vm is available", + "reasonType": "Unplanned", + "reasonChronicity": "Persistent", + "detailedStatus": "We have not seen any issues with your virtual machine", + "occuredTime": "2016-03-29T09:12:00Z", + "reportedTime": "2016-05-04T14:11:29.7598931Z", + "recentlyResolved": { + "unavailableOccurredTime": "2017-02-28T00:48:00Z", + "resolvedTime": "2017-02-28T00:49:00Z", + "unavailabilitySummary": "We are sorry your SQL database is unavailable" + }, + "recommendedActions": [{ + "action": "To start this virtualmachine, open the resource blade and click Start", + "actionUrl": "<#ResourceBlade>", + "actionUrlText": "resourceblade" + }] + } + }, + { + "id": "/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "eastus", + "properties": { + "availabilityState": "Unavailable", + "summary": "We are sorry, we couldn't automatically recovery our virtualmachine", + "reasonType": "Unplanned", + "reasonChronicity": "Persistent", + "detailedStatus": "Diskproblemsarepreventingusfromautomaticallyrecoveringyourvirtualmachine", + "occuredTime": "2016-03-29T09:12:00Z", + "reportedTime": "2016-05-04T14:11:29.7598931Z", + "rootCauseAttributionTime": "2016-03-29T09:13:00Z", + "resolutionETA": "2016-03-29T09:37:00Z", + "recommendedActions": [{ + "action": "To start this virtualmachine, open the resource blade", + "actionUrl": "<#ResourceBlade>", + "actionUrlText": "resourceblade" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contactsupport" + }] + } + }], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListBySubscriptionId.json new file mode 100644 index 000000000000..84e383593cbc --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_ListBySubscriptionId.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "api-version": "2015-01-01", + "$expand": "recommendedactions" + }, + "responses": { + "200": { + "body": { + "value": [{ + "id": "/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "eastus", + "properties": { + "availabilityState": "Available", + "summary": "Vm is available", + "reasonType": "Unplanned", + "reasonChronicity": "Persistent", + "detailedStatus": "We have not seen any issues with your virtual machine", + "occuredTime": "2016-03-29T09:12:00Z", + "reportedTime": "2016-05-04T14:11:29.7598931Z", + "recentlyResolved": { + "unavailableOccurredTime": "2017-02-28T00:48:00Z", + "resolvedTime": "2017-02-28T00:49:00Z", + "unavailabilitySummary": "We are sorry your SQL database is unavailable" + }, + "recommendedActions": [{ + "action": "To start this virtualmachine, open the resource blade and click Start", + "actionUrl": "<#ResourceBlade>", + "actionUrlText": "resourceblade" + }] + } + }, + { + "id": "/providers/Microsoft.ResourceHealth/AvailabilityStatueses/current", + "name": "current", + "type": "Microsoft.ResourceHealth/AvailabilityStatuses", + "location": "eastus", + "properties": { + "availabilityState": "Unavailable", + "summary": "We are sorry, we couldn't automatically recovery our virtualmachine", + "reasonType": "Unplanned", + "reasonChronicity": "Persistent", + "detailedStatus": "Diskproblemsarepreventingusfromautomaticallyrecoveringyourvirtualmachine", + "occuredTime": "2016-03-29T09:12:00Z", + "reportedTime": "2016-05-04T14:11:29.7598931Z", + "rootCauseAttributionTime": "2016-03-29T09:13:00Z", + "resolutionETA": "2016-03-29T09:37:00Z", + "recommendedActions": [{ + "action": "To start this virtualmachine, open the resource blade", + "actionUrl": "<#ResourceBlade>", + "actionUrlText": "resourceblade" + }, + { + "action": "If you are experiencing problems you believe are caused by Azure, contact support", + "actionUrl": "<#SupportCase>", + "actionUrlText": "contactsupport" + }] + } + }], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json new file mode 100644 index 000000000000..e601092b4695 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json @@ -0,0 +1,58 @@ +{ + "parameters":{ + "resourceUri":"resourceUri", + "api-version":"2015-01-01" + }, + "responses":{ + "200":{ + "body":{ + "value":[ + { + "id":"/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.ClassicCompute/virtualMachines/rhctes tenvV1PI/providers/Microsoft.ResourceHealth/availabilityStatuses/current", + "name":"current", + "type":"Microsoft.ResourceHealth/AvailabilityStatuses", + "location":"eastus", + "properties":{ + "availabilityState":"Unavailable", + "summary":"We're sorry, we couldn't automatically recover your virtual machine", + "reasonType":"Unplanned", + "reasonChronicity":"Persistent", + "detailedStatus":"Disk problems are preventing us from automatically recovering your virtual machine", + "occuredTime":"2016-03-29T09:12:00Z", + "reportedTime":"2016-05-04T14:11:29.7598931Z", + "rootCauseAttributionTime":"2016-03-29T09:13:00Z", + "resolutionETA":"2016-03-29T09:37:00Z", + "serviceImpactingEvents": [{ + "eventStartTime":"2016-05-02T19:23:13.7115125Z", + "eventStatusLastModifiedTime":"2016-05-02T19:27:04.9543491Z", + "correlationId":"b56d0180-2d6c-4f7b-b750-c1eca681874c", + "status":{ + "value":"Resolved" + }, + "incidentProperties":{ + "title":"Virtual Machines - West Europe [West Europe]", + "service":"Virtual Machines", + "region":"East US", + "incidentType":"outage" + } + }] + } + }, + { + "id":"/subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.ClassicCompute/virtualMachines/rhctes tenvV1PI/providers/Microsoft.ResourceHealth/availabilityStatuses/2016-03-28+16%3a23%3a00Z", + "name":"2016-03-28+16%3a23%3a00Z", + "type":"Microsoft.ResourceHealth/AvailabilityStatuses", + "location":"eastus", + "properties":{ + "availabilityState":"Available", + "summary":"This virtual machine is running normally", + "reasonChronicity":"Persistent", + "detailedStatus":"There aren’t any known Azure platform problems affecting this virtual machine", + "occuredTime":"2016-03-28T16:23:00Z" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json new file mode 100644 index 000000000000..39b04f525301 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySingleResource.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "resourceUri": "subscriptions/4abcdefgh-ijkl-mnop-qrstuvwxyz/resourceGroups/rhctestenv/providers/Microsoft.Compute/virtualMachines/rhctestenvV1PI", + "api-version": "2018-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", + "name": "BC_1-FXZ", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "BC_1-FXZ", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "BC_1-FXZ" + } + } + ], + "level": "Warning", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [ + "{subscriptionId}" + ], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "groupId": 2343, + "title": "Recommended actions title", + "actions": [ + "action 1", + "action 2" + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ] + } + } + ], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json new file mode 100644 index 000000000000..1576d5ba2b77 --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Events_ListBySubscriptionId.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "api-version": "2018-07-01-preview", + "$filter": "service eq 'Virtual Machines' or region eq 'West US'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.ResourceHealth/events/BC_1-FXZ", + "name": "BC_1-FXZ", + "type": "/providers/Microsoft.ResourceHealth/events", + "properties": { + "eventType": "ServiceIssue", + "eventSource": "ResourceHealth", + "status": "Active", + "title": "ACTIVE: Virtual machines in West US", + "summary": "An outage alert is being investigated. More information will be provided as it is known.", + "header": "Your service might have been impacted by an Azure service issue", + "article": { + "articleContent": "An outage alert is being investigated. More information will be provided as it is known" + }, + "links": [ + { + "type": "Hyperlink", + "displayText": { + "value": "Request RCA", + "localizedValue": "Request RCA" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "RequestRCABlade", + "parameters": { + "trackingId": "BC_1-FXZ", + "rcaRequested": "False" + } + }, + { + "type": "Button", + "displayText": { + "value": "Sign up for updates", + "localizedValue": "Sign up for updates" + }, + "extensionName": "Microsoft_Azure_Health", + "bladeName": "AzureHealthBrowseBlade", + "parameters": { + "trackingId": "BC_1-FXZ" + } + } + ], + "level": "Warning", + "impactStartTime": "2018-11-07T00:00:00Z", + "impactMitigationTime": "2018-11-08T00:00:00Z", + "impact": [ + { + "impactedService": "Virtual Machines", + "impactedRegions": [ + { + "impactedRegion": "West US", + "status": "Active", + "impactedSubscriptions": [ + "{subscriptionId}" + ], + "lastUpdateTime": "2017-12-05T21:05:00Z" + } + ] + } + ], + "recommendedActions": { + "groupId": 2343, + "title": "Recommended actions title", + "actions": [ + "action 1", + "action 2" + ], + "localeCode": "en" + }, + "faqs": [ + { + "question": "This is a question", + "answer": "This is an answer", + "localeCode": "en" + } + ] + } + } + ], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} \ No newline at end of file diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/ImpactedResources_ListBySubscriptionId.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/ImpactedResources_ListBySubscriptionId.json new file mode 100644 index 000000000000..5470e0ae291c --- /dev/null +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/ImpactedResources_ListBySubscriptionId.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subscriptionId", + "api-version": "2018-07-01-preview", + "$filter": "service eq 'Virtual Machines' or region eq 'West US'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.ResourceHealth/impactedResources/current", + "name": "current", + "type": "Microsoft.ResourceHealth/impactedResources", + "properties": { + "availabilityState": "Available", + "summary": "Vm is available", + "reasonType": "Unplanned", + "occuredTime": "2016-03-29T09:12:00Z" + } + }, + { + "id": "/providers/Microsoft.ResourceHealth/impactedResources/current", + "name": "current", + "type": "Microsoft.ResourceHealth/impactedResources", + "properties": { + "availabilityState": "Unavailable", + "summary": "We are sorry, we couldn't automatically recovery our virtualmachine", + "reasonType": "Unplanned", + "occuredTime": "2016-03-29T09:12:00Z" + } + } + ], + "nextLink": "{originalRequestUrl}?$skipToken={OpaquePageNumber}" + } + } + } +} \ No newline at end of file From 7d6b1394624c762f9959e996ff133a4561fcf668 Mon Sep 17 00:00:00 2001 From: Dongjiang You Date: Wed, 12 Dec 2018 11:15:48 -0800 Subject: [PATCH 398/464] [ACR] Add IP rules (#4895) * Add IP rules * Remove chart actions * Add x-ms-client-name --- .../stable/2017-10-01/containerregistry.json | 50 ++++++++++++++++++- 1 file changed, 48 insertions(+), 2 deletions(-) diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json index 17f43a114a38..6fc6063e3741 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json @@ -1565,19 +1565,65 @@ "items": { "$ref": "#/definitions/VirtualNetworkRule" } + }, + "ipRules": { + "description": "The IP ACL rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IPRule" + } } } }, "VirtualNetworkRule": { - "description": "The virtual network rule for a container registry.", + "description": "Virtual network rule.", "required": [ "id" ], "type": "object", "properties": { + "action": { + "description": "The action of virtual network rule.", + "default": "Allow", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "Action", + "modelAsString": true + } + }, "id": { "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}.", - "type": "string" + "type": "string", + "x-ms-client-name": "VirtualNetworkResourceId" + } + } + }, + "IPRule": { + "description": "IP rule with specific IP or IP range in CIDR format.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "action": { + "description": "The action of IP ACL rule.", + "default": "Allow", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "Action", + "modelAsString": true + } + }, + "value": { + "description": "Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed.", + "type": "string", + "x-ms-client-name": "IPAddressOrRange" } } }, From 642e9ebad08073effe311dd4b88d1276af02aaaa Mon Sep 17 00:00:00 2001 From: Anu Thomas Chandy Date: Wed, 12 Dec 2018 13:20:57 -0800 Subject: [PATCH 399/464] (aadhybridhealthservice java) Using plural for operation group name (#4893) --- .../adhybridhealthservice/resource-manager/readme.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/adhybridhealthservice/resource-manager/readme.md b/specification/adhybridhealthservice/resource-manager/readme.md index bf70e561423e..3a4a6b7f437b 100644 --- a/specification/adhybridhealthservice/resource-manager/readme.md +++ b/specification/adhybridhealthservice/resource-manager/readme.md @@ -102,4 +102,11 @@ namespace: com.microsoft.azure.management.adhybridhealthservice license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-adhybridhealthservice +directive: + - rename-operation: + from: addsService_getMetrics + to: addsServices_getMetrics + - rename-operation: + from: service_getMetrics + to: services_getMetrics ``` From bd5e618b33f6da17054e8cae853a9280e53ba5d3 Mon Sep 17 00:00:00 2001 From: Viv Lingaiah Date: Wed, 12 Dec 2018 15:35:26 -0800 Subject: [PATCH 400/464] [Don't merge, waiting for deployment] [GuestConfiguration] GA/stable version specs (#4428) [GuestConfiguration] GA/stable version specs --- ...eOrUpdateGuestConfigurationAssignment.json | 25 + .../deleteGuestConfigurationAssignment.json | 3 +- ...uestConfigurationAssignmentReportById.json | 4 +- ...llGuestConfigurationAssignmentReports.json | 8 +- .../examples/listOperations.json | 65 +- .../guestconfiguration.json | 77 +- .../guestconfiguration_NotImplemented.json | 90 -- ...eOrUpdateGuestConfigurationAssignment.json | 104 +++ .../deleteGuestConfigurationAssignment.json | 12 + .../getGuestConfigurationAssignment.json | 36 + ...uestConfigurationAssignmentReportById.json | 82 ++ ...llGuestConfigurationAssignmentReports.json | 57 ++ .../listGuestConfigurationAssignments.json | 59 ++ .../2018-11-20/examples/listOperations.json | 44 + .../stable/2018-11-20/guestconfiguration.json | 859 ++++++++++++++++++ .../resource-manager/readme.md | 52 +- 16 files changed, 1445 insertions(+), 132 deletions(-) delete mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration_NotImplemented.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listOperations.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/createOrUpdateGuestConfigurationAssignment.json index 78106a60a287..811541fb7038 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/createOrUpdateGuestConfigurationAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/createOrUpdateGuestConfigurationAssignment.json @@ -42,6 +42,31 @@ "provisioningState": "Succeeded" } } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": null, + "name": "multiconfigassignment2", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy A", + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": null, + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } } } } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/deleteGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/deleteGuestConfigurationAssignment.json index cf769c46fe5b..e60a966fc1d5 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/deleteGuestConfigurationAssignment.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/deleteGuestConfigurationAssignment.json @@ -7,7 +7,6 @@ "api-version": "2018-06-30-preview" }, "responses": { - "200": {}, - "204": {} + "200": {} } } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getGuestConfigurationAssignmentReportById.json index 0c3047e78fe8..1f179465600b 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getGuestConfigurationAssignmentReportById.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/getGuestConfigurationAssignmentReportById.json @@ -72,7 +72,9 @@ } }], "operationType": "Consistency" - } + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" } } } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listAllGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listAllGuestConfigurationAssignmentReports.json index 4213e34b8cd0..5c358e23f167 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listAllGuestConfigurationAssignmentReports.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listAllGuestConfigurationAssignmentReports.json @@ -72,7 +72,9 @@ } }], "operationType": "Consistency" - } + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" } }, { "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", @@ -136,7 +138,9 @@ } }], "operationType": "Consistency" - } + }, + "startTime": "2018-08-29T21:58:54Z", + "endTime": "2018-08-29T21:59:13Z" } }] } diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listOperations.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listOperations.json index 39d9feb85df6..090f99e37789 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listOperations.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/examples/listOperations.json @@ -1,33 +1,44 @@ { "parameters": { - "api-version": "2018-06-30-preview" + "api-version": "2018-06-30-preview" }, "responses": { - "200": { - "headers": {}, - "body": { - "value": [ - { - "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", - "display": { - "provider": "Microsoft Guest Configuration", - "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", - "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", - "description": "Create new guest configuration assignment." - }, - "properties": null - }, - { - "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", - "display": { - "provider": "Microsoft Guest Configuration", - "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", - "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", - "description": "Get guest configuration assignment." - }, - "properties": null - }] + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "description": "Create new guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "description": "Get guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "description": "Get guest configuration assignment report." + }, + "properties": null + } + ] + } } - } } - } \ No newline at end of file +} \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json index c64c31464d6b..9f0357aa462f 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json @@ -76,6 +76,12 @@ "$ref": "#/definitions/GuestConfigurationAssignment" } }, + "200": { + "description": "OK. The guest configuration assignment for the VM was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -143,6 +149,57 @@ "consumes": [ "application/json" ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { @@ -537,6 +594,7 @@ "lastComplianceStatusChecked": { "type": "string", "readOnly": true, + "format":"date-time", "description": "Date and time when last compliance status was checked.", "x-nullable": true }, @@ -566,7 +624,10 @@ "modelAsString": true }, "enum": [ - "Succeeded" + "Succeeded", + "Failed", + "Canceled", + "Created" ] } }, @@ -632,6 +693,18 @@ "$ref": "#/definitions/VMInfo", "description": "Information about the VM." }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, "details": { "$ref": "#/definitions/AssignmentReportDetails", "description": "Details of the assignment report." @@ -697,11 +770,13 @@ "startTime": { "type": "string", "readOnly": true, + "format": "date-time", "description": "Start date and time of the guest configuration assignment compliance status check." }, "endTime": { "type": "string", "readOnly": true, + "format": "date-time", "description": "End date and time of the guest configuration assignment compliance status check." }, "jobId": { diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration_NotImplemented.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration_NotImplemented.json deleted file mode 100644 index 6c8bd051e7dd..000000000000 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration_NotImplemented.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2018-06-30-preview", - "title": "GuestConfiguration" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { - "delete": { - "tags": [ - "GuestConfigurationAssignments" - ], - "operationId": "GuestConfigurationAssignments_Delete", - "description": "Delete a guest configuration assignment", - "x-ms-examples": { - "Delete an guest configuration assignment": { - "$ref": "./examples/deleteGuestConfigurationAssignment.json" - } - }, - "parameters": [ - { - "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" - }, - { - "name": "guestConfigurationAssignmentName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the guest configuration assignment" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" - }, - { - "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK" - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "produces": [ - "application/json" - ], - "consumes": [ - "application/json" - ] - } - } - }, - "definitions": {}, - "parameters": {} - } - \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json new file mode 100644 index 000000000000..dd6ceca7ed61 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationAssignment.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "WhitelistedApplication", + "api-version": "2018-11-20", + "parameters": { + "location": "westcentralus", + "name": "WhitelistedApplication", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "WhitelistedApplication", + "version": "1.*", + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": null, + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": null, + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationAssignment.json new file mode 100644 index 000000000000..5fbba52d76db --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": {} + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignment.json new file mode 100644 index 000000000000..8518a3561500 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..a9370cb77451 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationAssignmentReportById.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [{ + "complianceStatus": "Compliant", + "reasons": [{ + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + }], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [{ + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + }], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + }], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..36fa550c640a --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationAssignmentReports.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body":{ + "value": [{ + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + }] + } + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationAssignments.json new file mode 100644 index 000000000000..698d88956c75 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } + } \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listOperations.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listOperations.json new file mode 100644 index 000000000000..03bbc5fd74fa --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listOperations.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "description": "Create new guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "description": "Get guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "description": "Get guest configuration assignment report." + }, + "properties": null + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json new file mode 100644 index 000000000000..8435ecc61a8f --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json @@ -0,0 +1,859 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-11-20", + "title": "GuestConfiguration" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_CreateOrUpdate", + "description": "Creates an association between a VM and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VM was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VM was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assingment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_List", + "description": "List all guest configuration assignments for a virtual machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assingment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.GuestConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available GuestConfiguration REST API operations.", + "x-ms-examples": { + "Lists all of the available GuestConfiguration REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "GuestConfigurationAssignmentList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Result of the list guest configuration assignment operation." + } + }, + "description": "The response of the list guest configuration assignment operation." + }, + "GuestConfigurationAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GuestConfigurationAssignmentProperties", + "description": "Properties of the Guest configuration assignment." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Guest configuration assignment is an association between a VM and guest configuration." + }, + "GuestConfigurationNavigation": { + "description": "Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the guest configuration. For example:DSC", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "enum": [ + "DSC" + ] + }, + "name": { + "type": "string", + "description": "Name of the guest configuration." + }, + "version": { + "type": "string", + "description": "Version of the guest configuration." + }, + "contentUri": { + "readOnly": true, + "type": "string", + "description": "Uri of the storage where guest configuration package is uploaded." + }, + "contentHash": { + "readOnly": true, + "type": "string", + "description": "Combined hash of the guest configuration package and configuration parameters." + }, + "configurationParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "description": "The configuration parameters for the guest configuration." + }, + "configurationSetting": { + "$ref": "#/definitions/ConfigurationSetting", + "description": "The configuration setting for the guest configuration." + } + } + }, + "ConfigurationParameter": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration parameter." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Value of the configuration parameter." + } + }, + "description": "Represents a configuration parameter." + }, + "ConfigurationSetting": { + "properties": { + "configurationMode": { + "type": "string", + "readOnly": true, + "description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.", + "x-ms-enum": { + "name": "configurationMode", + "modelAsString": true + }, + "enum": [ + "ApplyOnly", + "ApplyAndMonitor", + "ApplyAndAutoCorrect" + ] + }, + "allowModuleOverwrite": { + "type": "string", + "description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false", + "x-ms-enum": { + "name": "allowModuleOverwrite", + "modelAsString": true + }, + "enum": [ + "True", + "False" + ] + }, + "actionAfterReboot": { + "type": "string", + "readOnly": true, + "description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration", + "x-ms-enum": { + "name": "actionAfterReboot", + "modelAsString": true + }, + "enum": [ + "ContinueConfiguration", + "StopConfiguration" + ] + }, + "refreshFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 30, + "description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30." + }, + "rebootIfNeeded": { + "type": "string", + "readOnly": true, + "default": "False", + "description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.", + "x-ms-enum": { + "name": "rebootIfNeeded", + "modelAsString": true + }, + "enum": [ + "True", + "False" + ] + }, + "configurationModeFrequencyMins": { + "type": "number", + "readOnly": true, + "default": 15, + "description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15." + } + }, + "description": "Configuration setting of LCM (Local Configuration Manager)." + }, + "GuestConfigurationAssignmentProperties": { + "properties": { + "guestConfiguration": { + "$ref": "#/definitions/GuestConfigurationNavigation", + "description": "The guest configuration to assign." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "lastComplianceStatusChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "context": { + "type": "string", + "description": "The source which initiated the guest configuration assignment. Ex: Azure Policy" + }, + "assignmentHash": { + "type": "string", + "readOnly": true, + "description": "Combined hash of the configuration package and parameters.", + "x-nullable": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "x-nullable": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Created" + ] + } + }, + "description": "Guest configuration assignment properties." + }, + "GuestConfigurationAssignmentReportList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + }, + "description": "List of reports for the guest configuration. Report contains information such as compliance status, reason and more." + } + }, + "description": "List of guest configuration assignment reports." + }, + "GuestConfigurationAssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "properties": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportProperties", + "description": "Properties of the guest configuration report." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "GuestConfigurationAssignmentReportProperties": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "details": { + "$ref": "#/definitions/AssignmentReportDetails", + "description": "Details of the assignment report.", + "x-nullable": true + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "AssignmentInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment." + }, + "configuration": { + "$ref": "#/definitions/ConfigurationInfo", + "description": "Information about the configuration." + } + }, + "description": "Information about the guest configuration assignment." + }, + "VMInfo": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "uuid": { + "type": "string", + "readOnly": true, + "description": "UUID(Universally Unique Identifier) of the VM." + } + }, + "description": "Information about the VM." + }, + "ConfigurationInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration." + } + }, + "description": "Information about the configuration." + }, + "AssignmentReportDetails": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "jobId": { + "type": "string", + "readOnly": true, + "description": "GUID of the report." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + }, + "description": "Details of the guest configuration assignment report." + }, + "AssignmentReportResource": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reasons": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResourceComplianceReason" + }, + "description": "Compliance reason and reason code for a resource." + }, + "properties": { + "type": "object", + "readOnly": true, + "description": "Properties of a guest configuation assignment resource." + } + }, + "description": "The guest configuration assignment resource." + }, + "AssignmentReportResourceComplianceReason": { + "properties": { + "phrase": { + "type": "string", + "readOnly": true, + "description": "Reason for the compliance of the guest configuration assignment resource." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Code for the compliance of the guest configuration assignment resource." + } + }, + "description": "Reason and code for the compliance of the guest configuration assignment resource." + } + }, +"parameters": {} +} diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index f6c920d0d5bb..8a005afcc101 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -1,11 +1,13 @@ # Guest Configuration - + > see https://aka.ms/autorest This is the AutoRest configuration file for Guest Configuration. --- -## Getting Started + +## Getting Started + To build the SDK for Guest Configuration, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -13,19 +15,31 @@ To build the SDK for Guest Configuration, simply [Install AutoRest](https://aka. To see additional help and options, run: > `autorest --help` + --- ## Configuration -### Basic Information +### Basic Information + These are the global settings for the Guest Configuration API. ``` yaml title: GuestConfigurationClient description: Guest Configuration Client openapi-type: arm -tag: package-2018-06-30-preview +tag: package-2018-11-20 ``` + +### Tag: package-2018-11-20 + +These settings apply only when `--tag=package-2018-11-20` is specified on the command line. + +``` yaml $(tag) == 'package-2018-11-20' +input-file: + - Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json +``` + ### Tag: package-2018-06-30-preview These settings apply only when `--tag=package-2018-06-30-preview` is specified on the command line. @@ -45,23 +59,44 @@ input-file: - Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json ``` + ## Suppression + ``` yaml directive: - suppress: UniqueResourcePaths from: guestconfiguration.json where: $.paths - reason: Microsoft.GuestConfiguration is a proxy resource provider under Microsoft. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540' - suppress: OperationsAPIImplementation from: guestconfiguration.json where: $.paths - reason: Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implemented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implmented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540' + - suppress: OperationsAPIImplementation + from: guestconfiguration_NotImplemented.json + where: $.paths + reason: |- + - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559 + - suppress: UniqueResourcePaths + from: guestconfiguration_NotImplemented.json + where: $.paths + reason: |- + - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559 + - suppress: TrackedResourceListByImmediateParent + from: guestconfiguration_NotImplemented.json + where: $.definitions + reason: |- + - APIs are approved here https://github.com/Azure/azure-rest-api-specs-pr/pull/540 + - They were suppressed https://github.com/Azure/azure-rest-api-specs-pr/pull/559 ``` + --- -# Code Generation +# Code Generation -## C# +## C# These settings apply only when `--csharp` is specified on the command line. Please also specify `--csharp-sdks-folder=`. @@ -74,4 +109,3 @@ csharp: output-folder: $(csharp-sdks-folder)/GuestConfiguration/Management.GuestConfiguration/Generated clear-output-folder: true ``` - From 23fab54de4277fd6a4320a81e3e61d67737a57a7 Mon Sep 17 00:00:00 2001 From: Mark Young Date: Thu, 13 Dec 2018 12:50:28 +1300 Subject: [PATCH 401/464] [Portal Generated] Review request for Microsoft.Batch to add version 2018-12-01 (#4720) * Adds base for updating Microsoft.Batch from version stable/2017-09-01 to version 2018-12-01 * Updates readme * Updates API version in new specs and examples * Adding Microsoft.Batch 2018-12-01 ResourceManager api API contains: - New resourceFiles structure allowing for resource files from generic URLs (not just Azure Blob Storage) - Rework of /applications API to match ARM formatting specifications - Removal of currentOsVersion, renaming targetOsVersion to osVersion - Removal of osDisk - Adding containerConfiguration to pools - Adding WindowsUserConfiguration to pool user accounts * Adds suppression to readme * add Go SDK codegen --- .../stable/2018-12-01/BatchManagement.json | 4019 +++++++++++++++++ .../examples/ApplicationCreate.json | 32 + .../examples/ApplicationDelete.json | 13 + .../2018-12-01/examples/ApplicationGet.json | 26 + .../2018-12-01/examples/ApplicationList.json | 35 + .../examples/ApplicationPackageActivate.json | 31 + .../examples/ApplicationPackageCreate.json | 28 + .../examples/ApplicationPackageDelete.json | 14 + .../examples/ApplicationPackageGet.json | 28 + .../examples/ApplicationPackageList.json | 35 + .../examples/ApplicationUpdate.json | 34 + .../examples/BatchAccountCreate_BYOS.json | 49 + .../examples/BatchAccountCreate_Default.json | 40 + .../examples/BatchAccountDelete.json | 13 + .../2018-12-01/examples/BatchAccountGet.json | 31 + .../examples/BatchAccountGetKeys.json | 17 + .../2018-12-01/examples/BatchAccountList.json | 33 + .../BatchAccountListByResourceGroup.json | 34 + .../examples/BatchAccountRegenerateKey.json | 20 + ...atchAccountSynchronizeAutoStorageKeys.json | 11 + .../examples/BatchAccountUpdate.json | 38 + .../examples/CertificateCancelDeletion.json | 32 + .../examples/CertificateCreate_Full.json | 39 + .../examples/CertificateCreate_Minimal.json | 36 + .../CertificateCreate_MinimalCer.json | 36 + .../examples/CertificateDelete.json | 19 + .../2018-12-01/examples/CertificateGet.json | 30 + .../CertificateGetWithDeletionError.json | 43 + .../2018-12-01/examples/CertificateList.json | 32 + .../examples/CertificateListWithFilter.json | 38 + .../examples/CertificateUpdate.json | 36 + ...onCheckNameAvailability_AlreadyExists.json | 20 + ...cationCheckNameAvailability_Available.json | 18 + .../examples/LocationGetQuotas.json | 14 + .../examples/PoolCreate_CustomImage.json | 65 + .../examples/PoolCreate_FullExample.json | 259 ++ ...eate_MinimalCloudServiceConfiguration.json | 72 + ...te_MinimalVirtualMachineConfiguration.json | 77 + ...oolCreate_VirtualMachineConfiguration.json | 163 + .../2018-12-01/examples/PoolDelete.json | 19 + .../examples/PoolDisableAutoScale.json | 56 + .../stable/2018-12-01/examples/PoolGet.json | 148 + .../stable/2018-12-01/examples/PoolList.json | 155 + .../examples/PoolListWithFilter.json | 44 + .../2018-12-01/examples/PoolStopResize.json | 62 + .../examples/PoolUpdate_EnableAutoScale.json | 69 + .../examples/PoolUpdate_OtherProperties.json | 115 + .../examples/PoolUpdate_RemoveStartTask.json | 65 + .../examples/PoolUpdate_ResizePool.json | 74 + .../batch/resource-manager/readme.go.md | 10 + .../batch/resource-manager/readme.md | 62 +- 51 files changed, 6463 insertions(+), 26 deletions(-) create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationCreate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageActivate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageCreate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_BYOS.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_Default.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGetKeys.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountListByResourceGroup.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountRegenerateKey.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountSynchronizeAutoStorageKeys.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCancelDeletion.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Full.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Minimal.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_MinimalCer.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGetWithDeletionError.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateListWithFilter.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateUpdate.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_AlreadyExists.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_Available.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationGetQuotas.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_CustomImage.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_FullExample.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_VirtualMachineConfiguration.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDelete.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDisableAutoScale.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolGet.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolList.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolListWithFilter.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolStopResize.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_EnableAutoScale.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_OtherProperties.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_RemoveStartTask.json create mode 100644 specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_ResizePool.json diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json new file mode 100644 index 000000000000..fd25da29dade --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/BatchManagement.json @@ -0,0 +1,4019 @@ +{ + "swagger": "2.0", + "info": { + "title": "BatchManagement", + "version": "2018-12-01", + "x-ms-code-generation-settings": { + "name": "BatchManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}": { + "put": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Create", + "x-ms-examples": { + "BatchAccountCreate_Default": { "$ref": "./examples/BatchAccountCreate_Default.json" }, + "BatchAccountCreate_BYOS": { "$ref": "./examples/BatchAccountCreate_BYOS.json" } + }, + "description": "Creates a new Batch account with the specified parameters. Existing accounts cannot be updated with this API and should instead be updated with the Update Batch Account API.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "minLength": 3, + "maxLength": 24, + "description": "A name for the Batch account which must be unique within the region. Batch account names must be between 3 and 24 characters in length and must use only numbers and lowercase letters. This name is used as part of the DNS name that is used to access the Batch service in the region in which the account is created. For example: http://accountname.region.batch.azure.com/." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountCreateParameters" + }, + "description": "Additional parameters for account creation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Update", + "x-ms-examples": { + "BatchAccountUpdate": { "$ref": "./examples/BatchAccountUpdate.json" } + }, + "description": "Updates the properties of an existing Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountUpdateParameters" + }, + "description": "Additional parameters for account update." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Delete", + "x-ms-examples": { + "BatchAccountDelete": { "$ref": "./examples/BatchAccountDelete.json" } + }, + "description": "Deletes the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that specifies the delay in seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent -- account does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_Get", + "x-ms-examples": { + "BatchAccountGet": { "$ref": "./examples/BatchAccountGet.json" } + }, + "description": "Gets information about the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account entity.", + "schema": { + "$ref": "#/definitions/BatchAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_List", + "x-ms-examples": { + "BatchAccountList": { "$ref": "./examples/BatchAccountList.json" } + }, + "description": "Gets information about the Batch accounts associated with the subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the subscription.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts": { + "get": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_ListByResourceGroup", + "x-ms-examples": { + "BatchAccountListByResourceGroup": { "$ref": "./examples/BatchAccountListByResourceGroup.json" } + }, + "description": "Gets information about the Batch accounts associated with the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of Batch account entities associated with the resource group.", + "schema": { + "$ref": "#/definitions/BatchAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/syncAutoStorageKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_SynchronizeAutoStorageKeys", + "x-ms-examples": { + "BatchAccountSynchronizeAutoStorageKeys": { "$ref": "./examples/BatchAccountSynchronizeAutoStorageKeys.json" } + }, + "description": "Synchronizes access keys for the auto-storage account configured for the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/regenerateKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_RegenerateKey", + "x-ms-examples": { + "BatchAccountRegenerateKey": { "$ref": "./examples/BatchAccountRegenerateKey.json" } + }, + "description": "Regenerates the specified account key for the Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BatchAccountRegenerateKeyParameters" + }, + "description": "The type of key to regenerate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch account keys.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/listKeys": { + "post": { + "tags": [ + "BatchAccount" + ], + "operationId": "BatchAccount_GetKeys", + "x-ms-examples": { + "BatchAccountGetKeys": { "$ref": "./examples/BatchAccountGetKeys.json" } + }, + "summary": "Gets the account keys for the specified Batch account.", + "description": "This operation applies only to Batch accounts created with a poolAllocationMode of 'BatchService'. If the Batch account was created with a poolAllocationMode of 'UserSubscription', clients cannot use access to keys to authenticate, and must use Azure Active Directory instead. In this case, getting the keys will fail.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the keys of the Batch account.", + "schema": { + "$ref": "#/definitions/BatchAccountKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}/activate": { + "post": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Activate", + "x-ms-examples": { + "ApplicationPackageActivate": { "$ref": "./examples/ApplicationPackageActivate.json" } + }, + "description": "Activates the specified application package.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActivateApplicationPackageParameters" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}": { + "put": { + "tags": [ + "Application" + ], + "operationId": "Application_Create", + "x-ms-examples": { + "ApplicationCreate": { "$ref": "./examples/ApplicationCreate.json" } + }, + "description": "Adds an application to the specified Batch account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Application_Delete", + "x-ms-examples": { + "ApplicationDelete": { "$ref": "./examples/ApplicationDelete.json" } + }, + "description": "Deletes an application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_Get", + "x-ms-examples": { + "ApplicationGet": { "$ref": "./examples/ApplicationGet.json" } + }, + "description": "Gets information about the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Application_Update", + "x-ms-examples": { + "ApplicationUpdate": { "$ref": "./examples/ApplicationUpdate.json" } + }, + "description": "Updates settings for the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The parameters for the request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application entity.", + "schema": { + "$ref": "#/definitions/Application" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions/{versionName}": { + "put": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Create", + "x-ms-examples": { + "ApplicationPackageCreate": { "$ref": "./examples/ApplicationPackageCreate.json" } + }, + "description": "Creates an application package record.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The parameters for the request." + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Delete", + "x-ms-examples": { + "ApplicationPackageDelete": { "$ref": "./examples/ApplicationPackageDelete.json" } + }, + "description": "Deletes an application package record and its associated binary file.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_Get", + "x-ms-examples": { + "ApplicationPackageGet": { "$ref": "./examples/ApplicationPackageGet.json" } + }, + "description": "Gets information about the specified application package.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the application package entity.", + "schema": { + "$ref": "#/definitions/ApplicationPackage" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Application_List", + "x-ms-examples": { + "ApplicationList": { "$ref": "./examples/ApplicationList.json" } + }, + "description": "Lists all of the applications in the specified account.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application entities associated with the specified account.", + "schema": { + "$ref": "#/definitions/ListApplicationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}/versions": { + "get": { + "tags": [ + "ApplicationPackage" + ], + "operationId": "ApplicationPackage_List", + "x-ms-examples": { + "ApplicationList": { "$ref": "./examples/ApplicationPackageList.json" } + }, + "description": "Lists all of the application packages in the specified application.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of the application package entities associated with the specified application.", + "schema": { + "$ref": "#/definitions/ListApplicationPackagesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/quotas": { + "get": { + "tags": [ + "Location" + ], + "operationId": "Location_GetQuotas", + "x-ms-examples": { + "LocationGetQuotas": { "$ref": "./examples/LocationGetQuotas.json" } + }, + "description": "Gets the Batch service quotas for the specified subscription at the given location.", + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The region for which to retrieve Batch service quotas." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the Batch service quotas for the subscription in the specified location.", + "schema": { + "$ref": "#/definitions/BatchLocationQuota" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Batch/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists available operations for the Microsoft.Batch provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Batch/locations/{locationName}/checkNameAvailability": { + "post": { + "operationId": "Location_CheckNameAvailability", + "description": "Checks whether the Batch account name is available in the specified region.", + "x-ms-examples": { + "LocationCheckNameAvailability_Available": { "$ref": "./examples/LocationCheckNameAvailability_Available.json" }, + "LocationCheckNameAvailability_AlreadyExists": { "$ref": "./examples/LocationCheckNameAvailability_AlreadyExists.json" } + }, + "parameters": [ + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The desired region for the name check." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Properties needed to check the availability of a name." + } + ], + "responses": { + "200": { + "description": "Success. Returns details about whether a Batch account name is available.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates": { + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_ListByBatchAccount", + "description": "Lists all of the certificates in the specified account.", + "x-ms-examples": { + "ListCertificates": { "$ref": "./examples/CertificateList.json" }, + "ListCertificates - Filter and Select": { "$ref": "./examples/CertificateListWithFilter.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are \"properties/provisioningState\", \"properties/provisioningStateTransitionTime\", \"name\"." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListCertificatesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}": { + "put": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Create", + "description": "Creates a new certificate inside the specified account.", + "x-ms-examples": { + "CreateCertificate - Minimal Pfx": { "$ref": "./examples/CertificateCreate_Minimal.json" }, + "CreateCertificate - Minimal Cer": { "$ref": "./examples/CertificateCreate_MinimalCer.json" }, + "CreateCertificate - Full": { "$ref": "./examples/CertificateCreate_Full.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Additional parameters for certificate creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. A value of \"*\" can be used to apply the operation only if the certificate already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new certificate to be created, but to prevent updating an existing certificate. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Update", + "description": "Updates the properties of an existing certificate.", + "x-ms-examples": { + "UpdateCertificate": { "$ref": "./examples/CertificateUpdate.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateCreateOrUpdateParameters" + }, + "description": "Certificate entity to update." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the certificate to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Delete", + "description": "Deletes the specified certificate.", + "x-ms-examples": { + "CertificateDelete": { "$ref": "./examples/CertificateDelete.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_Get", + "description": "Gets information about the specified certificate.", + "x-ms-examples": { + "Get Certificate": { "$ref": "./examples/CertificateGet.json" }, + "Get Certificate with Deletion Error": { "$ref": "./examples/CertificateGetWithDeletionError.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/certificates/{certificateName}/cancelDelete": { + "post": { + "tags": [ + "Certificate" + ], + "operationId": "Certificate_CancelDeletion", + "summary": "Cancels a failed deletion of a certificate from the specified account.", + "description": "If you try to delete a certificate that is being used by a pool or compute node, the status of the certificate changes to deleteFailed. If you decide that you want to continue using the certificate, you can use this operation to set the status of the certificate back to active. If you intend to delete the certificate, you do not need to run this operation after the deletion failed. You must make sure that the certificate is not being used by any resources, and then you can try again to delete the certificate.", + "x-ms-examples": { + "CertificateCancelDeletion": { "$ref": "./examples/CertificateCancelDeletion.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/CertificateNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the certificate entity.", + "schema": { + "$ref": "#/definitions/Certificate" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools": { + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_ListByBatchAccount", + "description": "Lists all of the pools in the specified account.", + "x-ms-examples": { + "ListPool": { "$ref": "./examples/PoolList.json" }, + "ListPoolWithFilter": { "$ref": "./examples/PoolListWithFilter.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "name": "maxresults", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of items to return in the response." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\". Only top level properties under properties/ are valid for selection." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "OData filter expression. Valid properties for filtering are:\n\n name\n properties/allocationState\n properties/allocationStateTransitionTime\n properties/creationTime\n properties/provisioningState\n properties/provisioningStateTransitionTime\n properties/lastModified\n properties/vmSize\n properties/interNodeCommunication\n properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of certificates associated with the account.", + "schema": { + "$ref": "#/definitions/ListPoolsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}": { + "put": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Create", + "description": "Creates a new pool inside the specified account.", + "x-ms-examples": { + "CreatePool - Minimal CloudServiceConfiguration": { "$ref": "./examples/PoolCreate_MinimalCloudServiceConfiguration.json" }, + "CreatePool - Minimal VirtualMachineConfiguration": { "$ref": "./examples/PoolCreate_MinimalVirtualMachineConfiguration.json" }, + "CreatePool - Full Example": { "$ref": "./examples/PoolCreate_FullExample.json" }, + "CreatePool - Custom Image": { "$ref": "./examples/PoolCreate_CustomImage.json" }, + "CreatePool - Full VirtualMachineConfiguration": { "$ref": "./examples/PoolCreate_VirtualMachineConfiguration.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Additional parameters for pool creation." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. A value of \"*\" can be used to apply the operation only if the pool already exists. If omitted, this operation will always be applied." + }, + { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Set to '*' to allow a new pool to be created, but to prevent updating an existing pool. Other values will be ignored." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Update", + "description": "Updates the properties of an existing pool.", + "x-ms-examples": { + "UpdatePool - Resize Pool": { "$ref": "./examples/PoolUpdate_ResizePool.json" }, + "UpdatePool - Enable Autoscale": { "$ref": "./examples/PoolUpdate_EnableAutoScale.json" }, + "UpdatePool - Remove Start Task": { "$ref": "./examples/PoolUpdate_RemoveStartTask.json" }, + "UpdatePool - Other Properties": { "$ref": "./examples/PoolUpdate_OtherProperties.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + }, + "description": "Pool properties that should be updated. Properties that are supplied will be updated, any property not supplied will be unchanged." + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "The entity state (ETag) version of the pool to update. This value can be omitted or set to \"*\" to apply the operation unconditionally." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Delete", + "description": "Deletes the specified pool.", + "x-ms-examples": { + "DeletePool": { "$ref": "./examples/PoolDelete.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful." + }, + "204": { + "description": "The operation was successful." + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Pool" + ], + "operationId": "Pool_Get", + "description": "Gets information about the specified pool.", + "x-ms-examples": { + "GetPool": { "$ref": "./examples/PoolGet.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/disableAutoScale": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_DisableAutoScale", + "description": "Disables automatic scaling for a pool.", + "x-ms-examples": { + "Disable AutoScale": { "$ref": "./examples/PoolDisableAutoScale.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}/stopResize": { + "post": { + "tags": [ + "Pool" + ], + "operationId": "Pool_StopResize", + "summary": "Stops an ongoing resize operation on the pool.", + "description": "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.", + "x-ms-examples": { + "StopPoolResize": { "$ref": "./examples/PoolStopResize.json" } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AccountNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the pool entity.", + "schema": { + "$ref": "#/definitions/Pool" + }, + "headers": { + "ETag": { + "description": "The ETag HTTP response header. This is an opaque string. You can use it to detect whether the resource has changed between requests. In particular, you can pass the ETag to one of the If-Match or If-None-Match headers.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AutoStorageBaseProperties": { + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to be used for auto-storage account." + } + }, + "required": [ + "storageAccountId" + ], + "description": "The properties related to the auto-storage account." + }, + "BatchAccountUpdateProperties": { + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + } + }, + "description": "The properties of a Batch account." + }, + "BatchAccountCreateProperties": { + "properties": { + "autoStorage": { + "$ref": "#/definitions/AutoStorageBaseProperties", + "description": "The properties related to the auto-storage account." + }, + "poolAllocationMode": { + "title": "The allocation mode to use for creating pools in the Batch account.", + "description": "The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "$ref": "#/definitions/KeyVaultReference", + "description": "A reference to the Azure key vault associated with the Batch account." + } + }, + "description": "The properties of a Batch account." + }, + "BatchAccountCreateParameters": { + "properties": { + "location": { + "type": "string", + "description": "The region in which to create the account." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountCreateProperties", + "description": "The properties of the Batch account." + } + }, + "required": [ + "location" + ], + "description": "Parameters supplied to the Create operation." + }, + "KeyVaultReference": { + "properties": { + "id": { + "type": "string", + "description": "The resource ID of the Azure key vault associated with the Batch account." + }, + "url": { + "type": "string", + "description": "The URL of the Azure key vault associated with the Batch account." + } + }, + "required": [ + "id", + "url" + ], + "description": "Identifies the Azure key vault associated with a Batch account." + }, + "AutoStorageProperties": { + "properties": { + "lastKeySync": { + "type": "string", + "format": "date-time", + "description": "The UTC time at which storage keys were last synchronized with the Batch account." + } + }, + "required": [ + "lastKeySync" + ], + "allOf": [ + { + "$ref": "#/definitions/AutoStorageBaseProperties" + } + ], + "description": "Contains information about the auto-storage account associated with a Batch account." + }, + "BatchAccountProperties": { + "properties": { + "accountEndpoint": { + "type": "string", + "readOnly": true, + "description": "The account endpoint used to interact with the Batch service." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The provisioned state of the resource", + "enum": [ + "Invalid", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Cancelled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The account is in an invalid state." + }, + { + "value": "Creating", + "description": "The account is being created." + }, + { + "value": "Deleting", + "description": "The account is being deleted." + }, + { + "value": "Succeeded", + "description": "The account has been created and is ready for use." + }, + { + "value": "Failed", + "description": "The last operation for the account is failed." + }, + { + "value": "Cancelled", + "description": "The last operation for the account is cancelled." + } + ] + } + }, + "poolAllocationMode": { + "readOnly": true, + "x-nullable": false, + "title": "The allocation mode to use for creating pools in the Batch account.", + "$ref": "#/definitions/PoolAllocationMode" + }, + "keyVaultReference": { + "title": "A reference to the Azure key vault associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/KeyVaultReference" + }, + "autoStorage": { + "title": "The properties and status of any auto-storage account associated with the Batch account.", + "readOnly": true, + "$ref": "#/definitions/AutoStorageProperties" + }, + "dedicatedCoreQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The dedicated core quota for this Batch account." + }, + "lowPriorityCoreQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The low-priority core quota for this Batch account." + }, + "poolQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The pool quota for this Batch account." + }, + "activeJobAndJobScheduleQuota": { + "readOnly": true, + "x-nullable": false, + "type": "integer", + "format": "int32", + "title": "The active job and job schedule quota for this Batch account." + } + }, + "description": "Account specific properties." + }, + "BatchAccount": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountProperties", + "description": "The properties associated with the account." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Contains information about an Azure Batch account." + }, + "BatchAccountUpdateParameters": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The user-specified tags associated with the account." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BatchAccountUpdateProperties", + "description": "The properties of the account." + } + }, + "description": "Parameters for updating an Azure Batch account." + }, + "BatchAccountListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BatchAccount" + }, + "description": "The collection of Batch accounts returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "BatchAccountRegenerateKeyParameters": { + "properties": { + "keyName": { + "type": "string", + "description": "The type of account key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "AccountKeyType", + "modelAsString": false, + "values": [ + { + "value": "Primary", + "description": "The primary account key." + }, + { + "value": "Secondary", + "description": "The secondary account key." + } + ] + } + } + }, + "required": [ + "keyName" + ], + "description": "Parameters supplied to the RegenerateKey operation." + }, + "BatchAccountKeys": { + "properties": { + "accountName": { + "type": "string", + "readOnly": true, + "description": "The Batch account name." + }, + "primary": { + "type": "string", + "readOnly": true, + "description": "The primary key associated with the account." + }, + "secondary": { + "type": "string", + "readOnly": true, + "description": "The secondary key associated with the account." + } + }, + "description": "A set of Azure Batch account keys." + }, + "ActivateApplicationPackageParameters": { + "properties": { + "format": { + "type": "string", + "description": "The format of the application package binary file." + } + }, + "required": [ + "format" + ], + "description": "Parameters for an activating an application package." + }, + "Application": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties associated with the Application." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about an application in a Batch account." + }, + "ApplicationProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The display name for the application." + }, + "allowUpdates": { + "type": "boolean", + "description": "A value indicating whether packages within the application may be overwritten using the same version string." + }, + "defaultVersion": { + "type": "string", + "description": "The package to use if a client requests the application but does not specify a version. This property can only be set to the name of an existing package." + } + }, + "description": "The properties associated with the Application." + }, + "ApplicationPackage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationPackageProperties", + "description": "The properties associated with the Application Package." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "An application package which represents a particular version of an application." + }, + "ApplicationPackageProperties": { + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The current state of the application package.", + "enum": [ + "Pending", + "Active" + ], + "x-ms-enum": { + "name": "PackageState", + "modelAsString": false, + "values": [ + { + "value": "Pending", + "description": "The application package has been created but has not yet been activated." + }, + { + "value": "Active", + "description": "The application package is ready for use." + } + ] + } + }, + "format": { + "type": "string", + "readOnly": true, + "description": "The format of the application package, if the package is active." + }, + "storageUrl": { + "type": "string", + "readOnly": true, + "description": "The URL for the application package in Azure Storage." + }, + "storageUrlExpiry": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The UTC time at which the Azure Storage URL will expire." + }, + "lastActivationTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The time at which the package was last activated, if the package is active." + } + }, + "description": "Properties of an application package" + }, + "ListApplicationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of applications." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list applications." + }, + "ListApplicationPackagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackage" + }, + "description": "The list of application packages." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "The result of performing list application packages." + }, + "BatchLocationQuota": { + "properties": { + "accountQuota": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The number of Batch accounts that may be created under the subscription in the specified region." + } + }, + "description": "Quotas associated with a Batch region for a particular subscription." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "location": { + "readOnly": true, + "type": "string", + "description": "The location of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The tags of the resource." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "ProxyResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "The ETag of the resource, used for concurrency statements." + } + }, + "description": "A definition of an Azure resource.", + "x-ms-azure-resource": true + }, + "PoolAllocationMode": { + "type": "string", + "description": "The allocation mode for creating pools in the Batch account.", + "enum": [ + "BatchService", + "UserSubscription" + ], + "x-ms-enum": { + "name": "PoolAllocationMode", + "modelAsString": false, + "values": [ + { + "value": "BatchService", + "description": "Pools will be allocated in subscriptions owned by the Batch service." + }, + { + "value": "UserSubscription", + "description": "Pools will be allocated in a subscription owned by the user." + } + ] + } + }, + "CertificateBaseProperties": { + "properties": { + "thumbprintAlgorithm": { + "type": "string", + "title": "The algorithm of the certificate thumbprint", + "description": "This must match the first portion of the certificate name. Currently required to be 'SHA1'." + }, + "thumbprint": { + "type": "string", + "title": "The thumbprint of the certificate", + "description": "This must match the thumbprint from the name." + }, + "format": { + "type": "string", + "x-nullable": false, + "description": "The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.", + "enum": [ + "Pfx", + "Cer" + ], + "x-ms-enum": { + "name": "CertificateFormat", + "modelAsString": false, + "values": [ + { + "value": "Pfx", + "description": "The certificate is a PFX (PKCS#12) formatted certificate or certificate chain." + }, + { + "value": "Cer", + "description": "The certificate is a base64-encoded X.509 certificate." + } + ] + } + } + } + }, + "CertificateProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "title": "The provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its current state.", + "readOnly": true + }, + "previousProvisioningState": { + "type": "string", + "readOnly": true, + "x-nullable": false, + "description": "The previous provisioned state of the resource", + "enum": [ + "Succeeded", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "CertificateProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The certificate is available for use in pools." + }, + { + "value": "Deleting", + "description": "The user has requested that the certificate be deleted, but the delete operation has not yet completed. You may not reference the certificate when creating or updating pools." + }, + { + "value": "Failed", + "description": "The user requested that the certificate be deleted, but there are pools that still have references to the certificate, or it is still installed on one or more compute nodes. (The latter can occur if the certificate has been removed from the pool, but the node has not yet restarted. Nodes refresh their certificates only when they restart.) You may use the cancel certificate delete operation to cancel the delete, or the delete certificate operation to retry the delete." + } + ] + } + }, + "previousProvisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the certificate entered its previous state.", + "readOnly": true + }, + "publicData": { + "type": "string", + "readOnly": true, + "description": "The public key of the certificate." + }, + "deleteCertificateError": { + "readOnly": true, + "$ref": "#/definitions/DeleteCertificateError", + "title": "The error which occurred while deleting the certificate", + "description": "This is only returned when the certificate provisioningState is 'Failed'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "description": "Certificate properties." + }, + "CertificateCreateOrUpdateProperties": { + "allOf": [ + { + "$ref": "#/definitions/CertificateBaseProperties" + } + ], + "properties": { + "data": { + "type": "string", + "title": "The base64-encoded contents of the certificate.", + "description": "The maximum size is 10KB." + }, + "password": { + "type": "string", + "title": "The password to access the certificate's private key.", + "description": "This is required if the certificate format is pfx and must be omitted if the certificate format is cer." + } + }, + "description": "Certificate properties for create operations", + "required": [ "data" ] + }, + "Certificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "CertificateCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CertificateCreateOrUpdateProperties", + "description": "The properties associated with the certificate." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a certificate." + }, + "ListCertificatesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Certificate" + }, + "description": "The collection of returned certificates." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "DeleteCertificateError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/DeleteCertificateError" + }, + "description": "A list of additional details about the error." + } + }, + "required": [ "code", "message" ], + "description": "An error response from the Batch service." + }, + "Pool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties", + "description": "The properties associated with the pool." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "description": "Contains information about a pool." + }, + "PoolProperties": { + "properties": { + "displayName": { + "type": "string", + "title": "The display name for the pool.", + "description": "The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "title": "The last modified time of the pool.", + "description": "This is the last time at which the pool level data, such as the targetDedicatedNodes or autoScaleSettings, changed. It does not factor in node-level changes such as a compute node changing state.", + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "title": "The creation time of the pool.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "title": "The current state of the pool.", + "enum": [ + "Succeeded", + "Deleting" + ], + "x-ms-enum": { + "name": "PoolProvisioningState", + "modelAsString": false, + "values": [ + { + "value": "Succeeded", + "description": "The pool is available to run tasks subject to the availability of compute nodes." + }, + { + "value": "Deleting", + "description": "The user has requested that the pool be deleted, but the delete operation has not yet completed." + } + ] + }, + "readOnly": true + }, + "provisioningStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current state.", + "readOnly": true + }, + "allocationState": { + "type": "string", + "title": "Whether the pool is resizing.", + "enum": [ + "Steady", + "Resizing", + "Stopping" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": false, + "values": [ + { + "value": "Steady", + "description": "The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of nodes." + }, + { + "value": "Resizing", + "description": "The pool is resizing; that is, compute nodes are being added to or removed from the pool." + }, + { + "value": "Stopping", + "description": "The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed." + } + ] + }, + "readOnly": true + }, + "allocationStateTransitionTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the pool entered its current allocation state.", + "readOnly": true + }, + "vmSize": { + "type": "string", + "title": "The size of virtual machines in the pool. All VMs in a pool are the same size.", + "description": "For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series)." + }, + "deploymentConfiguration": { + "$ref": "#/definitions/DeploymentConfiguration", + "title": "This property describes how the pool nodes will be deployed - using Cloud Services or Virtual Machines.", + "description": "Using CloudServiceConfiguration specifies that the nodes should be creating using Azure Cloud Services (PaaS), while VirtualMachineConfiguration uses Azure Virtual Machines (IaaS)." + }, + "currentDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The number of compute nodes currently in the pool.", + "readOnly": true + }, + "currentLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The number of low priority compute nodes currently in the pool.", + "readOnly": true + }, + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Settings which configure the number of nodes in the pool." + }, + "autoScaleRun": { + "$ref": "#/definitions/AutoScaleRun", + "title": "The results and errors from the last execution of the autoscale formula.", + "description": "This property is set only if the pool automatically scales, i.e. autoScaleSettings are used.", + "readOnly": true + }, + "interNodeCommunication": { + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InterNodeCommunicationState", + "modelAsString": false, + "values": [ + { + "value": "Enabled", + "description": "Enable network communication between virtual machines." + }, + { + "value": "Disabled", + "description": "Disable network communication between virtual machines." + } + ] + }, + "title": "Whether the pool permits direct communication between nodes.", + "description": "This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can reduce the chance of the requested number of nodes to be allocated in the pool. If not specified, this value defaults to 'Disabled'." + }, + "networkConfiguration": { + "$ref": "#/definitions/NetworkConfiguration", + "title": "The network configuration for the pool." + }, + "maxTasksPerNode": { + "type": "integer", + "format": "int32", + "title": "The maximum number of tasks that can run concurrently on a single compute node in the pool." + }, + "taskSchedulingPolicy": { + "$ref": "#/definitions/TaskSchedulingPolicy", + "title": "How tasks are distributed across compute nodes in a pool." + }, + "userAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/UserAccount" + }, + "title": "The list of user accounts to be created on each node in the pool." + }, + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataItem" + }, + "title": "A list of name-value pairs associated with the pool as metadata.", + "description": "The Batch service does not assign any meaning to metadata; it is solely for the use of user code." + }, + "startTask": { + "$ref": "#/definitions/StartTask", + "title": "A task specified to run on each compute node as it joins the pool.", + "description": "In an PATCH (update) operation, this property can be set to an empty object to remove the start task from the pool." + }, + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/CertificateReference" + }, + "title": "The list of certificates to be installed on each compute node in the pool.", + "description": "For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory." + }, + "applicationPackages": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationPackageReference" + }, + "title": "The list of application packages to be installed on each compute node in the pool.", + "description": "Changes to application packages affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged." + }, + "applicationLicenses": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The list of application licenses the Batch service will make available on each compute node in the pool.", + "description": "The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail." + }, + "resizeOperationStatus": { + "$ref": "#/definitions/ResizeOperationStatus", + "title": "Contains details about the current or last completed resize operation.", + "readOnly": true + } + }, + "description": "Pool properties." + }, + "DeploymentConfiguration": { + "properties": { + "cloudServiceConfiguration": { + "$ref": "#/definitions/CloudServiceConfiguration", + "title": "The cloud service configuration for the pool.", + "description": "This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to 'UserSubscription'." + }, + "virtualMachineConfiguration": { + "$ref": "#/definitions/VirtualMachineConfiguration", + "title": "The virtual machine configuration for the pool.", + "description": "This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Deployment configuration properties." + }, + "ScaleSettings": { + "properties": { + "fixedScale": { + "$ref": "#/definitions/FixedScaleSettings", + "title": "Fixed scale settings for the pool.", + "description": "This property and autoScale are mutually exclusive and one of the properties must be specified." + }, + "autoScale": { + "$ref": "#/definitions/AutoScaleSettings", + "title": "AutoScale settings for the pool.", + "description": "This property and fixedScale are mutually exclusive and one of the properties must be specified." + } + }, + "title": "Scale settings for the pool", + "description": "Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes." + }, + "AutoScaleSettings": { + "properties": { + "formula": { + "type": "string", + "title": "A formula for the desired number of compute nodes in the pool.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/batch/batch-automatic-scaling", + "description": "Create an automatic scaling formula for scaling compute nodes in a Batch pool" + } + }, + "evaluationInterval": { + "type": "string", + "format": "duration", + "title": "The time interval at which to automatically adjust the pool size according to the autoscale formula.", + "description": "If omitted, the default value is 15 minutes (PT15M)." + } + }, + "required": [ "formula" ], + "title": "AutoScale settings for the pool." + }, + "FixedScaleSettings": { + "properties": { + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool.", + "description": "The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriority nodes must be set." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool.", + "description": "At least one of targetDedicatedNodes, targetLowPriority nodes must be set." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "If omitted, the default value is Requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + } + }, + "title": "Fixed scale settings for the pool." + }, + "ComputeNodeDeallocationOption": { + "type": "string", + "title": "Determines what to do with a node and its running task(s) after it has been selected for deallocation.", + "enum": [ + "Requeue", + "Terminate", + "TaskCompletion", + "RetainedData" + ], + "x-ms-enum": { + "name": "ComputeNodeDeallocationOption", + "modelAsString": false, + "values": [ + { + "value": "Requeue", + "description": "Terminate running task processes and requeue the tasks. The tasks will run again when a node is available. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "Terminate", + "description": "Terminate running tasks. The tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove nodes as soon as tasks have been terminated." + }, + { + "value": "TaskCompletion", + "description": "Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes when all tasks have completed." + }, + { + "value": "RetainedData", + "description": "Allow currently running tasks to complete, then wait for all task data retention periods to expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have expired." + } + ] + } + }, + "CertificateReference": { + "properties": { + "id": { + "type": "string", + "title": "The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool." + }, + "storeLocation": { + "type": "string", + "title": "The location of the certificate store on the compute node into which to install the certificate.", + "description": "The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.", + "enum": [ + "CurrentUser", + "LocalMachine" + ], + "x-ms-enum": { + "name": "CertificateStoreLocation", + "modelAsString": false, + "values": [ + { + "value": "CurrentUser", + "description": "Certificates should be installed to the CurrentUser certificate store." + }, + { + "value": "LocalMachine", + "description": "Certificates should be installed to the LocalMachine certificate store." + } + ] + } + }, + "storeName": { + "type": "string", + "title": "The name of the certificate store on the compute node into which to install the certificate.", + "description": "This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My." + }, + "visibility": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false, + "enum": [ + "StartTask", + "Task", + "RemoteUser" + ], + "x-ms-enum": { + "name": "CertificateVisibility", + "modelAsString": false, + "values": [ + { + "value": "StartTask", + "description": "The certificate should be visible to the user account under which the start task is run." + }, + { + "value": "Task", + "description": "The certificate should be visible to the user accounts under which job tasks are run." + }, + { + "value": "RemoteUser", + "description": "The certificate should be visible to the user accounts under which users remotely access the node." + } + ] + } + }, + "title": "Which user accounts on the compute node should have access to the private data of the certificate." + } + }, + "required": [ "id" ], + "title": "A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool." + }, + "ApplicationPackageReference": { + "properties": { + "id": { + "type": "string", + "title": "The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists." + }, + "version": { + "type": "string", + "title": "The version of the application to deploy. If omitted, the default version is deployed.", + "description": "If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409." + } + }, + "title": "Link to an application package inside the batch account", + "required": [ "id" ] + }, + "ResizeError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when resizing a pool.", + "required": [ "code", "message" ] + }, + "AutoScaleRunError": { + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoScaleRunError" + }, + "title": "Additional details about the error." + } + }, + "title": "An error that occurred when autoscaling a pool.", + "required": [ "code", "message" ] + }, + "AutoScaleRun": { + "properties": { + "evaluationTime": { + "type": "string", + "format": "date-time", + "title": "The time at which the autoscale formula was last evaluated." + }, + "results": { + "type": "string", + "title": "The final values of all variables used in the evaluation of the autoscale formula.", + "description": "Each variable value is returned in the form $variable=value, and variables are separated by semicolons." + }, + "error": { + "$ref": "#/definitions/AutoScaleRunError", + "title": "Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful." + } + }, + "required": [ "evaluationTime" ], + "title": "The results and errors from an execution of a pool autoscale formula." + }, + "VirtualMachineConfiguration": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "title": "A reference to the Azure Virtual Machines Marketplace Image or the custom Virtual Machine Image to use." + }, + "nodeAgentSkuId": { + "type": "string", + "title": "The SKU of the Batch node agent to be provisioned on compute nodes in the pool.", + "description": "The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "title": "Windows operating system settings on the virtual machine.", + "description": "This property must not be specified if the imageReference specifies a Linux OS image." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "title": "The configuration for data disks attached to the compute nodes in the pool.", + "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them." + }, + "licenseType": { + "type": "string", + "title": "The type of on-premises license to be used when deploying the operating system.", + "description": "This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are:\n\n Windows_Server - The on-premises license is for Windows Server.\n Windows_Client - The on-premises license is for Windows Client.\n" + }, + "containerConfiguration": { + "$ref": "#/definitions/ContainerConfiguration", + "title": "The container configuration for the pool.", + "description": "If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it." + } + }, + "required": [ "imageReference", "nodeAgentSkuId" ], + "title": "The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure." + }, + "ContainerRegistry": { + "properties": { + "registryServer": { + "type": "string", + "title": "The registry URL.", + "description": "If omitted, the default is \"docker.io\"." + }, + "username": { + "type": "string", + "x-ms-client-name": "userName", + "title": "The user name to log into the registry server." + }, + "password": { + "type": "string", + "title": "The password to log into the registry server." + } + }, + "required": [ "username", "password" ], + "title": "A private container registry." + }, + "ContainerConfiguration": { + "properties": { + "type": { + "type": "string", + "title": "The container technology to be used.", + "enum": [ + "DockerCompatible" + ], + "x-ms-enum": { + "name": "ContainerType", + "modelAsString": false, + "values": [ + { + "value": "DockerCompatible", + "description": "A Docker compatible container technology will be used to launch the containers." + } + ] + } + }, + "containerImageNames": { + "type": "array", + "items": { + "type": "string" + }, + "title": "The collection of container image names.", + "description": "This is the full image reference, as would be specified to \"docker pull\". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry." + }, + "containerRegistries": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerRegistry" + }, + "title": "Additional private registries from which containers can be pulled.", + "description": "If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here." + } + }, + "required": [ "type" ], + "title": "The configuration for container-enabled pools." + }, + "WindowsConfiguration": { + "properties": { + "enableAutomaticUpdates": { + "type": "boolean", + "title": "Whether automatic updates are enabled on the virtual machine.", + "description": "If omitted, the default value is true." + } + }, + "title": "Windows operating system settings to apply to the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "title": "The publisher of the Azure Virtual Machines Marketplace image.", + "description": "For example, Canonical or MicrosoftWindowsServer." + }, + "offer": { + "type": "string", + "title": "The offer type of the Azure Virtual Machines Marketplace image.", + "description": "For example, UbuntuServer or WindowsServer." + }, + "sku": { + "type": "string", + "title": "The SKU of the Azure Virtual Machines Marketplace image.", + "description": "For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "version": { + "type": "string", + "title": "The version of the Azure Virtual Machines Marketplace image.", + "description": "A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "id": { + "type": "string", + "title": "The ARM resource identifier of the virtual machine image. Computes nodes of the pool will be created using this custom image. This is of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/images/{imageName}", + "description": "This property is mutually exclusive with other properties. The virtual machine image must be in the same region and subscription as the Azure Batch account. For information about the firewall settings for Batch node agent to communicate with Batch service see https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration ." + } + }, + "title": "A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "title": "The logical unit number.", + "description": "The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun." + }, + "caching": { + "$ref": "#/definitions/CachingType", + "title": "The type of caching to be enabled for the data disks.", + "description": "Values are:\n\n none - The caching mode for the disk is not enabled.\n readOnly - The caching mode for the disk is read only.\n readWrite - The caching mode for the disk is read and write.\n\n The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "title": "The initial disk size in GB when creating new data disk." + }, + "storageAccountType": { + "title": "The storage account type to be used for the data disk.", + "description": "If omitted, the default is \"Standard_LRS\". Values are:\n\n Standard_LRS - The data disk should use standard locally redundant storage.\n Premium_LRS - The data disk should use premium locally redundant storage.", + "$ref": "#/definitions/StorageAccountType" + } + }, + "required": [ + "lun", + "diskSizeGB" + ], + "description": "Data Disk settings which will be used by the data disks associated to Compute Nodes in the pool." + }, + "TaskSchedulingPolicy": { + "properties": { + "nodeFillType": { + "type": "string", + "title": "How tasks should be distributed across compute nodes.", + "enum": [ + "Spread", + "Pack" + ], + "x-ms-enum": { + "name": "ComputeNodeFillType", + "modelAsString": false, + "values": [ + { + "value": "Spread", + "description": "Tasks should be assigned evenly across all nodes in the pool." + }, + { + "value": "Pack", + "description": "As many tasks as possible (maxTasksPerNode) should be assigned to each node in the pool before any tasks are assigned to the next node in the pool." + } + ] + } + } + }, + "required": [ "nodeFillType" ], + "title": "Specifies how tasks should be distributed across compute nodes." + }, + "LinuxUserConfiguration": { + "properties": { + "uid": { + "type": "integer", + "format": "int32", + "title": "The user ID of the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid." + }, + "gid": { + "type": "integer", + "format": "int32", + "title": "The group ID for the user account.", + "description": "The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid." + }, + "sshPrivateKey": { + "type": "string", + "title": "The SSH private key for the user account.", + "description": "The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done)." + } + }, + "title": "Properties used to create a user account on a Linux node." + }, + "WindowsUserConfiguration": { + "properties": { + "loginMode": { + "type": "string", + "title": "Login mode for user", + "description": "Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.", + "enum": [ + "Batch", + "Interactive" + ], + "x-ms-enum": { + "name": "LoginMode", + "modelAsString": false, + "values": [ + { + "value": "Batch", + "description": "The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running parallel processes." + }, + { + "value": "Interactive", + "description": "The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions associated with the interactive login mode. If this is the case for an application used in your task, then this option is recommended." + } + ] + } + } + }, + "title": "Properties used to create a user account on a Windows node." + }, + "UserAccount": { + "properties": { + "name": { + "type": "string", + "title": "The name of the user account." + }, + "password": { + "type": "string", + "title": "The password for the user account." + }, + "elevationLevel": { + "title": "The elevation level of the user account.", + "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + }, + "linuxUserConfiguration": { + "title": "The Linux-specific user configuration for the user account.", + "description": "This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.", + "$ref": "#/definitions/LinuxUserConfiguration" + }, + "windowsUserConfiguration": { + "title": "The Windows-specific user configuration for the user account.", + "description": "This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options.", + "$ref": "#/definitions/WindowsUserConfiguration" + } + }, + "required": [ "name", "password" ], + "title": "Properties used to create a user on an Azure Batch node." + }, + "StartTask": { + "properties": { + "commandLine": { + "type": "string", + "title": "The command line of the start task.", + "description": "The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using \"cmd /c MyCommand\" in Windows or \"/bin/sh -c MyCommand\" in Linux. Required if any other properties of the startTask are specified." + }, + "resourceFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceFile" + }, + "title": "A list of files that the Batch service will download to the compute node before running the command line." + }, + "environmentSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentSetting" + }, + "title": "A list of environment variable settings for the start task." + }, + "userIdentity": { + "$ref": "#/definitions/UserIdentity", + "title": "The user identity under which the start task runs.", + "description": "If omitted, the task runs as a non-administrative user unique to the task." + }, + "maxTaskRetryCount": { + "type": "integer", + "format": "int32", + "title": "The maximum number of times the task may be retried.", + "description": "The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit." + }, + "waitForSuccess": { + "type": "boolean", + "title": "Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node.", + "description": "If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false." + }, + "containerSettings": { + "$ref": "#/definitions/TaskContainerSettings", + "title": "The settings for the container under which the start task runs.", + "description": "When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container." + } + }, + "title": "A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged." + }, + "TaskContainerSettings": { + "properties": { + "containerRunOptions": { + "type": "string", + "title": "Additional options to the container create command.", + "description": "These additional options are supplied as arguments to the \"docker create\" command, in addition to those controlled by the Batch Service." + }, + "imageName": { + "type": "string", + "title": "The image to use to create the container in which the task will run.", + "description": "This is the full image reference, as would be specified to \"docker pull\". If no tag is provided as part of the image name, the tag \":latest\" is used as a default." + }, + "registry": { + "$ref": "#/definitions/ContainerRegistry", + "title": "The private registry which contains the container image.", + "description": "This setting can be omitted if was already provided at pool creation." + } + }, + "required": [ "imageName" ], + "title": "The container settings for a task." + }, + "ResourceFile": { + "properties": { + "autoStorageContainerName": { + "type": "string", + "title": "The storage container name in the auto storage account.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified." + }, + "storageContainerUrl": { + "type": "string", + "title": "The URL of the blob container within Azure Blob Storage.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "httpUrl": { + "type": "string", + "title": "The URL of the file to download.", + "description": "The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access." + }, + "blobPrefix": { + "type": "string", + "title": "The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded.", + "description": "The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded." + }, + "filePath": { + "type": "string", + "title": "The location on the compute node to which to download the file, relative to the task's working directory.", + "description": "If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..')." + }, + "fileMode": { + "type": "string", + "title": "The file permission mode attribute in octal format.", + "description": "This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file." + } + }, + "title": "A single file or multiple files to be downloaded to a compute node." + }, + "EnvironmentSetting": { + "properties": { + "name": { + "type": "string", + "title": "The name of the environment variable." + }, + "value": { + "type": "string", + "title": "The value of the environment variable." + } + }, + "required": [ "name" ], + "title": "An environment variable to be set on a task process." + }, + "UserIdentity": { + "properties": { + "userName": { + "type": "string", + "title": "The name of the user identity under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + }, + "autoUser": { + "$ref": "#/definitions/AutoUserSpecification", + "title": "The auto user under which the task is run.", + "description": "The userName and autoUser properties are mutually exclusive; you must specify one but not both." + } + }, + "title": "The definition of the user identity under which the task is run.", + "description": "Specify either the userName or autoUser property, but not both." + }, + "AutoUserSpecification": { + "properties": { + "scope": { + "type": "string", + "title": "The scope for the auto user", + "description": "The default value is task.", + "enum": [ + "Task", + "Pool" + ], + "x-ms-enum": { + "name": "AutoUserScope", + "modelAsString": false, + "values": [ + { + "value": "Task", + "description": "Specifies that the service should create a new user for the task." + }, + { + "value": "Pool", + "description": "Specifies that the task runs as the common auto user account which is created on every node in a pool." + } + ] + } + }, + "elevationLevel": { + "title": "The elevation level of the auto user.", + "description": "nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.", + "$ref": "#/definitions/ElevationLevel" + } + }, + "title": "Specifies the parameters for the auto user that runs a task on the Batch service." + }, + "ElevationLevel": { + "type": "string", + "title": "The elevation level of the user.", + "enum": [ + "NonAdmin", + "Admin" + ], + "x-ms-enum": { + "name": "ElevationLevel", + "modelAsString": false, + "values": [ + { + "value": "NonAdmin", + "description": "The user is a standard user without elevated access." + }, + { + "value": "Admin", + "description": "The user is a user with elevated access and operates with full Administrator permissions." + } + ] + } + }, + "StorageAccountType": { + "type": "string", + "title": "The storage account type for use in creating data disks.", + "enum": [ + "Standard_LRS", + "Premium_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "modelAsString": false, + "values": [ + { + "value": "Standard_LRS", + "description": "The data disk should use standard locally redundant storage." + }, + { + "value": "Premium_LRS", + "description": "The data disk should use premium locally redundant storage." + } + ] + } + }, + "CachingType": { + "type": "string", + "title": "The type of caching to enable for the disk.", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "The caching mode for the disk is not enabled." + }, + { + "value": "ReadOnly", + "description": "The caching mode for the disk is read only." + }, + { + "value": "ReadWrite", + "description": "The caching mode for the disk is read and write." + } + ] + } + }, + "NetworkConfiguration": { + "properties": { + "subnetId": { + "type": "string", + "title": "The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.", + "description": "The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication. For pools created with a virtual machine configuration, enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 for Windows. For pools created with a cloud service configuration, enable ports 10100, 20100, and 30100. Also enable outbound connections to Azure Storage on port 443. For more details see: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration", + "externalDocs": { + "url": "https://azure.microsoft.com/en-us/documentation/articles/role-based-access-built-in-roles/#classic-virtual-machine-contributor", + "description": "Setting up RBAC for Azure Batch VNets" + } + }, + "endpointConfiguration": { + "$ref": "#/definitions/PoolEndpointConfiguration", + "title": "The configuration for endpoints on compute nodes in the Batch pool.", + "description": "Pool endpoint configuration is only supported on pools with the virtualMachineConfiguration property." + } + }, + "description": "The network configuration for a pool." + }, + "CloudServiceConfiguration": { + "properties": { + "osFamily": { + "type": "string", + "title": "The Azure Guest OS family to be installed on the virtual machines in the pool.", + "description": "Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases)." + }, + "osVersion": { + "type": "string", + "title": "The Azure Guest OS version to be installed on the virtual machines in the pool.", + "description": "The default value is * which specifies the latest operating system version for the specified OS family." + } + }, + "required": [ "osFamily" ], + "title": "The configuration for nodes in a pool based on the Azure Cloud Services platform." + }, + "MetadataItem": { + "properties": { + "name": { + "type": "string", + "title": "The name of the metadata item." + }, + "value": { + "type": "string", + "title": "The value of the metadata item." + } + }, + "required": [ "name", "value" ], + "title": "A name-value pair associated with a Batch service resource.", + "description": "The Batch service does not assign any meaning to this metadata; it is solely for the use of user code." + }, + "ResizeOperationStatus": { + "properties": { + "targetDedicatedNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of dedicated compute nodes in the pool." + }, + "targetLowPriorityNodes": { + "type": "integer", + "format": "int32", + "title": "The desired number of low-priority compute nodes in the pool." + }, + "resizeTimeout": { + "type": "string", + "format": "duration", + "title": "The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.", + "description": "The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request)." + }, + "nodeDeallocationOption": { + "title": "Determines what to do with a node and its running task(s) if the pool size is decreasing.", + "description": "The default value is requeue.", + "$ref": "#/definitions/ComputeNodeDeallocationOption" + }, + "startTime": { + "type": "string", + "format": "date-time", + "title": "The time when this resize operation was started." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/ResizeError" + }, + "title": "Details of any errors encountered while performing the last resize on the pool.", + "description": "This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady." + } + }, + "title": "Details about the current or last completed resize operation.", + "description": "Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady)." + }, + "PoolEndpointConfiguration": { + "properties": { + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "title": "A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally.", + "description": "The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400." + } + }, + "required": [ "inboundNatPools" ], + "title": "The endpoint configuration for a pool." + }, + "InboundNatPool": { + "properties": { + "name": { + "type": "string", + "title": "The name of the endpoint.", + "description": "The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400." + }, + "protocol": { + "type": "string", + "title": "The protocol of the endpoint.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "InboundEndpointProtocol", + "modelAsString": false, + "values": [ + { + "value": "TCP", + "description": "Use TCP for the endpoint." + }, + { + "value": "UDP", + "description": "Use UDP for the endpoint." + } + ] + } + }, + "backendPort": { + "type": "integer", + "format": "int32", + "title": "The port number on the compute node.", + "description": "This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 22, 3389, 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "title": "The first port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "title": "The last port number in the range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes.", + "description": "Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400." + }, + "networkSecurityGroupRules": { + "type": "array", + "title": "A list of network security group rules that will be applied to the endpoint.", + "description": "The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400.", + "items": { + "$ref": "#/definitions/NetworkSecurityGroupRule" + } + } + }, + "required": [ "name", "protocol", "backendPort", "frontendPortRangeStart", "frontendPortRangeEnd" ], + "title": "A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally." + }, + "NetworkSecurityGroupRule": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "title": "The priority for this rule.", + "description": "Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 3500. If any reserved or duplicate values are provided the request fails with HTTP status code 400." + }, + "access": { + "type": "string", + "title": "The action that should be taken for a specified IP address, subnet range or tag.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "NetworkSecurityGroupRuleAccess", + "modelAsString": false, + "values": [ + { + "value": "Allow", + "description": "Allow access." + }, + { + "value": "Deny", + "description": "Deny access." + } + ] + } + }, + "sourceAddressPrefix": { + "type": "string", + "title": "The source address prefix or tag to match for the rule.", + "description": "Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400." + } + }, + "required": [ "priority", "access", "sourceAddressPrefix" ], + "title": "A network security group rule to apply to an inbound endpoint." + }, + "ListPoolsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "description": "The collection of returned pools." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Batch service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "title": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete, or listKeys/action", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object" + } + } + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "properties": { + "name": { + "type": "string", + "description": "The name to check for availability" + }, + "type": { + "type": "string", + "enum": [ "Microsoft.Batch/batchAccounts" ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false, + "values": [ + { + "value": "Microsoft.Batch/batchAccounts", + "description": "The Batch account resource type.", + "name": "BatchAccounts" + } + ] + }, + "description": "The resource type. Must be set to Microsoft.Batch/batchAccounts" + } + }, + "required": [ + "name", + "type" + ], + "description": "Parameters for a check name availability request." + }, + "CheckNameAvailabilityResult": { + "properties": { + "nameAvailable": { + "readOnly": true, + "type": "boolean", + "description": "Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used." + }, + "reason": { + "readOnly": true, + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "NameAvailabilityReason", + "modelAsString": false, + "values": [ + { + "value": "Invalid", + "description": "The requested name is invalid." + }, + { + "value": "AlreadyExists", + "description": "The requested name is already in use." + } + ] + }, + "description": "Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "Gets an error message explaining the Reason value in more detail." + } + }, + "description": "The CheckNameAvailability operation response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group that contains the Batch account.", + "x-ms-parameter-location": "method" + }, + "AccountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._]+$", + "minLength": 3, + "maxLength": 24, + "description": "The name of the Batch account.", + "x-ms-parameter-location": "method" + }, + "CertificateNameParameter": { + "name": "certificateName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[\\w]+-[\\w]+$", + "minLength": 5, + "maxLength": 45, + "description": "The identifier for the certificate. This must be made up of algorithm and thumbprint separated by a dash, and must match the certificate data in the request. For example SHA1-a3d1c5.", + "x-ms-parameter-location": "method" + }, + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The pool name. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 64, + "description": "The name of the application. This must be unique within the account.", + "x-ms-parameter-location": "method" + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9_.-]*$", + "minLength": 1, + "maxLength": 64, + "description": "The version of the application.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationCreate.json new file mode 100644 index 000000000000..0c1047f0b948 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationCreate.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F8EBB3DC411\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F8EBB3DC411\"", + "properties": { + "allowUpdates": false, + "displayName": "myAppName" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationDelete.json new file mode 100644 index 000000000000..5e440c03da85 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationGet.json new file mode 100644 index 000000000000..aec413231def --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "Sample Application" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationList.json new file mode 100644 index 000000000000..231fd196cddf --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "1" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app2", + "name": "app1", + "etag": "W/\"0x8D64F91A9089879\"", + "properties": { + "allowUpdates": false, + "defaultVersion": "2.0", + "displayName": "myAppName" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageActivate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageActivate.json new file mode 100644 index 000000000000..d8bc48c2f823 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageActivate.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1", + "parameters": { + "format": "zip" + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime":"2017-06-27T18:48:09.9330991Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageCreate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageCreate.json new file mode 100644 index 000000000000..8be9b15da357 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageCreate.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "storageUrl": "http://mystorage1.blob.core.windows.net/myapp?mysas", + "storageUrlExpiry": "2017-06-27T18:48:09.9330991Z", + "state": "Pending" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageDelete.json new file mode 100644 index 000000000000..76181969de38 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageGet.json new file mode 100644 index 000000000000..40253cbe68e2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "versionName": "1" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64FEC83A3B436\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1", + "name": "1", + "etag": "W/\"0x8D64FEC83A3B436\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime":"2017-06-27T18:48:09.9330991Z" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageList.json new file mode 100644 index 000000000000..f4ef7ba4189b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationPackageList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1" + }, + "responses": { + "200": { + "value": [ + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/1.0", + "name": "1.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Pending" + } + }, + { + "type": "Microsoft.Batch/batchAccounts/applications/versions", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1/versions/2.0", + "name": "2.0", + "etag": "W/\"0x8D64FF0B9F47F67\"", + "properties": { + "state": "Active", + "format": "zip", + "lastActivationTime":"2017-06-27T18:48:09.9330991Z" + } + } + ] + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationUpdate.json new file mode 100644 index 000000000000..c9355a114953 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/ApplicationUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "applicationName": "app1", + "parameters": { + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D64F915BDF7F00\"" + }, + "body": { + "type": "Microsoft.Batch/batchAccounts/applications", + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/applications/app1", + "name": "app1", + "etag": "W/\"0x8D64F915BDF7F00\"", + "properties": { + "allowUpdates": true, + "displayName": "myAppName", + "defaultVersion": "2" + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_BYOS.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_BYOS.json new file mode 100644 index 000000000000..b5b305cdc8e9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_BYOS.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + }, + "poolAllocationMode": "UserSubscription", + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "UserSubscription", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + }, + "keyVaultReference": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.KeyVault/vaults/sample", + "url": "http://sample.vault.azure.net/" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_Default.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_Default.json new file mode 100644 index 000000000000..c0b7541190f7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountCreate_Default.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "parameters": { + "location": "japaneast", + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountDelete.json new file mode 100644 index 000000000000..7d32947fb5a2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGet.json new file mode 100644 index 000000000000..3e9b561e4383 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGetKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGetKeys.json new file mode 100644 index 000000000000..ffb9a92b7bb0 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountGetKeys.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountList.json new file mode 100644 index 000000000000..7f366d7f2ae6 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountListByResourceGroup.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountListByResourceGroup.json new file mode 100644 index 000000000000..889e7753d5b2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountRegenerateKey.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountRegenerateKey.json new file mode 100644 index 000000000000..d867fd3eed63 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountRegenerateKey.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "parameters": { + "keyName": "Primary" + } + }, + "responses": { + "200": { + "body": { + "accountName": "sampleacct", + "primary": "AAAA==", + "secondary": "BBBB==" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountSynchronizeAutoStorageKeys.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountSynchronizeAutoStorageKeys.json new file mode 100644 index 000000000000..0bfc652df0cb --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountSynchronizeAutoStorageKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid" + }, + "responses": { + "204": {} + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountUpdate.json new file mode 100644 index 000000000000..35470243a9c7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/BatchAccountUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "sampleacct", + "location": "japaneast", + "properties": { + "accountEndpoint": "sampleacct.japaneast.batch.azure.com", + "provisioningState": "Succeeded", + "poolAllocationMode": "BatchService", + "dedicatedCoreQuota": 20, + "lowPriorityCoreQuota": 20, + "poolQuota": 20, + "activeJobAndJobScheduleQuota": 20, + "autoStorage": { + "storageAccountId": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Storage/storageAccounts/samplestorage", + "lastKeySync": "2016-03-10T23:48:38.9878479Z" + } + }, + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct", + "type": "Microsoft.Batch/batchAccounts" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCancelDeletion.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCancelDeletion.json new file mode 100644 index 000000000000..710568d78965 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCancelDeletion.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD513C3EDBB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag": "W/\"0x8D4EDD513C3EDBB\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Failed", + "previousProvisioningStateTransitionTime": "2017-07-21T00:22:54.3299195Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Full.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Full.json new file mode 100644 index 000000000000..0a3c2b332054 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Full.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "parameters": { + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "data":"MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password":"KG0UY40e...", + "format": "Pfx" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Minimal.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Minimal.json new file mode 100644 index 000000000000..bd3b1ff2b93f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_Minimal.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "parameters": { + "properties": { + "data":"MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password":"KG0UY40e..." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_MinimalCer.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_MinimalCer.json new file mode 100644 index 000000000000..ee9b9fb0526f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateCreate_MinimalCer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "parameters": { + "properties": { + "data":"MIICrjCCAZagAwI...", + "format": "Cer" + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Cer", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateDelete.json new file mode 100644 index 000000000000..d7404dfd2977 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "api-version": "2018-12-01" + }, + "responses": { + "200": { }, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/certificateOperationResults/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E-8D4EDFF164A11C9?api-version=2018-12-01" + } + }, + "204": { } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGet.json new file mode 100644 index 000000000000..d22d85bb10e2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGetWithDeletionError.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGetWithDeletionError.json new file mode 100644 index 000000000000..979e1d11ea25 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateGetWithDeletionError.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Failed", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "previousProvisioningState": "Deleting", + "previousProvisioningStateTransitionTime":"2017-07-21T00:15:25.5625498Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI...", + "deleteCertificateError": { + "code": "NodesReferencingCertificate", + "message": "The specified certificate is being used by the below mentioned node(s)\nRequestId:2dc78afc-b15b-42d2-8c85-39cb61a0799e\nTime:2017-08-28T10:22:52.8633406Z", + "target": "BatchAccount", + "details": [ + { + "code": "Nodes", + "message": "node1, node3" + } + ] + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateList.json new file mode 100644 index 000000000000..ca246d74904a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2018-12-01", + "maxResults": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates?api-version=2017-06-01&$skiptoken=NPK%3D28%3A2857p428pug%2022F53A7734C947B8NRK%3D45%3Asha1-c23dc7f22edc793856a7506fe66397ccb4a33b46SM%3D5%3AFalse" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateListWithFilter.json new file mode 100644 index 000000000000..9e5431fba385 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateListWithFilter.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "api-version": "2018-12-01", + "$filter": "properties/provisioningStateTransitionTime gt '2017-05-01' or properties/provisioningState eq 'Failed'", + "$select": "properties/format,properties/provisioningState" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "provisioningState": "Failed", + "format": "Pfx" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-AEB228FFB0BF67A793D61DCE263EBD16949F15A1", + "name": "SHA1-AEB228FFB0BF67A793D61DCE263EBD16949F15A1", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118572E0\"", + "properties": { + "provisioningState": "Failed", + "format": "Cer" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateUpdate.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateUpdate.json new file mode 100644 index 000000000000..bd3b1ff2b93f --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/CertificateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "sampleacct", + "resourceGroupName": "default-azurebatch-japaneast", + "api-version": "2018-12-01", + "subscriptionId": "subid", + "certificateName": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "parameters": { + "properties": { + "data":"MIIJsgIBAzCCCW4GCSqGSIb3DQE...", + "password":"KG0UY40e..." + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDD5118668F7\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/samplecct/certificates/SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "name": "SHA1-0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "type":"Microsoft.Batch/batchAccounts/certificates", + "etag":"W/\"0x8D4EDD5118668F7\"", + "properties": { + "thumbprintAlgorithm":"SHA1", + "thumbprint":"0A0E4F50D51BEADEAC1D35AFC5116098E7902E6E", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime":"2017-07-21T01:47:38.4420202Z", + "format": "Pfx", + "publicData":"MIICrjCCAZagAwI..." + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_AlreadyExists.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_AlreadyExists.json new file mode 100644 index 000000000000..08ef61ee753e --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_AlreadyExists.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2018-12-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "existingaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "An account named 'existingaccountname' is already in use." + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_Available.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_Available.json new file mode 100644 index 000000000000..b591ebafbb81 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationCheckNameAvailability_Available.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2018-12-01", + "subscriptionId": "subid", + "locationName": "japaneast", + "parameters": { + "name": "newaccountname", + "type": "Microsoft.Batch/batchAccounts" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationGetQuotas.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationGetQuotas.json new file mode 100644 index 000000000000..4a47f4fb34fd --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/LocationGetQuotas.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2018-12-01", + "subscriptionId": "subid", + "locationName": "japaneast" + }, + "responses": { + "200": { + "body": { + "accountQuota": 1 + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_CustomImage.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_CustomImage.json new file mode 100644 index 000000000000..325b22b75b60 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_CustomImage.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/images/image-123" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 0, + "targetLowPriorityNodes": 0 + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_FullExample.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_FullExample.json new file mode 100644 index 000000000000..4f44add3995b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_FullExample.json @@ -0,0 +1,259 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "displayName": "my-pool-name", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "maxTasksPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "password": "examplepassword", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "sshPrivateKey": "sshprivatekeyvalue", + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ] + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "maxTasksPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json new file mode 100644 index 000000000000..67cebc4b7d31 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalCloudServiceConfiguration.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3 + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 3, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json new file mode 100644 index 000000000000..38a823508f17 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_MinimalVirtualMachineConfiguration.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "14.04.5-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "14.04.5-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_VirtualMachineConfiguration.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_VirtualMachineConfiguration.json new file mode 100644 index 000000000000..1f87a33b867d --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolCreate_VirtualMachineConfiguration.json @@ -0,0 +1,163 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "vmSize": "STANDARD_D4", + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ] + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter-SmallDisk", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.windows amd64", + "windowsConfiguration": { + "enableAutomaticUpdates": false + }, + "licenseType": "Windows_Server", + "dataDisks": [ + { + "lun": 0, + "caching": "ReadWrite", + "diskSizeGB": 30, + "storageAccountType": "Premium_LRS" + }, + { + "lun": 1, + "caching": "None", + "diskSizeGB": 200, + "storageAccountType": "Standard_LRS" + } + ] + } + }, + "networkConfiguration": { + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=1", + "evaluationInterval": "PT5M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDelete.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDelete.json new file mode 100644 index 000000000000..f5543c64c4c9 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01" + }, + "responses": { + "200": { }, + "204": { }, + "202": { + "headers": { + "Retry-After": "15", + "Location": "https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/poolOperationResults/delete-testpool-8D4EDFF164A11C9?api-version=2018-12-01" + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDisableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDisableAutoScale.json new file mode 100644 index 000000000000..6d9a91938ae2 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolDisableAutoScale.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "14.04.5-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolGet.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolGet.json new file mode 100644 index 000000000000..e672b1ac68e7 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolGet.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "maxTasksPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolList.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolList.json new file mode 100644 index 000000000000..bc0871c46074 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolList.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Enabled", + "maxTasksPerNode": 13, + "taskSchedulingPolicy": { + "nodeFillType": "Pack" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "4", + "osVersion": "WA-GUEST-OS-4.45_201708-01" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "resizeTimeout": "PT8M" + } + }, + "networkConfiguration": { + "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123", + "endpointConfiguration": { + "inboundNatPools": [ + { + "name": "testnat", + "protocol": "TCP", + "backendPort": 12001, + "frontendPortRangeStart": 15000, + "frontendPortRangeEnd": 15100, + "networkSecurityGroupRules": [ + { + "access": "Allow", + "sourceAddressPrefix": "192.100.12.45", + "priority": 150 + }, + { + "access": "Deny", + "sourceAddressPrefix": "*", + "priority": 3500 + } + ] + } + ] + } + }, + "metadata": [ + { + "name": "metadata-1", + "value": "value-1" + }, + { + "name": "metadata-2", + "value": "value-2" + } + ], + "startTask": { + "commandLine": "cmd /c SET", + "resourceFiles": [ + { + "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file", + "filePath": "c:\\temp\\gohere", + "fileMode": "777" + } + ], + "environmentSettings": [ + { + "name": "MYSET", + "value": "1234" + } + ], + "userIdentity": { + "autoUser": { + "scope": "Pool", + "elevationLevel": "Admin" + } + }, + "maxTaskRetryCount": 6, + "waitForSuccess": true + }, + "userAccounts": [ + { + "name": "username1", + "elevationLevel": "Admin", + "linuxUserConfiguration": { + "uid": 1234, + "gid": 4567 + } + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234", + "version": "asdf" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "RemoteUser" + ] + } + ], + "applicationLicenses": [ + "app-license0", + "app-license1" + ], + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 6, + "targetLowPriorityNodes": 28, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M", + "errors": [ + { + "code": "AllocationTimedout", + "message": "Desired number of dedicated nodes could not be allocated as the resize timeout was reached" + } + ] + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolListWithFilter.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolListWithFilter.json new file mode 100644 index 000000000000..c378f2bf4f76 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolListWithFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "$filter": "startswith(name, 'po') or (properties/allocationState eq 'Steady' and properties/provisioningStateTransitionTime lt datetime'2017-02-02')", + "$select": "properties/allocationState,properties/provisioningStateTransitionTime,properties/currentDedicatedNodes,properties/currentLowPriorityNodes", + "maxResults": "50" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 2 + } + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/pooltest", + "name": "pooltest", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "provisioningStateTransitionTime": "2017-08-26T10:22:55.9407275Z", + "allocationState": "Resizing", + "currentDedicatedNodes": 4, + "currentLowPriorityNodes": 0 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolStopResize.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolStopResize.json new file mode 100644 index 000000000000..e61b3f7db192 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolStopResize.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01" + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-28T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Steady", + "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "virtualMachineConfiguration": { + "imageReference": { + "publisher": "Canonical", + "offer": "UbuntuServer", + "sku": "14.04.5-LTS", + "version": "latest" + }, + "nodeAgentSkuId": "batch.node.ubuntu 14.04" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 3, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT15M" + } + }, + "resizeOperationStatus": { + "startTime": "2017-08-28T10:22:55.9407275Z", + "targetDedicatedNodes": 1, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT10M" + }, + "currentDedicatedNodes": 0, + "currentLowPriorityNodes": 0 + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_EnableAutoScale.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_EnableAutoScale.json new file mode 100644 index 000000000000..aa8194d9e9a1 --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_EnableAutoScale.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicatedNodes=34" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_OtherProperties.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_OtherProperties.json new file mode 100644 index 000000000000..952e920f3a3b --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_OtherProperties.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY" + } + ] + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + }, + "metadata": [ + { + "name": "key1", + "value": "value1" + } + ], + "applicationPackages": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234" + }, + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_5678", + "version": "1.0" + } + ], + "certificates": [ + { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/SHA1-1234567", + "storeLocation": "LocalMachine", + "storeName": "MY", + "visibility": [ + "StartTask", + "Task", + "RemoteUser" + ] + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_RemoveStartTask.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_RemoveStartTask.json new file mode 100644 index 000000000000..4ecbed138f9a --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_RemoveStartTask.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "startTask": {} + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "autoScale": { + "formula": "$TargetDedicated=34", + "evaluationInterval": "PT15M" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 34, + "nodeDeallocationOption": "Requeue", + "resizeTimeout": "PT15M" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_ResizePool.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_ResizePool.json new file mode 100644 index 000000000000..34ca20e96fda --- /dev/null +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2018-12-01/examples/PoolUpdate_ResizePool.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "default-azurebatch-japaneast", + "accountName": "sampleacct", + "poolName": "testpool", + "api-version": "2018-12-01", + "parameters": { + "properties": { + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 5, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + } + } + } + }, + "responses": { + "200": { + "headers": { + "ETag": "W/\"0x8D4EDFEBFADF4AB\"" + }, + "body": { + "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool", + "name": "testpool", + "type": "Microsoft.Batch/batchAccounts/pools", + "etag": "W/\"0x8D4EDFEBFADF4AB\"", + "properties": { + "lastModified": "2017-08-29T10:22:55.9407275Z", + "creationTime": "2017-08-28T10:22:55.9407275Z", + "provisioningState": "Succeeded", + "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-08-29T10:22:55.9407275Z", + "vmSize": "STANDARD_D4", + "interNodeCommunication": "Disabled", + "maxTasksPerNode": 1, + "taskSchedulingPolicy": { + "nodeFillType": "Spread" + }, + "deploymentConfiguration": { + "cloudServiceConfiguration": { + "osFamily": "5", + "osVersion": "*" + } + }, + "scaleSettings": { + "fixedScale": { + "targetDedicatedNodes": 1, + "targetLowPriorityNodes": 0, + "resizeTimeout": "PT8M", + "nodeDeallocationOption": "TaskCompletion" + } + }, + "autoScaleRun": { + "evaluationTime": "2017-08-29T10:22:55.9407275Z", + "results": "$TargetDedicatedNodes=34;NodeDeallocationOption=requeue" + }, + "currentDedicatedNodes": 12, + "currentLowPriorityNodes": 0, + "resizeOperationStatus": { + "startTime": "2017-08-29T10:22:55.9407275Z", + "targetDedicatedNodes": 8, + "nodeDeallocationOption": "TaskCompletion", + "resizeTimeout": "PT8M" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/batch/resource-manager/readme.go.md b/specification/batch/resource-manager/readme.go.md index 2e388a22fd8e..cae71e91ed56 100644 --- a/specification/batch/resource-manager/readme.go.md +++ b/specification/batch/resource-manager/readme.go.md @@ -14,12 +14,22 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) batch: + - tag: package-2018-12 - tag: package-2017-09 - tag: package-2017-05 - tag: package-2017-01 - tag: package-2015-12 ``` +### Tag: package-2018-12 and go + +These settings apply only when `--tag=package-2018-12 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2018-12' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2018-12-01/$(namespace) +``` + ### Tag: package-2017-09 and go These settings apply only when `--tag=package-2017-09 --go` is specified on the command line. diff --git a/specification/batch/resource-manager/readme.md b/specification/batch/resource-manager/readme.md index 4a68131db865..539202a88e0b 100644 --- a/specification/batch/resource-manager/readme.md +++ b/specification/batch/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Batch. - - --- + ## Getting Started + To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,18 +15,27 @@ To build the SDK for Batch, simply [Install AutoRest](https://aka.ms/autorest/in To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Batch API. ``` yaml openapi-type: arm -tag: package-2017-09 +tag: package-2018-12 +``` + +### Tag: package-2018-12 + +These settings apply only when `--tag=package-2018-12` is specified on the command line. + +``` yaml $(tag) == 'package-2018-12' +input-file: + - Microsoft.Batch/stable/2018-12-01/BatchManagement.json ``` ### Tag: package-2017-09 @@ -41,38 +50,40 @@ input-file: ## Suppression Note that this setting should be removed once [this GitHub bug](https://github.com/Azure/azure-openapi-validator/issues/68) is fixed. + ``` yaml directive: - suppress: R2063 from: BatchManagement.json reason: Bug in linter - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json + - 2017-09-01/BatchManagement.json + - 2017-05-01/BatchManagement.json + - 2017-01-01/BatchManagement.json + - 2015-12-01/BatchManagement.json where: - - $.definitions.Application - - $.definitions.ApplicationPackage + - $.definitions.Application + - $.definitions.ApplicationPackage suppress: - - R2020 + - R2020 reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future next API versions. - - from: - - 2017-09-01/BatchManagement.json - - 2017-05-01/BatchManagement.json - - 2017-01-01/BatchManagement.json - - 2015-12-01/BatchManagement.json + - 2017-09-01/BatchManagement.json + - 2017-05-01/BatchManagement.json + - 2017-01-01/BatchManagement.json + - 2015-12-01/BatchManagement.json where: - - $.definitions.Application.properties - - $.definitions.ApplicationPackage.properties + - $.definitions.Application.properties + - $.definitions.ApplicationPackage.properties suppress: - - R3006 + - R3006 reason: Proxy resource written prior to ARM guidelines update and would require breaking changes to fix. The shape of the entity will be corrected in future API versions. + - suppress: OBJECT_MISSING_REQUIRED_PROPERTY + from: BatchManagement.json + where: $.definitions.UserAccount + reason: This field contains a secret (password) and is not returned on a get (but is required on a PUT/PATCH). Previous discussions with the modelling team had said that this was the correct way to model this type of field. ``` - ### Tag: package-2017-05 These settings apply only when `--tag=package-2017-05` is specified on the command line. @@ -82,7 +93,6 @@ input-file: - Microsoft.Batch/stable/2017-05-01/BatchManagement.json ``` - ### Tag: package-2017-01 These settings apply only when `--tag=package-2017-01` is specified on the command line. @@ -101,10 +111,9 @@ input-file: - Microsoft.Batch/stable/2015-12-01/BatchManagement.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -123,7 +132,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_batch'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -160,11 +168,13 @@ python: package-name: azure-mgmt-batch clear-output-folder: true ``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/azure-mgmt-batch/azure/mgmt/batch ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true From 9abb96f0063deaaae6eab5d19b85546656700458 Mon Sep 17 00:00:00 2001 From: Hovsep Date: Wed, 12 Dec 2018 15:51:13 -0800 Subject: [PATCH 402/464] Reorganized sql readme.md and extracted Java section to a separate file. (#4892) * Reorganized sql readme.md and extracted Java section to a separate file. * Addressed review feedback by using -pure- version tags from the readme.md * fixed couple of typos. * Removed DataWarehouseUserActivities file from tag package-pure-2017-03-preview * Fixed autorest error on model generation --- .../sql/resource-manager/readme.java.md | 95 +++++++++++++++++++ specification/sql/resource-manager/readme.md | 48 +--------- 2 files changed, 96 insertions(+), 47 deletions(-) create mode 100644 specification/sql/resource-manager/readme.java.md diff --git a/specification/sql/resource-manager/readme.java.md b/specification/sql/resource-manager/readme.java.md new file mode 100644 index 000000000000..c9f17e8980fd --- /dev/null +++ b/specification/sql/resource-manager/readme.java.md @@ -0,0 +1,95 @@ + +### Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.sql +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-sql +``` + + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-pure-2014-04 + - tag: package-pure-2015-05-preview + - tag: package-pure-2017-03-preview + - tag: package-pure-2017-10-preview + - tag: package-pure-2018-06-preview +``` + +### Tag: package-pure-2014-04 and java + +These settings apply only when `--tag=package-pure-2014-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2014-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2014_04_01 + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2014_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-pure-2015-05-preview and java + +These settings apply only when `--tag=package-pure-2015-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2015-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2015_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2015_05_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-pure-2017-03-preview and java + +These settings apply only when `--tag=package-pure-2017-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2017-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2017_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2017_03_01_preview +regenerate-manager: true +generate-interface: true +directive: + rename-model: + from: DataWarehouseUserActivities + to: DataWarehouseUserActivity +``` + +### Tag: package-pure-2017-10-preview and java + +These settings apply only when `--tag=package-pure-2017-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2017-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2017_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2017_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-pure-2018-06-preview and java + +These settings apply only when `--tag=package-pure-2018-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-pure-2018-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.sql.v2018_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2018_06_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index c45c66bac682..f6c8531d02d3 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -644,53 +644,7 @@ See configuration in [readme.go.md](./readme.go.md) ### Java -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.sql -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-sql -``` - - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-pure-2017-10-preview - - tag: package-2014-04 -``` - -### Tag: package-pure-2017-10-preview and java - -These settings apply only when `--tag=package-pure-2017-10-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-pure-2017-10-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.sql.v2017_10_01_preview - output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2017_10_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2014-04 and java - -These settings apply only when `--tag=package-2014-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2014-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.sql.v2014_04_01 - output-folder: $(azure-libraries-for-java-folder)/sql/resource-manager/v2014_04_01 -regenerate-manager: true -generate-interface: true -``` - +See configuration in [readme.java.md](./readme.java.md) ## Validation From 65799bca13a45bbc7c6774864e967016d4ce5924 Mon Sep 17 00:00:00 2001 From: Jianghao Lu Date: Wed, 12 Dec 2018 16:29:05 -0800 Subject: [PATCH 403/464] Update event grid data plane java config (#4904) --- specification/eventgrid/data-plane/readme.md | 21 +------------------- 1 file changed, 1 insertion(+), 20 deletions(-) diff --git a/specification/eventgrid/data-plane/readme.md b/specification/eventgrid/data-plane/readme.md index 557799c08222..26b3e21bc010 100644 --- a/specification/eventgrid/data-plane/readme.md +++ b/specification/eventgrid/data-plane/readme.md @@ -132,24 +132,5 @@ azure-arm: true namespace: com.microsoft.azure.eventgrid license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-eventgrid +output-folder: $(azure-libraries-for-java-folder)/eventgrid/data-plane ``` - -### Java multi-api - -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-01 -``` - -### Tag: package-2018-01 and java - -These settings apply only when `--tag=package-2018-01 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-2018-01' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.eventgrid.v2018_01_01 - output-folder: $(azure-libraries-for-java-folder)/eventgrid/data-plane/v2018_01_01 -``` - From dd4a045c172e8d0bf9d32a0cf4dddea085cf612c Mon Sep 17 00:00:00 2001 From: Anders Liu Date: Wed, 12 Dec 2018 22:38:01 -0800 Subject: [PATCH 404/464] New APIs for container instance (#4643) * Add ACI spec * fix swagger * Fix casing * Rename and fix warnings * Fix warnings and typo * add default response * Add Id property. --- .../stable/2018-10-01/containerInstance.json | 333 +++++++++++++++++- .../2018-10-01/examples/CachedImagesList.json | 28 ++ .../2018-10-01/examples/CapabilitiesList.json | 39 ++ 3 files changed, 386 insertions(+), 14 deletions(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CapabilitiesList.json diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json index c1fcd7ede62c..086e1f848f2f 100644 --- a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/containerInstance.json @@ -57,6 +57,12 @@ "schema": { "$ref": "#/definitions/ContainerGroupListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -91,6 +97,12 @@ "schema": { "$ref": "#/definitions/ContainerGroupListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-pageable": { @@ -131,6 +143,12 @@ "schema": { "$ref": "#/definitions/ContainerGroup" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } }, @@ -178,8 +196,14 @@ "schema": { "$ref": "#/definitions/ContainerGroup" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } - }, + }, "x-ms-long-running-operation": true }, "patch": { @@ -220,6 +244,12 @@ "schema": { "$ref": "#/definitions/ContainerGroup" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } }, @@ -255,6 +285,12 @@ }, "204": { "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -286,6 +322,12 @@ "responses": { "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -318,6 +360,12 @@ "responses": { "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -349,6 +397,12 @@ "responses": { "204": { "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } }, "x-ms-long-running-operation": true @@ -377,6 +431,12 @@ "schema": { "$ref": "#/definitions/OperationListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -407,6 +467,12 @@ "schema": { "$ref": "#/definitions/UsageListResult" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -454,6 +520,12 @@ "schema": { "$ref": "#/definitions/Logs" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -489,12 +561,12 @@ "type": "string" }, { - "name":"containerExecRequest", - "in":"body", - "description":"The request for the exec command.", - "required":true, - "schema":{ - "$ref":"#/definitions/ContainerExecRequest" + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" } } ], @@ -504,6 +576,12 @@ "schema": { "$ref": "#/definitions/ContainerExecResponse" } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -541,6 +619,86 @@ }, "204": { "description": "No Content - the specified service association link was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } } } } @@ -840,7 +998,7 @@ "GitRepoVolume": { "description": "Represents a volume that is populated with the contents of a git repository", "required": [ - "repository" + "repository" ], "properties": { "directory": { @@ -1348,7 +1506,7 @@ "name" ] }, - "OperationListResult":{ + "OperationListResult": { "description": "The operation list response that contains all operations for Azure Container Instance service.", "type": "object", "properties": { @@ -1395,6 +1553,10 @@ } } }, + "properties": { + "type": "object", + "description": "The additional properties." + }, "origin": { "type": "string", "description": "The intended executor of the operation.", @@ -1409,8 +1571,8 @@ } }, "required": [ - "name", - "display" + "name", + "display" ] }, "UsageListResult": { @@ -1450,7 +1612,7 @@ "type": "object", "description": "The name object of the resource", "properties": { - "value":{ + "value": { "readOnly": true, "type": "string", "description": "The name of the resource" @@ -1503,7 +1665,7 @@ "type": "object", "description": "The size of the terminal.", "properties": { - "rows":{ + "rows": { "type": "integer", "description": "The row size of the terminal" }, @@ -1585,6 +1747,149 @@ } }, "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "id": { + "type": "string", + "description": "The resource Id of the cached image." + }, + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Batch service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Batch service." } }, "parameters": { @@ -1653,4 +1958,4 @@ "x-ms-parameter-location": "method" } } -} +} \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CachedImagesList.json new file mode 100644 index 000000000000..68ad175c3ddb --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CachedImagesList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } + } + \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CapabilitiesList.json new file mode 100644 index 000000000000..065072c43f9d --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2018-10-01/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} \ No newline at end of file From 65689e3494ca837345ee59944c94b8d3f251169f Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Thu, 13 Dec 2018 14:52:37 +0800 Subject: [PATCH 405/464] [HDInsight] - Change package according to dataplane standard (#4883) --- specification/hdinsight/data-plane/readme.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/hdinsight/data-plane/readme.md b/specification/hdinsight/data-plane/readme.md index ef0ab6d3f261..971c20185c64 100644 --- a/specification/hdinsight/data-plane/readme.md +++ b/specification/hdinsight/data-plane/readme.md @@ -65,8 +65,8 @@ Please also specify `--csharp-sdks-folder= Date: Thu, 13 Dec 2018 19:17:18 +0200 Subject: [PATCH 406/464] Adding azure accounts APIs (#4524) * Adding azure accounts APIs * Adding Publishing To Regions Status * fixes * fixing build errors * Fixing OAV errors * Add packaging APIs * fixing build errors * apply yangyuan suggestion * adding response content for gzip apis * Revert "adding response content for gzip apis" This reverts commit 3495ee0147560205dfc77d9c40031ec821e01a6e. * PackageBinaryStreamObject type as file * remove PackageBinaryStreamObject and directly add file type in response * specify body format in packaging response examples * adding content type in packaging response examples parameters * maybe a casing issue? * trying to remove the binary body from response parameters * Add application-json as a 2nd prdocues format for packaging APIs, to describe the error responses * fix * Updating operation ids * fix oav and remove error responses --- .../Authoring/stable/v2.0/LUIS-Authoring.json | 311 +++++++++++++++++- .../SuccessfulGetApplicationsListRequest.json | 4 +- .../SuccessfulPublishApplicationRequest.json | 14 +- ...licationVersionClosedListInfosRequest.json | 4 +- ...tApplicationVersionEntityInfosRequest.json | 4 +- ...tApplicationVersionIntentInfosRequest.json | 4 +- ...etApplicationVersionModelInfosRequest.json | 4 +- ...pplicationVersionPrebuiltInfosRequest.json | 4 +- ...ilablePrebuiltEntityExtractorsRequest.json | 4 +- ...GetPublishedApplicationPackageRequest.json | 16 + ...ulGetTrainedApplicationPackageRequest.json | 16 + .../SuccessfulAssignAzureAccountRequest.json | 22 ++ ...sfulDeleteAssignedAzureAccountRequest.json | 22 ++ ...essfulGetAssignedAzureAccountsRequest.json | 20 ++ .../SuccessfulGetAzureAccountsRequest.json | 19 ++ ...sfulGetApplicationVersionsInfoRequest.json | 4 +- 16 files changed, 453 insertions(+), 19 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulAssignAzureAccountRequest.json create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json create mode 100644 specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAzureAccountsRequest.json diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json index 3aaaf2bf0dcd..ee20fc284610 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/LUIS-Authoring.json @@ -2719,6 +2719,9 @@ "parameters": [ { "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/ForcePath" } ], "responses": { @@ -2815,7 +2818,13 @@ ], "responses": { "201": { - "description": "An object containing the application endpoint URL and its assigned endpoint key.", + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status.", + "schema": { + "$ref": "#/definitions/ProductionOrStagingEndpointInfo" + } + }, + "207": { + "description": "An object containing the application endpoint URL, its assigned endpoint key and publishing status in case that publishing one or more regions failed.", "schema": { "$ref": "#/definitions/ProductionOrStagingEndpointInfo" } @@ -7557,8 +7566,247 @@ } } } + }, + "/apps/{appId}/azureaccounts": { + "post": { + "description": "Assigns an azure account to the application.", + "operationId": "AzureAccounts_AssignToApp", + "summary": "apps - Assign a LUIS azure account to an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "201": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Assign azure account request": { + "$ref": "./examples/stats/SuccessfulAssignAzureAccountRequest.json" + } + } + }, + "get": { + "description": "Gets the LUIS azure accounts assigned to the application for the user using his ARM token.", + "operationId": "AzureAccounts_GetAssigned", + "summary": "apps - Get LUIS azure accounts assigned to the application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + } + ], + "responses": { + "200": { + "description": "A list of azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get assigned azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json" + } + } + }, + "delete": { + "description": "Removes assigned azure account from the application.", + "operationId": "AzureAccounts_RemoveFromApp", + "summary": "apps - Removes an assigned LUIS azure account from an application", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/BearerAuthPath" + }, + { + "name": "azureAccountInfoObject", + "in": "body", + "schema": { + "$ref": "#/definitions/AzureAccountInfoObject" + }, + "description": "The azure account information object." + } + ], + "consumes": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful delete assigned azure account request": { + "$ref": "./examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json" + } + } + } + }, + "/azureaccounts": { + "get": { + "description": "Gets the LUIS azure accounts for the user using his ARM token.", + "operationId": "AzureAccounts_GetUserLUISAccounts", + "summary": "user - Get LUIS azure accounts", + "parameters": [ + { + "$ref": "#/parameters/BearerAuthPath" + } + ], + "responses": { + "200": { + "description": "A list of azure account information objects.", + "schema": { + "$ref": "#/definitions/AzureAccountInfoList" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Successful Get azure accounts request": { + "$ref": "./examples/stats/SuccessfulGetAzureAccountsRequest.json" + } + } + } + }, + "/package/{appId}/slot/{slotName}/gzip": { + "get": { + "description": "Packages published LUIS application as GZip.", + "operationId": "Apps_PackagePublishedApplicationAsGzip", + "summary": "package - Gets published LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/SlotNameInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the published application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetTrainedApplicationPackageRequest.json" + } + } + } + }, + "/package/{appId}/versions/{versionId}/gzip": { + "get": { + "description": "Packages trained LUIS application as GZip.", + "operationId": "Apps_PackageTrainedApplicationAsGzip", + "summary": "package - Gets trained LUIS application package in binary stream GZip format", + "parameters": [ + { + "$ref": "#/parameters/AppIdInPath" + }, + { + "$ref": "#/parameters/VersionIdInPath" + } + ], + "responses": { + "200": { + "description": "The GZip binary stream of the trained application package.", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error Response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/octet-stream", + "application/json" + ], + "x-ms-examples": { + "Successful Get published application package request": { + "$ref": "./examples/package/SuccessfulGetPublishedApplicationPackageRequest.json" + } + } + } } - }, + }, "definitions": { "EntityLabelObject": { "description": "Defines the entity type and position of the extracted entity within the example.", @@ -9113,6 +9361,10 @@ "type": "string", "description": "The endpoint's region." }, + "failedRegions": { + "type": "string", + "description": "Regions where publishing failed." + }, "publishedDateTime": { "description": "Timestamp when was last published.", "type": "string" @@ -9818,6 +10070,36 @@ "type": "string" } } + }, + "AzureAccountInfoList": { + "description": "List of Azure account info objects.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureAccountInfoObject" + } + }, + "AzureAccountInfoObject": { + "description": "Defines the azure account information object.", + "type": "object", + "required": [ + "azureSubscriptionId", + "resourceGroup", + "accountName" + ], + "properties": { + "azureSubscriptionId": { + "description": "The id for the azure subscription.", + "type": "string" + }, + "resourceGroup": { + "description": "The azure resource group name.", + "type": "string" + }, + "accountName": { + "description": "The azure account name.", + "type": "string" + } + } } }, "parameters": { @@ -9865,6 +10147,15 @@ "format": "uuid", "x-ms-parameter-location": "method" }, + "SlotNameInPath": { + "name": "slotName", + "in": "path", + "description": "The publishing slot name.", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, "SkipInPath": { "name": "skip", "in": "query", @@ -9884,6 +10175,14 @@ "maximum": 500, "x-ms-parameter-location": "method" }, + "ForcePath": { + "name": "force", + "in": "query", + "description": "A flag to indicate whether to force an operation.", + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, "Endpoint": { "name": "Endpoint", "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", @@ -9892,6 +10191,14 @@ "type": "string", "in": "path", "x-ms-skip-url-encoding": true + }, + "BearerAuthPath": { + "name": "Authorization", + "in": "header", + "description": "The bearer authorization header to use; containing the user's ARM token used to validate azure accounts information.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" } } } \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json index 659303dd2529..744f4a6a0761 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulGetApplicationsListRequest.json @@ -2,8 +2,8 @@ "parameters": { "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json index b9d787b9955d..76486525b275 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/apps/SuccessfulPublishApplicationRequest.json @@ -15,7 +15,19 @@ "isStaging": false, "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18", "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", - "endpointRegion": "westus", + "endpointRegion": "westus, cus", + "failedRegions": null, + "publishedDateTime": "2017-11-28T19:20:28Z" + } + }, + "207": { + "headers": {}, + "body": { + "isStaging": false, + "endpointUrl": "https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/11be6373fca44ded80fbe2afa8597c18", + "assignedEndpointKey": "11be6373fca44ded80fbe2afa8597c18", + "endpointRegion": "westus, cus", + "failedRegions": "cus", "publishedDateTime": "2017-11-28T19:20:28Z" } } diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json index 09d25fc6e33c..7d56d186c9c7 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionClosedListInfosRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "11be6373fca44ded80fbe2afa8597c18", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json index f7a2e8f98daa..707b47439571 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionEntityInfosRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json index 78e48042ff47..b55418948e40 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionIntentInfosRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json index ea7dc2e12b97..b2e2ab6e98d2 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionModelInfosRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json index 2a779a7dfb41..6171e22c816d 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetApplicationVersionPrebuiltInfosRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses":{ "200":{ diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json index e060917a2803..0bf1713a13b6 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/model/SuccessfulGetAvailablePrebuiltEntityExtractorsRequest.json @@ -4,8 +4,8 @@ "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "86226c53-b7a6-416f-876b-226b2b5ab07b", "versionId": "0.1", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses":{ "200":{ diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json new file mode 100644 index 000000000000..c701c5345510 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetPublishedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json new file mode 100644 index 000000000000..c701c5345510 --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/package/SuccessfulGetTrainedApplicationPackageRequest.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Content-Type": "application/octet-stream", + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "versionId": "0.1", + "slotName": "PRODUCTION" + }, + "responses": { + "200": { + "headers": {}, + "body": "{binary}" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulAssignAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulAssignAzureAccountRequest.json new file mode 100644 index 000000000000..2c2f32084f6c --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulAssignAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json new file mode 100644 index 000000000000..eaf53e9db08a --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulDeleteAssignedAzureAccountRequest.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "azureAccountInfoObject": { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "code": "Success", + "message": "Operation Successful" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json new file mode 100644 index 000000000000..381711d3245b --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAssignedAzureAccountsRequest.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAzureAccountsRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAzureAccountsRequest.json new file mode 100644 index 000000000000..d5bd3b4b00ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/stats/SuccessfulGetAzureAccountsRequest.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", + "Authorization": "Bearer {ARM Token}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "azureSubscriptionId": "{azure_subscription_id}", + "resourceGroup": "{resource_group_name}", + "accountName": "{account_name}" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json index adc76b3779b9..aae2f0736d6b 100644 --- a/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json +++ b/specification/cognitiveservices/data-plane/LUIS/Authoring/stable/v2.0/examples/versions/SuccessfulGetApplicationVersionsInfoRequest.json @@ -3,8 +3,8 @@ "Endpoint": "{Endpoint}", "Ocp-Apim-Subscription-Key": "00000000000000000000000000000000", "appId": "363187f1-c573-46b3-bc4c-ae01d686e68e", - "skip": "0", - "take": "100" + "skip": 0, + "take": 100 }, "responses": { "200": { From f055e33c1a1756db1ef4a5e4b24b47e79c6c9194 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 12:52:18 -0500 Subject: [PATCH 407/464] typo: streamanalytics/resource-manager/Microsoft.StreamAnalytics (#4808) - overwritting -> overwriting - wtih -> with - streamng -> streaming - tranformation -> transformation - Trim trailing spaces --- .../stable/2016-03-01/functions.json | 4 ++-- .../stable/2016-03-01/inputs.json | 8 ++++---- .../stable/2016-03-01/outputs.json | 4 ++-- .../stable/2016-03-01/streamingjobs.json | 10 +++++----- .../stable/2016-03-01/transformations.json | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json index 0c3acc0954a8..4eb0b4d3cff2 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/functions.json @@ -60,7 +60,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", @@ -139,7 +139,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the function. Omit this value to always overwrite the current function. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json index e9427834cb45..69461eb57e65 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/inputs.json @@ -41,7 +41,7 @@ "operationId": "Inputs_CreateOrReplace", "description": "Creates an input or replaces an already existing input under an existing streaming job.", "x-ms-examples": { - "Create a reference blob input wtih CSV serialization": { "$ref": "./examples/Input_Create_Reference_Blob_CSV.json" }, + "Create a reference blob input with CSV serialization": { "$ref": "./examples/Input_Create_Reference_Blob_CSV.json" }, "Create a stream blob input with CSV serialization": { "$ref": "./examples/Input_Create_Stream_Blob_CSV.json" }, "Create a stream Event Hub input with JSON serialization": { "$ref": "./examples/Input_Create_Stream_EventHub_JSON.json" }, "Create a stream IoT Hub input with Avro serialization": { "$ref": "./examples/Input_Create_Stream_IoTHub_Avro.json" } @@ -62,7 +62,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", @@ -143,7 +143,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the input. Omit this value to always overwrite the current input. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -218,7 +218,7 @@ "operationId": "Inputs_Get", "description": "Gets details about the specified input.", "x-ms-examples": { - "Get a reference blob input wtih CSV serialization": { "$ref": "./examples/Input_Get_Reference_Blob_CSV.json" }, + "Get a reference blob input with CSV serialization": { "$ref": "./examples/Input_Get_Reference_Blob_CSV.json" }, "Get a stream blob input with CSV serialization": { "$ref": "./examples/Input_Get_Stream_Blob_CSV.json" }, "Get a stream Event Hub input with JSON serialization": { "$ref": "./examples/Input_Get_Stream_EventHub_JSON.json" }, "Get a stream IoT Hub input with Avro serialization": { "$ref": "./examples/Input_Get_Stream_IoTHub_Avro.json" } diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json index fab3ca8ba5f0..096664f3776c 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/outputs.json @@ -67,7 +67,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", @@ -153,7 +153,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the output. Omit this value to always overwrite the current output. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json index 73896eb6ba64..ac8e6fc57dcb 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json @@ -88,7 +88,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", @@ -164,7 +164,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -497,7 +497,7 @@ } }, "StreamingJob": { - "description": "A streamng job object, containing all information associated with the named streaming job.", + "description": "A streaming job object, containing all information associated with the named streaming job.", "allOf": [ { "$ref": "#/definitions/Resource" @@ -589,7 +589,7 @@ }, "transformation": { "$ref": "./transformations.json#/definitions/Transformation", - "description": "Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual tranformation." + "description": "Indicates the query and the number of streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation." }, "outputs": { "type": "array", @@ -617,7 +617,7 @@ "properties": { "name": { "type": "string", - "description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.", + "description": "The name of the SKU. Required on PUT (CreateOrReplace) requests.", "enum": [ "Standard" ], diff --git a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json index fc9a796a560b..8f2a273b7668 100644 --- a/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json +++ b/specification/streamanalytics/resource-manager/Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json @@ -59,7 +59,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "name": "If-None-Match", @@ -137,7 +137,7 @@ "required": false, "type": "string", "x-ms-client-name": "IfMatch", - "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes." + "description": "The ETag of the transformation. Omit this value to always overwrite the current transformation. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes." }, { "$ref": "#/parameters/ApiVersionParameter" From cf67ce38a2713e68b39f42f27e26354e52c6b8e5 Mon Sep 17 00:00:00 2001 From: v-djnisi <43036465+v-djnisi@users.noreply.github.com> Date: Thu, 13 Dec 2018 18:59:40 +0100 Subject: [PATCH 408/464] Updating managed database swagger (#4907) --- .../2017-03-01-preview/managedDatabases.json | 101 +++++++++++++++--- 1 file changed, 84 insertions(+), 17 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json index 81de6b717226..4a74e5ba7e99 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/managedDatabases.json @@ -60,7 +60,7 @@ "description": "Successfully issued complete restore request." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit." }, "202": { "description": "Completing migration is in progress." @@ -103,7 +103,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." } }, "x-ms-pageable": { @@ -148,7 +148,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." } }, "x-ms-examples": { @@ -197,7 +197,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -211,17 +211,17 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Creates a new managed database by restoring from an external backup": { - "$ref": "./examples/ManagedDatabaseCreateRestoreExternalBackup.json" + "Creates a new managed database with minimal properties": { + "$ref": "./examples/ManagedDatabaseCreateMin.json" }, "Creates a new managed database with maximal properties": { "$ref": "./examples/ManagedDatabaseCreateMax.json" }, - "Creates a new managed database with minimal properties": { - "$ref": "./examples/ManagedDatabaseCreateMin.json" - }, "Creates a new managed database using point in time restore": { "$ref": "./examples/ManagedDatabaseCreatePointInTimeRestore.json" + }, + "Creates a new managed database by restoring from an external backup": { + "$ref": "./examples/ManagedDatabaseCreateRestoreExternalBackup.json" } } }, @@ -229,7 +229,7 @@ "tags": [ "ManagedDatabases" ], - "description": "Deletes the managed database.", + "description": "Deletes a managed database.", "operationId": "ManagedDatabases_Delete", "parameters": [ { @@ -253,7 +253,7 @@ "description": "Successfully deleted the managed database." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Deleting the managed database is in progress." @@ -309,7 +309,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." }, "202": { "description": "Deleting the managed database is in progress." @@ -373,13 +373,14 @@ ] }, "status": { - "description": "Status for the database.", + "description": "Status of the database.", "enum": [ "Online", "Offline", "Shutdown", "Creating", - "Inaccessible" + "Inaccessible", + "Updating" ], "type": "string", "readOnly": true, @@ -430,11 +431,12 @@ ] }, "createMode": { - "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified.", + "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore.", "enum": [ "Default", "RestoreExternalBackup", - "PointInTimeRestore" + "PointInTimeRestore", + "Recovery" ], "type": "string", "x-ms-enum": { @@ -459,6 +461,13 @@ "create" ] }, + "restorableDroppedDatabaseId": { + "description": "The restorable dropped database resource id to restore when creating this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, "storageContainerSasToken": { "description": "Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.", "type": "string", @@ -470,6 +479,64 @@ "description": "Instance Failover Group resource identifier that this managed database belongs to.", "type": "string", "readOnly": true + }, + "recoverableDatabaseId": { + "description": "The resource identifier of the recoverable database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked top level resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } } } }, @@ -481,7 +548,7 @@ "type": "object", "allOf": [ { - "$ref": "../../../common/v1/types.json#/definitions/TrackedResource" + "$ref": "#/definitions/TrackedResource" } ], "properties": { From 8093a595b9d8069e25697c65788a47f12e502e9a Mon Sep 17 00:00:00 2001 From: Igal Sirotin <42036980+igsiroti@users.noreply.github.com> Date: Thu, 13 Dec 2018 21:04:23 +0200 Subject: [PATCH 409/464] DW deactivated error code (#4905) --- .../2017-03-01-preview/sensitivityLabels.json | 12 ++++++------ .../managedDatabaseSensitivityLabels.json | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json index 6ab44b268dbc..61fb8763d07b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/sensitivityLabels.json @@ -55,7 +55,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", @@ -108,7 +108,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", @@ -161,7 +161,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", @@ -243,7 +243,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" } }, "x-ms-examples": { @@ -327,7 +327,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - Label ID must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - Information type ID must be a GUID\n\n * 400 LabelMissing - Label is missing\n\n * 400 InformationTypeMissing - Information Type is missing\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 400 LabelIdMustBeGuid - Label ID must be a GUID\n\n * 400 InformationTypeIdMustBeGuid - Information type ID must be a GUID\n\n * 400 LabelMissing - Label is missing\n\n * 400 InformationTypeMissing - Information Type is missing\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" }, "201": { "description": "Successfully created the sensitivity label.", @@ -405,7 +405,7 @@ "description": "Successfully deleted the sensitivity label." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" } }, "x-ms-examples": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json index 40d205a52708..9ca6c46329f5 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedDatabaseSensitivityLabels.json @@ -84,7 +84,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" } }, "x-ms-examples": { @@ -168,7 +168,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 400 InvalidSensitivityLabelResource - The specified sensitivity label resource is not valid\n\n * 400 SensitivityLabelLabelNameAndInfoTypeNotProvided - At least one of LabelName and InformationType must be specified\n\n * 400 LabelNameTooLong - Label name cannot exceed {0} characters\n\n * 400 InformationTypeTooLong - Information type cannot exceed {0} characters\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" }, "201": { "description": "Successfully created the sensitivity label.", @@ -246,7 +246,7 @@ "description": "Successfully deleted the sensitivity label." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelSourceNameNotSupported - The specified sensitivity label source is not valid\n\n * 404 SensitivityLabelsColumnNotFound - The specified schema/table/column could not be found\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 SensitivityLabelsLabelNotFound - The specified sensitivity label could not be found\n\n * 501 SensitivityLabelRecommendedSourceNameNotSupported - 'Recommended' sensitivity label source is not supported yet" } }, "x-ms-examples": { @@ -295,7 +295,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", @@ -348,7 +348,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", @@ -401,7 +401,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." + "description": "*** Error Responses: ***\n\n * 400 DatawarehouseDatabaseIsDeactivated - Could not execute Data Classification operation because the database is paused. Please resume it.\n\n * 400 SensitivityLabelsInvalidODataQuery - The specified OData query is either not valid or not supported\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance." } }, "x-ms-odata": "#/definitions/SensitivityLabel", From 56925563f2bfa50d993be288b6a53ed62f56a5c8 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Fri, 14 Dec 2018 03:37:29 +0800 Subject: [PATCH 410/464] [HDInsight] - Add FINISHING to application state (#4906) --- .../Microsoft.HDInsight/preview/2018-11-01-preview/job.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json index 629dddce0765..6af967646105 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json @@ -581,6 +581,7 @@ "ACCEPTED", "RUNNING", "FINISHED", + "FINISHING", "FAILED", "KILLED" ], From b14c621d4b23eacc88a3b5f4b779ef5dc500c935 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 15:40:38 -0500 Subject: [PATCH 411/464] typo: adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService (#4582) - Drectory -> Directory - Sucessfully -> Successfully - laert -> alert - addtional -> additional - onboaraded -> onboarded - proeprties -> properties - multile -> multiple - olist -> list - occured -> occurred - distingished -> distinguished - occurance -> occurrence - atttibute -> attribute - faulire -> failure - vlaue -> value - minimun -> minimum - withg -> with - ADHybridhHealthService -> ADHybridHealthService - opertaions -> operations - timeoit -> timeout - unloacked -> unlocked - numbe -> number - obect -> object - setp -> step - recieve -> receive - minutues -> minutes - golbal -> global --- .../2014-01-01/ADHybridHealthService.json | 64 +++++++++---------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json index a0d27ff3854d..def539e54f12 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -195,7 +195,7 @@ ], "responses": { "200": { - "description": "Sucessfully updated service.", + "description": "Successfully updated service.", "schema": { "$ref": "#/definitions/ServiceProperties" } @@ -2787,7 +2787,7 @@ { "name": "serviceMemberId", "in": "path", - "description": "The server Id for which the laert details needs to be queried.", + "description": "The server Id for which the alert details needs to be queried.", "required": true, "type": "string", "format": "uuid" @@ -3287,7 +3287,7 @@ } }, "AdditionalInformation": { - "description": "The addtional information for a property.", + "description": "The additional information for a property.", "type": "object", "properties": { "titleName": { @@ -3374,7 +3374,7 @@ "type": "string" }, "createdDate": { - "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "description": "The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.", "type": "string", "format": "date-time" }, @@ -3416,7 +3416,7 @@ "format": "date-time" }, "lastUpdated": { - "description": "The date and time, in UTC, when the server proeprties were last updated.", + "description": "The date and time, in UTC, when the server properties were last updated.", "type": "string", "format": "date-time" }, @@ -3577,7 +3577,7 @@ } }, "state": { - "description": "The alert state which can be either active or resolved with multile resolution types.", + "description": "The alert state which can be either active or resolved with multiple resolution types.", "type": "string", "enum": [ "Active", @@ -3684,7 +3684,7 @@ "type": "string" }, "state": { - "description": "The alert state which can be either active or resolved with multile resolution types.", + "description": "The alert state which can be either active or resolved with multiple resolution types.", "type": "string" }, "shortName": { @@ -3990,7 +3990,7 @@ "type": "string" }, "objectClasses": { - "description": "The olist of object classes.", + "description": "The list of object classes.", "type": "array", "items": { "type": "string" @@ -4144,7 +4144,7 @@ "type": "string" }, "timeOccured": { - "description": "The time when the connection error occured.", + "description": "The time when the connection error occurred.", "type": "string", "format": "date-time" }, @@ -4196,7 +4196,7 @@ "type": "string" }, "entryNumber": { - "description": "The entry number for object error occured.", + "description": "The entry number for object error occurred.", "type": "integer" }, "lineNumber": { @@ -4208,7 +4208,7 @@ "type": "integer" }, "dn": { - "description": "The distingished name of the object.", + "description": "The distinguished name of the object.", "type": "string" }, "anchor": { @@ -4482,7 +4482,7 @@ "type": "string" }, "timeFirstOccured": { - "description": "The date and time when the export error first occured.", + "description": "The date and time when the export error first occurred.", "type": "string", "format": "date-time" }, @@ -4563,7 +4563,7 @@ "type": "string" }, "timeOccured": { - "description": "The date and time of occurance.", + "description": "The date and time of occurrence.", "type": "string", "format": "date-time" }, @@ -4601,7 +4601,7 @@ "format": "date-time" }, "modifiedAttributeValue": { - "description": "The modified atttribute value.", + "description": "The modified attribute value.", "type": "string" } } @@ -4956,7 +4956,7 @@ "type": "string" }, "consecutiveFailureCount": { - "description": "The number of consecutive faulire counts.", + "description": "The number of consecutive failure counts.", "type": "integer" }, "namingContext": { @@ -5106,7 +5106,7 @@ "$ref": "#/definitions/AssociatedObject" }, "modifiedOrRemovedAttributeValue": { - "description": "The modified or removed attribute vlaue.", + "description": "The modified or removed attribute value.", "type": "string" }, "runStepResultId": { @@ -5232,7 +5232,7 @@ "type": "string" }, "minValue": { - "description": "The minimun value.", + "description": "The minimum value.", "type": "integer" }, "maxValue": { @@ -5355,7 +5355,7 @@ } }, "ObjectWithSyncError": { - "description": "The objects withg sync errors.", + "description": "The objects with sync errors.", "type": "object", "properties": { "sourceOfAuthority": { @@ -5391,7 +5391,7 @@ "type": "string" }, "attributeMultiValues": { - "description": "Indicates if the atttibute is multi-valued or not.", + "description": "Indicates if the attribute is multi-valued or not.", "type": "boolean" }, "minLimit": { @@ -5411,7 +5411,7 @@ "type": "string" }, "timeOccured": { - "description": "The date and time of occurance.", + "description": "The date and time of occurrence.", "type": "string", "format": "date-time" }, @@ -5452,7 +5452,7 @@ "readOnly": true }, "value": { - "description": "List of operations supported by the Microsoft.ADHybridhHealthService resource provider.", + "description": "List of operations supported by the Microsoft.ADHybridHealthService resource provider.", "type": "array", "readOnly": true, "items": { @@ -5460,7 +5460,7 @@ } }, "totalCount": { - "description": "The total count of opertaions.", + "description": "The total count of operations.", "type": "integer" }, "continuationToken": { @@ -5564,7 +5564,7 @@ "type": "string" }, "connectionTimeout": { - "description": "Connection timeoit for password extension.", + "description": "Connection timeout for password extension.", "type": "integer" }, "user": { @@ -5597,7 +5597,7 @@ "type": "boolean" }, "unlockAccount": { - "description": "Indicates if accounts should be unloacked when resetting password.", + "description": "Indicates if accounts should be unlocked when resetting password.", "type": "boolean" } } @@ -5650,7 +5650,7 @@ "type": "string" }, "totalDcCount": { - "description": "The total numbe of domain controllers for a given forest.", + "description": "The total number of domain controllers for a given forest.", "type": "integer" }, "errorDcCount": { @@ -5756,7 +5756,7 @@ "type": "integer" }, "objectProcessLimit": { - "description": "The obect processing limit.", + "description": "The object processing limit.", "type": "integer" }, "objectDeleteLimit": { @@ -5768,7 +5768,7 @@ "type": "integer" }, "partitionId": { - "description": "The Id of the partition that a current run setp operation is executing.", + "description": "The Id of the partition that a current run step operation is executing.", "type": "string" }, "operationType": { @@ -5879,7 +5879,7 @@ "format": "date-time" }, "customNotificationEmails": { - "description": "The list of additional emails that are configured to recieve notifications about the service.", + "description": "The list of additional emails that are configured to receive notifications about the service.", "type": "array", "items": { "type": "string" @@ -6027,7 +6027,7 @@ "type": "string" }, "createdDate": { - "description": "The date time , in UTC, when the server was onboaraded to Azure Active Directory Connect Health.", + "description": "The date time , in UTC, when the server was onboarded to Azure Active Directory Connect Health.", "type": "string", "format": "date-time" }, @@ -6069,7 +6069,7 @@ "format": "date-time" }, "lastUpdated": { - "description": "The date and time, in UTC, when the server proeprties were last updated.", + "description": "The date and time, in UTC, when the server properties were last updated.", "type": "string", "format": "date-time" }, @@ -6216,7 +6216,7 @@ }, "alertSuppressionTimeInMins": { "type": "integer", - "description": "The time in minutues after which an alert will be autosupressed." + "description": "The time in minutes after which an alert will be auto-suppressed." }, "consentedToMicrosoftDevOps": { "type": "boolean", @@ -6249,7 +6249,7 @@ "items": { "type": "string" }, - "description": "The list of golbal administrators for the tenant." + "description": "The list of global administrators for the tenant." }, "initialDomain": { "type": "string", From 42c19540630965885bf4aefad6e764e616d295bd Mon Sep 17 00:00:00 2001 From: Jeffrey Robinson Date: Thu, 13 Dec 2018 13:07:32 -0800 Subject: [PATCH 412/464] Rename folder to correct version (#4909) --- .../acquisitions.json | 0 .../blobServices.json | 0 .../containers.json | 0 .../examples/Acquisitions/List.json | 0 .../examples/BlobService/Get.json | 0 .../BlobService/ListMetricDefinitions.json | 0 .../examples/BlobService/ListMetrics.json | 0 .../examples/Containers/CancelMigration.json | 0 .../examples/Containers/List.json | 0 .../Containers/ListDestinationShares.json | 0 .../examples/Containers/Migrate.json | 0 .../examples/Containers/MigrationStatus.json | 0 .../examples/Farms/Create.json | 0 .../examples/Farms/Get.json | 0 .../Farms/GetGarbageCollectionState.json | 0 .../examples/Farms/List.json | 0 .../examples/Farms/ListMetricDefinitions.json | 0 .../examples/Farms/ListMetrics.json | 0 .../Farms/StartGarbageCollection.json | 0 .../examples/Farms/Update.json | 0 .../examples/Operations/List.json | 0 .../examples/QueueService/Get.json | 0 .../QueueService/ListMetricDefinitions.json | 0 .../examples/QueueService/ListMetrics.json | 0 .../examples/Quotas/CreateOrUpdate.json | 0 .../examples/Quotas/Delete.json | 0 .../examples/Quotas/Get.json | 0 .../examples/Quotas/List.json | 0 .../examples/Shares/Get.json | 0 .../examples/Shares/List.json | 0 .../Shares/ListMetricDefinitions.json | 0 .../examples/Shares/ListMetrics.json | 0 .../examples/StorageAccounts/Get.json | 0 .../examples/StorageAccounts/List.json | 0 .../examples/StorageAccounts/Synchronize.json | 0 .../StorageAccounts/SynchronizeAll.json | 0 .../examples/StorageAccounts/Undelete.json | 0 .../examples/TableService/Get.json | 0 .../TableService/ListMetricDefinitions.json | 0 .../examples/TableService/ListMetrics.json | 0 .../{2016-05-01 => 2015-12-01}/farms.json | 0 .../queueServices.json | 0 .../{2016-05-01 => 2015-12-01}/quotas.json | 0 .../{2016-05-01 => 2015-12-01}/shares.json | 0 .../{2016-05-01 => 2015-12-01}/storage.json | 0 .../storageaccounts.json | 0 .../tableServices.json | 0 .../resource-manager/storage/readme.md | 28 +++++++++---------- 48 files changed, 14 insertions(+), 14 deletions(-) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/acquisitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/blobServices.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/containers.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Acquisitions/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/BlobService/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/BlobService/ListMetricDefinitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/BlobService/ListMetrics.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Containers/CancelMigration.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Containers/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Containers/ListDestinationShares.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Containers/Migrate.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Containers/MigrationStatus.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/Create.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/GetGarbageCollectionState.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/ListMetricDefinitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/ListMetrics.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/StartGarbageCollection.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Farms/Update.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Operations/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/QueueService/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/QueueService/ListMetricDefinitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/QueueService/ListMetrics.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Quotas/CreateOrUpdate.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Quotas/Delete.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Quotas/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Quotas/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Shares/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Shares/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Shares/ListMetricDefinitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/Shares/ListMetrics.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/StorageAccounts/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/StorageAccounts/List.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/StorageAccounts/Synchronize.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/StorageAccounts/SynchronizeAll.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/StorageAccounts/Undelete.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/TableService/Get.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/TableService/ListMetricDefinitions.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/examples/TableService/ListMetrics.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/farms.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/queueServices.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/quotas.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/shares.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/storage.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/storageaccounts.json (100%) rename specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/{2016-05-01 => 2015-12-01}/tableServices.json (100%) diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/containers.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/containers.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Acquisitions/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Acquisitions/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Acquisitions/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Acquisitions/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetricDefinitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetricDefinitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetricDefinitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetrics.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/BlobService/ListMetrics.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/BlobService/ListMetrics.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/CancelMigration.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/CancelMigration.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/CancelMigration.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/CancelMigration.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/ListDestinationShares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/ListDestinationShares.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/ListDestinationShares.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/ListDestinationShares.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/Migrate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/Migrate.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/Migrate.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/Migrate.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/MigrationStatus.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/MigrationStatus.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Containers/MigrationStatus.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Containers/MigrationStatus.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Create.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Create.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Create.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Create.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/GetGarbageCollectionState.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/GetGarbageCollectionState.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/GetGarbageCollectionState.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/GetGarbageCollectionState.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetricDefinitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetricDefinitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetricDefinitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetrics.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/ListMetrics.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/ListMetrics.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/StartGarbageCollection.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/StartGarbageCollection.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/StartGarbageCollection.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/StartGarbageCollection.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Update.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Update.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Farms/Update.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Farms/Update.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Operations/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Operations/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Operations/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Operations/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetricDefinitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetricDefinitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetricDefinitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetrics.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/QueueService/ListMetrics.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/QueueService/ListMetrics.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/CreateOrUpdate.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/CreateOrUpdate.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/CreateOrUpdate.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/CreateOrUpdate.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Delete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Delete.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Delete.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Delete.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Quotas/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetricDefinitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetricDefinitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetricDefinitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetrics.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/Shares/ListMetrics.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Shares/ListMetrics.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/List.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/List.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/List.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/List.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Synchronize.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Synchronize.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Synchronize.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Synchronize.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/SynchronizeAll.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/SynchronizeAll.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/SynchronizeAll.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/SynchronizeAll.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Undelete.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Undelete.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/StorageAccounts/Undelete.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/StorageAccounts/Undelete.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/Get.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/Get.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/Get.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetricDefinitions.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetricDefinitions.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetricDefinitions.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetricDefinitions.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetrics.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetrics.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/examples/TableService/ListMetrics.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/TableService/ListMetrics.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/farms.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/farms.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/quotas.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/quotas.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/shares.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/shares.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storage.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storage.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json similarity index 100% rename from specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json rename to specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json diff --git a/specification/azsadmin/resource-manager/storage/readme.md b/specification/azsadmin/resource-manager/storage/readme.md index 7b8bdc26fb05..6947d0cd7509 100644 --- a/specification/azsadmin/resource-manager/storage/readme.md +++ b/specification/azsadmin/resource-manager/storage/readme.md @@ -24,25 +24,25 @@ These are the global settings for the Storage API. title: StorageAdminClient description: Storage Admin Client openapi-type: arm -tag: package-2016-05-01 +tag: package-2015-12-01 ``` -### Tag: package-2016-05-01 +### Tag: package-2015-12-01 -These settings apply only when `--tag=package-2016-05-01` is specified on the command line. +These settings apply only when `--tag=package-2015-12-01` is specified on the command line. -``` yaml $(tag) == 'package-2016-05-01' +``` yaml $(tag) == 'package-2015-12-01' input-file: - - "Microsoft.Storage.Admin/preview/2016-05-01/storage.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/acquisitions.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/blobServices.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/containers.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/farms.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/queueServices.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/quotas.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/shares.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/storageaccounts.json" - - "Microsoft.Storage.Admin/preview/2016-05-01/tableServices.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/storage.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/acquisitions.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/blobServices.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/containers.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/farms.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/queueServices.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/quotas.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/shares.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/storageaccounts.json" + - "Microsoft.Storage.Admin/preview/2015-12-01/tableServices.json" ``` --- From 6c07433dca9e751127874e2826345d002700f13f Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 16:28:49 -0500 Subject: [PATCH 413/464] typo: authorization/resource-manager/Microsoft.Authorization (#4886) - roleassignment -> role assignment - delgation -> delegation --- .../preview/2017-10-01-preview/authorization-RACalls.json | 6 +++--- .../authorization-RoleAssignmentsCalls.json | 6 +++--- .../authorization-RoleAssignmentsCalls.json | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json index b757e2411197..82b5388256be 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2017-10-01-preview/authorization-RACalls.json @@ -498,7 +498,7 @@ }, "canDelegate":{ "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role Assignments filter" @@ -519,7 +519,7 @@ }, "canDelegate":{ "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role assignment properties with scope." @@ -577,7 +577,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The delgation flag used for creating a role assignment" + "description": "The delegation flag used for creating a role assignment" } }, "description": "Role assignment properties." diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json index e3c98cc22448..01936111b9a2 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleAssignmentsCalls.json @@ -486,7 +486,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role Assignments filter" @@ -507,7 +507,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role assignment properties with scope." @@ -565,7 +565,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The delgation flag used for creating a role assignment" + "description": "The delegation flag used for creating a role assignment" } }, "required": [ diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json index 327f66b83e0e..0edd390dfd0e 100644 --- a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-09-01-preview/authorization-RoleAssignmentsCalls.json @@ -486,7 +486,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role Assignments filter" @@ -527,7 +527,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The Delegation flag for the roleassignment" + "description": "The Delegation flag for the role assignment" } }, "description": "Role assignment properties with scope." @@ -605,7 +605,7 @@ }, "canDelegate": { "type": "boolean", - "description": "The delgation flag used for creating a role assignment" + "description": "The delegation flag used for creating a role assignment" } }, "required": [ From d36b263a58044b8c8872ed41faad3ba087e5038e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 16:29:15 -0500 Subject: [PATCH 414/464] typo: specifined -> specified (#4869) --- specification/analysisservices/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/analysisservices/resource-manager/readme.go.md b/specification/analysisservices/resource-manager/readme.go.md index aedfd776f799..3fda4eff5122 100644 --- a/specification/analysisservices/resource-manager/readme.go.md +++ b/specification/analysisservices/resource-manager/readme.go.md @@ -20,7 +20,7 @@ batch: ### Tag: package-2017-08 and go -These settings apply only when `--tag=package-2017-08 --go` is specifined on the command line. +These settings apply only when `--tag=package-2017-08 --go` is specified on the command line. Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2017-08' && $(go) From 2f6d9516f2a227836a282929d90d7afb0db8102b Mon Sep 17 00:00:00 2001 From: Tal Herscovitz <40788196+talhers@users.noreply.github.com> Date: Fri, 14 Dec 2018 00:19:58 +0200 Subject: [PATCH 415/464] =?UTF-8?q?Add=20ManagedServerSecurityAlertPolicy?= =?UTF-8?q?=20and=20ManagedDatabaseSecurityAlert=E2=80=A6=20(#4521)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add ManagedServerSecurityAlertPolicy and ManagedDatabaseSecurityAlertPolicies * fix incompatible values in swagger * Fix ManagedDatabaseSecurityAlertCreateMin example file --- .../ManagedDatabaseSecurityAlertPolicies.json | 337 ++++++++++++++++++ .../ManagedServerSecurityAlertPolicy.json | 313 ++++++++++++++++ ...ManagedDatabaseSecurityAlertCreateMax.json | 60 ++++ ...ManagedDatabaseSecurityAlertCreateMin.json | 53 +++ .../ManagedDatabaseSecurityAlertGet.json | 28 ++ .../ManagedServerSecurityAlertCreateMax.json | 40 +++ .../ManagedServerSecurityAlertCreateMin.json | 36 ++ .../ManagedServerSecurityAlertGet.json | 27 ++ specification/sql/resource-manager/readme.md | 8 + 9 files changed, 902 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertGet.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json new file mode 100644 index 000000000000..e9c7dfb489f3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json @@ -0,0 +1,337 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ManagedDatabaseSecurityAlertPolicies" + ], + "description": "Gets a managed database's security alert policy.", + "operationId": "ManagedDatabaseSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the managed database for which the security alert policy is defined.", + "required": true, + "type": "string" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the managed database security alert policy.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a database's threat detection policy": { + "$ref": "./examples/ManagedDatabaseSecurityAlertGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedDatabaseSecurityAlertPolicies" + ], + "description": "Creates or updates a database's security alert policy.", + "operationId": "ManagedDatabaseSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the managed database for which the security alert policy is defined.", + "required": true, + "type": "string" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The database security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the managed database security alert policy.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***" + }, + "201": { + "description": "Successfully created the managed database security alert policy.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" + } + } + }, + "x-ms-examples": { + "Update a database's threat detection policy with minimal parameters": { + "$ref": "./examples/ManagedDatabaseSecurityAlertCreateMin.json" + }, + "Update a database's threat detection policy with all parameters": { + "$ref": "./examples/ManagedDatabaseSecurityAlertCreateMax.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedDatabaseSecurityAlertPolicy": { + "description": "A managed database security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json new file mode 100644 index 000000000000..e7e4e739553b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json @@ -0,0 +1,313 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-03-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ManagedServerSecurityAlertPolicies" + ], + "description": "Get a managed server's threat detection policy.", + "operationId": "ManagedServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the managed server threat detection policy.", + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a managed server's threat detection policy": { + "$ref": "./examples/ManagedServerSecurityAlertGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ManagedServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The managed server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ManagedServerSecurityAlertCreateMin.json" + }, + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ManagedServerSecurityAlertCreateMax.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "New", + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedServerSecurityAlertPolicy": { + "description": "A managed server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMax.json new file mode 100644 index 000000000000..0e03bb50718d --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMax.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "databaseName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2017-03-01-preview", + "databaseSecurityAlertPolicyResource": { + "properties": { + "state": "Enabled", + "emailAccountAdmins": "true", + "emailAddresses": ["test@microsoft.com","user@microsoft.com"], + "disabledAlerts": ["Sql_Injection","Usage_Anomaly"], + "retentionDays": 6, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies", + "kind": "V12", + "properties": { + "state": "Enabled", + "emailAccountAdmins": "true", + "emailAddresses": ["test@microsoft.com","user@microsoft.com"], + "disabledAlerts": ["Sql_Injection","Usage_Anomaly"], + "retentionDays": 6, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies", + "kind": "V12", + "properties": { + "state": "Enabled", + "emailAccountAdmins": "true", + "emailAddresses": ["test@microsoft.com","user@microsoft.com"], + "disabledAlerts": ["Access_Anomaly","Usage_Anomaly"], + "retentionDays": 6, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net", + "useServerDefault": "Disabled" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMin.json new file mode 100644 index 000000000000..eecb95676bdd --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertCreateMin.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "databaseName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2017-03-01-preview", + "databaseSecurityAlertPolicyResource": { + "properties": { + "state": "Enabled" + } + } + }, + + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/managedInstance/databases/securityAlertPolicies", + "kind": "V12", + "properties": { + "state": "Enabled", + "emailAccountAdmins": "true", + "emailAddresses": [], + "disabledAlerts": [], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + }, + + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/managedInstance/databases/securityAlertPolicies", + "kind": "V12", + "properties": { + "state": "Enabled", + "emailAccountAdmins": "true", + "emailAddresses": [], + "disabledAlerts": [], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertGet.json new file mode 100644 index 000000000000..bfe957f75f57 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedDatabaseSecurityAlertGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-6852", + "managedInstanceName": "securityalert-2080", + "databaseName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2017-03-01=preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/managedInstances/securityalert-2080/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": ["test@microsoft.com","user@microsoft.com"], + "disabledAlerts": ["Usage_Anomaly"], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMax.json new file mode 100644 index 000000000000..01db47d66248 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMax.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": ["testSecurityAlert@microsoft.com"], + "disabledAlerts": ["Access_Anomaly", "Usage_Anomaly"], + "retentionDays": 5, + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": ["testSecurityAlert@microsoft.com"], + "disabledAlerts": ["Access_Anomaly","Usage_Anomaly"], + "retentionDays": 5, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMin.json new file mode 100644 index 000000000000..d04d11b02c85 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertCreateMin.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview", + "parameters": { + "properties": { + "state": "Enabled", + "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Enabled", + "emailAccountAdmins": true, + "emailAddresses": [], + "disabledAlerts": [], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "https://mystorage.blob.core.windows.net" + } + } + }, + "202": { + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertGet.json new file mode 100644 index 000000000000..789e680e1bec --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/examples/ManagedServerSecurityAlertGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Disabled", + "emailAccountAdmins": true, + "emailAddresses": [ "test@microsoft.com;user@microsoft.com" ], + "disabledAlerts": ["Access_Anomaly"], + "retentionDays": 0, + "storageAccountAccessKey": "", + "storageEndpoint": "" + } + } + } + } +} \ No newline at end of file diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index f6c8531d02d3..be0936c4f6a7 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -93,6 +93,8 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/capabilities.json @@ -177,6 +179,8 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -251,6 +255,8 @@ input-file: - Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json - Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json - Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json - Microsoft.Sql/preview/2017-10-01-preview/cancelPoolOperations.json - Microsoft.Sql/preview/2017-10-01-preview/databaseVulnerabilityAssessmentScans.json @@ -488,6 +494,8 @@ input-file: - ./Microsoft.Sql/preview/2017-03-01-preview/serverAutomaticTuning.json - ./Microsoft.Sql/preview/2017-03-01-preview/serverDnsAliases.json - ./Microsoft.Sql/preview/2017-03-01-preview/serverSecurityAlertPolicies.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedDatabaseSecurityAlertPolicies.json + - ./Microsoft.Sql/preview/2017-03-01-preview/ManagedServerSecurityAlertPolicy.json # Needed when there is more than one input file override-info: From b1c3db5bb55995c33f299a79711a1b5f2d14596a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:06:22 -0500 Subject: [PATCH 416/464] fix: Casing specification/monitor/resource-manager/Microsoft.Insights (#4735) * fix: Casing specification/monitor/resource-manager/Microsoft.Insights Rest of the repo folders using uppercase for this level of folders * fix: Casing for monitor/resource-manager/Microsoft.Insights YAML --- .../activityLogAlerts_API.json | 0 .../createOrUpdateActivityLogAlert.json | 0 .../examples/deleteActivityLogAlert.json | 0 .../examples/getActivityLogAlert.json | 0 .../examples/listActivityLogAlerts.json | 0 .../examples/patchActivityLogAlert.json | 0 .../diagnosticsSettingsCategories_API.json | 0 .../diagnosticsSettings_API.json | 0 .../examples/GetMetric.json | 0 .../examples/GetMetricDefinitions.json | 0 .../examples/GetMetricMetadata.json | 0 .../createOrUpdateDiagnosticSetting.json | 0 .../examples/deleteDiagnosticSetting.json | 0 .../examples/getDiagnosticSetting.json | 0 .../getDiagnosticSettingsCategory.json | 0 .../examples/listDiagnosticSettings.json | 0 .../listDiagnosticSettingsCategories.json | 0 .../metricDefinitions_API.json | 0 .../2017-05-01-preview/metrics_API.json | 0 .../2017-11-01-preview/baseline_API.json | 0 .../calculateBaseline_API.json | 0 .../examples/CalculateBaseline.json | 0 .../examples/GetBaseline.json | 0 .../examples/GetBaselineMetadata.json | 0 .../examples/GetMetricNamespaces.json | 0 .../metricNamespaces_API.json | 0 ...createOrUpdateGuestDiagnosticSettings.json | 0 ...ateGuestDiagnosticSettingsAssociation.json | 0 ...eteGuestDiagnosticSettingsAssociation.json | 0 .../examples/getGuestDiagnosticSettings.json | 0 ...getGuestDiagnosticSettingsAssociation.json | 0 ...ateGuestDiagnosticSettingsAssociation.json | 0 ...uestDiagnosticSettingsAssociation_API.json | 0 .../guestDiagnosticSettings_API.json | 0 .../stable/2015-04-01/activityLogs_API.json | 0 .../stable/2015-04-01/autoscale_API.json | 0 .../2015-04-01/eventCategories_API.json | 0 .../examples/GetActivityLogsFiltered.json | 0 .../GetActivityLogsFilteredAndSelected.json | 0 .../examples/GetActivityLogsNoParams.json | 0 .../examples/GetActivityLogsSelected.json | 0 .../examples/GetEventCategories.json | 0 .../GetTenantActivityLogsFiltered.json | 0 ...TenantActivityLogsFilteredAndSelected.json | 0 .../GetTenantActivityLogsNoParams.json | 0 .../GetTenantActivityLogsSelected.json | 0 .../2015-04-01/examples/OperationList.json | 0 .../createOrUpdateAutoscaleSetting.json | 0 .../examples/deleteAutoscaleSetting.json | 0 .../examples/getAutoscaleSetting.json | 0 .../examples/listAutoscaleSetting.json | 0 .../listAutoscaleSettingBySubscription.json | 0 .../examples/patchAutoscaleSetting.json | 0 .../stable/2015-04-01/operations_API.json | 0 .../2015-04-01/tenantActivityLogs_API.json | 0 .../serviceDiagnosticsSettings_API.json | 0 .../2016-03-01/alertRulesIncidents_API.json | 0 .../stable/2016-03-01/alertRules_API.json | 0 .../examples/GetMetricDefinitions.json | 0 .../GetMetricDefinitionsFiltered.json | 0 .../examples/createOrUpdateAlertRule.json | 0 .../examples/createOrUpdateLogProfile.json | 0 .../2016-03-01/examples/deleteAlertRule.json | 0 .../2016-03-01/examples/deleteLogProfile.json | 0 .../2016-03-01/examples/getAlertRule.json | 0 .../examples/getAlertRuleIncident.json | 0 .../2016-03-01/examples/getLogProfile.json | 0 .../2016-03-01/examples/listAlertRule.json | 0 .../examples/listAlertRuleBySubscription.json | 0 .../examples/listAlertRuleIncidents.json | 0 .../2016-03-01/examples/listLogProfile.json | 0 .../2016-03-01/examples/patchAlertRule.json | 0 .../2016-03-01/examples/patchLogProfile.json | 0 .../stable/2016-03-01/logProfiles_API.json | 0 .../2016-03-01/metricDefinitions_API.json | 0 .../stable/2016-09-01/examples/GetMetric.json | 0 .../examples/GetMetricFiltered.json | 0 ...reateOrUpdateServiceDiagnosticSetting.json | 0 .../examples/getServiceDiagnosticSetting.json | 0 .../updateServiceDiagnosticSetting.json | 0 .../stable/2016-09-01/metrics_API.json | 0 .../serviceDiagnosticsSettings_API.json | 0 .../stable/2017-04-01/actionGroups_API.json | 0 .../2017-04-01/activityLogAlerts_API.json | 0 .../examples/createOrUpdateActionGroup.json | 0 .../createOrUpdateActivityLogAlert.json | 0 .../examples/deleteActionGroup.json | 0 .../examples/deleteActivityLogAlert.json | 0 .../2017-04-01/examples/enableReceiver.json | 0 .../2017-04-01/examples/getActionGroup.json | 0 .../examples/getActivityLogAlert.json | 0 .../2017-04-01/examples/listActionGroups.json | 0 .../examples/listActivityLogAlerts.json | 0 .../2017-04-01/examples/patchActionGroup.json | 0 .../examples/patchActivityLogAlert.json | 0 .../stable/2018-01-01/examples/GetMetric.json | 0 .../examples/GetMetricDefinitions.json | 0 .../examples/GetMetricMetadata.json | 0 .../2018-01-01/metricDefinitions_API.json | 0 .../stable/2018-01-01/metrics_API.json | 0 .../stable/2018-03-01/actionGroups_API.json | 0 .../examples/UpdateMetricAlert.json | 0 .../examples/createOrUpdateActionGroup.json | 0 ...teOrUpdateMetricAlertMultipleResource.json | 0 ...reateOrUpdateMetricAlertResourceGroup.json | 0 ...eateOrUpdateMetricAlertSingleResource.json | 0 ...createOrUpdateMetricAlertSubscription.json | 0 .../examples/deleteActionGroup.json | 0 .../examples/deleteMetricAlert.json | 0 .../2018-03-01/examples/enableReceiver.json | 0 .../2018-03-01/examples/getActionGroup.json | 0 .../getMetricAlertMultipleResource.json | 0 .../examples/getMetricAlertResourceGroup.json | 0 .../getMetricAlertSingleResource.json | 0 .../examples/getMetricAlertStatus.json | 0 .../examples/getMetricAlertStatusByName.json | 0 .../examples/getMetricAlertSubscription.json | 0 .../2018-03-01/examples/listActionGroups.json | 0 .../2018-03-01/examples/listMetricAlert.json | 0 .../2018-03-01/examples/patchActionGroup.json | 0 .../stable/2018-03-01/metricAlert_API.json | 0 ...eScheduledQueryRule-LogToMetricAction.json | 0 .../createOrUpdateScheduledQueryRules.json | 0 ...eScheduledQueryRuleswithCrossResource.json | 0 .../examples/deleteScheduledQueryRules.json | 0 .../examples/getScheduledQueryRules.json | 0 .../examples/listScheduledQueryRules.json | 0 .../examples/patchScheduledQueryRules.json | 0 .../2018-04-16/scheduledQueryRule_API.json | 0 .../stable/2018-09-01/actionGroups_API.json | 0 .../stable/2018-09-01/baseline_API.json | 0 .../2018-09-01/calculateBaseline_API.json | 0 .../examples/CalculateBaseline.json | 0 .../2018-09-01/examples/GetBaseline.json | 0 .../examples/GetBaselineMetadata.json | 0 .../examples/createOrUpdateActionGroup.json | 0 .../examples/deleteActionGroup.json | 0 .../2018-09-01/examples/enableReceiver.json | 0 .../2018-09-01/examples/getActionGroup.json | 0 .../2018-09-01/examples/listActionGroups.json | 0 .../2018-09-01/examples/patchActionGroup.json | 0 .../monitor/resource-manager/readme.md | 236 +++++++++--------- 142 files changed, 118 insertions(+), 118 deletions(-) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/activityLogAlerts_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/examples/createOrUpdateActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/examples/deleteActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/examples/getActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/examples/listActivityLogAlerts.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-03-01-preview/examples/patchActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/diagnosticsSettings_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/GetMetric.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/GetMetricDefinitions.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/GetMetricMetadata.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/getDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/listDiagnosticSettings.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/metricDefinitions_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-05-01-preview/metrics_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-11-01-preview/baseline_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-11-01-preview/calculateBaseline_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-11-01-preview/examples/CalculateBaseline.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-11-01-preview/examples/GetBaseline.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-11-01-preview/examples/GetBaselineMetadata.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-12-01-preview/examples/GetMetricNamespaces.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2017-12-01-preview/metricNamespaces_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/preview/2018-06-01-preview/guestDiagnosticSettings_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/activityLogs_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/autoscale_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/eventCategories_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetActivityLogsFiltered.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetActivityLogsFilteredAndSelected.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetActivityLogsNoParams.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetActivityLogsSelected.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetEventCategories.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetTenantActivityLogsFiltered.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetTenantActivityLogsFilteredAndSelected.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetTenantActivityLogsNoParams.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/GetTenantActivityLogsSelected.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/OperationList.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/createOrUpdateAutoscaleSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/deleteAutoscaleSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/getAutoscaleSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/listAutoscaleSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/examples/patchAutoscaleSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/operations_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-04-01/tenantActivityLogs_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2015-07-01/serviceDiagnosticsSettings_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/alertRulesIncidents_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/alertRules_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/GetMetricDefinitions.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/GetMetricDefinitionsFiltered.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/createOrUpdateAlertRule.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/createOrUpdateLogProfile.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/deleteAlertRule.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/deleteLogProfile.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/getAlertRule.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/getAlertRuleIncident.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/getLogProfile.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/listAlertRule.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/listAlertRuleBySubscription.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/listAlertRuleIncidents.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/listLogProfile.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/patchAlertRule.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/examples/patchLogProfile.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/logProfiles_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-03-01/metricDefinitions_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/examples/GetMetric.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/examples/GetMetricFiltered.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/examples/createOrUpdateServiceDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/examples/getServiceDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/metrics_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2016-09-01/serviceDiagnosticsSettings_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/actionGroups_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/activityLogAlerts_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/createOrUpdateActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/createOrUpdateActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/deleteActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/deleteActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/enableReceiver.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/getActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/getActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/listActionGroups.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/listActivityLogAlerts.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/patchActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2017-04-01/examples/patchActivityLogAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-01-01/examples/GetMetric.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-01-01/examples/GetMetricDefinitions.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-01-01/examples/GetMetricMetadata.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-01-01/metricDefinitions_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-01-01/metrics_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/actionGroups_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/UpdateMetricAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/createOrUpdateActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/createOrUpdateMetricAlertMultipleResource.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/createOrUpdateMetricAlertResourceGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/createOrUpdateMetricAlertSingleResource.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/createOrUpdateMetricAlertSubscription.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/deleteActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/deleteMetricAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/enableReceiver.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertMultipleResource.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertResourceGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertSingleResource.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertStatus.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertStatusByName.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/getMetricAlertSubscription.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/listActionGroups.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/listMetricAlert.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/examples/patchActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-03-01/metricAlert_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/createOrUpdateScheduledQueryRule-LogToMetricAction.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/createOrUpdateScheduledQueryRuleswithCrossResource.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/deleteScheduledQueryRules.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/getScheduledQueryRules.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/listScheduledQueryRules.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/examples/patchScheduledQueryRules.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-04-16/scheduledQueryRule_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/actionGroups_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/baseline_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/calculateBaseline_API.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/CalculateBaseline.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/GetBaseline.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/GetBaselineMetadata.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/createOrUpdateActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/deleteActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/enableReceiver.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/getActionGroup.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/listActionGroups.json (100%) rename specification/monitor/resource-manager/{microsoft.insights => Microsoft.Insights}/stable/2018-09-01/examples/patchActionGroup.json (100%) diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/activityLogAlerts_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/activityLogAlerts_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/createOrUpdateActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/createOrUpdateActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/createOrUpdateActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/createOrUpdateActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/deleteActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/deleteActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/deleteActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/deleteActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/getActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/getActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/getActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/getActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/listActivityLogAlerts.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/listActivityLogAlerts.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/listActivityLogAlerts.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/listActivityLogAlerts.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/patchActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/patchActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-03-01-preview/examples/patchActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-03-01-preview/examples/patchActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetric.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetric.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetric.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetricDefinitions.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricDefinitions.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetricDefinitions.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricDefinitions.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/GetMetricMetadata.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/createOrUpdateDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/deleteDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/getDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/getDiagnosticSettingsCategory.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/listDiagnosticSettings.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/examples/listDiagnosticSettingsCategories.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-05-01-preview/metrics_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/baseline_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/CalculateBaseline.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/CalculateBaseline.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/CalculateBaseline.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/CalculateBaseline.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/GetBaseline.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/GetBaseline.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/GetBaseline.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/GetBaseline.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/GetBaselineMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/GetBaselineMetadata.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-11-01-preview/examples/GetBaselineMetadata.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-11-01-preview/examples/GetBaselineMetadata.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/examples/GetMetricNamespaces.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2017-12-01-preview/metricNamespaces_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2017-12-01-preview/metricNamespaces_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettings.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/createOrUpdateGuestDiagnosticSettingsAssociation.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/deleteGuestDiagnosticSettingsAssociation.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettings.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/getGuestDiagnosticSettingsAssociation.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/examples/updateGuestDiagnosticSettingsAssociation.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettingsAssociation_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/preview/2018-06-01-preview/guestDiagnosticSettings_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/activityLogs_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/activityLogs_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/autoscale_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/eventCategories_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/eventCategories_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/eventCategories_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsFiltered.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsFiltered.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsFiltered.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsFiltered.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsFilteredAndSelected.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsFilteredAndSelected.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsFilteredAndSelected.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsFilteredAndSelected.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsNoParams.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsNoParams.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsNoParams.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsNoParams.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsSelected.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsSelected.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetActivityLogsSelected.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetActivityLogsSelected.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetEventCategories.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetEventCategories.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetEventCategories.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetEventCategories.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsFiltered.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsFiltered.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsFiltered.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsFiltered.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsFilteredAndSelected.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsFilteredAndSelected.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsFilteredAndSelected.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsFilteredAndSelected.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsNoParams.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsNoParams.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsNoParams.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsNoParams.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsSelected.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsSelected.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/GetTenantActivityLogsSelected.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/GetTenantActivityLogsSelected.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/OperationList.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/OperationList.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/OperationList.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/OperationList.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/createOrUpdateAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/createOrUpdateAutoscaleSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/createOrUpdateAutoscaleSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/createOrUpdateAutoscaleSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/deleteAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/deleteAutoscaleSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/deleteAutoscaleSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/deleteAutoscaleSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/getAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/getAutoscaleSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/getAutoscaleSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/getAutoscaleSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/listAutoscaleSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/listAutoscaleSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/listAutoscaleSettingBySubscription.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/patchAutoscaleSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/patchAutoscaleSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/examples/patchAutoscaleSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/examples/patchAutoscaleSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/operations_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/operations_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/operations_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2015-07-01/serviceDiagnosticsSettings_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/alertRules_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/alertRules_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/GetMetricDefinitions.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/GetMetricDefinitions.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/GetMetricDefinitions.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/GetMetricDefinitions.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/GetMetricDefinitionsFiltered.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/GetMetricDefinitionsFiltered.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/GetMetricDefinitionsFiltered.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/GetMetricDefinitionsFiltered.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateAlertRule.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/createOrUpdateLogProfile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateLogProfile.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/createOrUpdateLogProfile.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/createOrUpdateLogProfile.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/deleteAlertRule.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/deleteAlertRule.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/deleteAlertRule.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/deleteAlertRule.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/deleteLogProfile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/deleteLogProfile.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/deleteLogProfile.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/deleteLogProfile.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getAlertRule.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getAlertRule.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRule.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getAlertRuleIncident.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getAlertRuleIncident.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getAlertRuleIncident.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getLogProfile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getLogProfile.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/getLogProfile.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/getLogProfile.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRule.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRule.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRule.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRule.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleBySubscription.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleIncidents.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleIncidents.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listAlertRuleIncidents.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listAlertRuleIncidents.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listLogProfile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listLogProfile.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/listLogProfile.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/listLogProfile.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/patchAlertRule.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchAlertRule.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/patchAlertRule.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchAlertRule.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/patchLogProfile.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchLogProfile.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/examples/patchLogProfile.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/examples/patchLogProfile.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/logProfiles_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/logProfiles_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/metricDefinitions_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-03-01/metricDefinitions_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/GetMetric.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/GetMetric.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/GetMetric.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/GetMetricFiltered.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/GetMetricFiltered.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/GetMetricFiltered.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/GetMetricFiltered.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/createOrUpdateServiceDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/createOrUpdateServiceDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/createOrUpdateServiceDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/createOrUpdateServiceDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/getServiceDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/getServiceDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/getServiceDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/getServiceDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/examples/updateServiceDiagnosticSetting.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/metrics_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/metrics_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/metrics_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/actionGroups_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/actionGroups_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/actionGroups_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/actionGroups_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/createOrUpdateActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/createOrUpdateActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/createOrUpdateActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/createOrUpdateActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/createOrUpdateActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/createOrUpdateActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/createOrUpdateActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/createOrUpdateActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/deleteActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/deleteActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/deleteActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/deleteActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/deleteActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/deleteActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/deleteActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/deleteActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/enableReceiver.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/enableReceiver.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/enableReceiver.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/enableReceiver.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/getActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/getActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/getActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/getActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/getActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/getActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/getActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/getActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/listActionGroups.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/listActionGroups.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/listActionGroups.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/listActionGroups.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/listActivityLogAlerts.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/listActivityLogAlerts.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/listActivityLogAlerts.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/listActivityLogAlerts.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/patchActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/patchActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/patchActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/patchActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/patchActivityLogAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/patchActivityLogAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2017-04-01/examples/patchActivityLogAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2017-04-01/examples/patchActivityLogAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetric.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetric.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetric.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetric.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetricDefinitions.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetricDefinitions.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricDefinitions.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetricMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricMetadata.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/examples/GetMetricMetadata.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/examples/GetMetricMetadata.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metricDefinitions_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-01-01/metrics_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-01-01/metrics_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/actionGroups_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/actionGroups_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/UpdateMetricAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/UpdateMetricAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertMultipleResource.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertMultipleResource.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertMultipleResource.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertMultipleResource.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertResourceGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertResourceGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertResourceGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSingleResource.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSingleResource.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSingleResource.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSingleResource.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSubscription.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSubscription.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/createOrUpdateMetricAlertSubscription.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/deleteActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/deleteActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/deleteActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/deleteActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/deleteMetricAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/deleteMetricAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/deleteMetricAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/deleteMetricAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/enableReceiver.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/enableReceiver.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/enableReceiver.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/enableReceiver.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertMultipleResource.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertMultipleResource.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertMultipleResource.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertMultipleResource.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertResourceGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertResourceGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertResourceGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertSingleResource.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertSingleResource.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertSingleResource.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertSingleResource.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertStatus.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatus.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertStatus.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatus.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertStatusByName.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertSubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertSubscription.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/getMetricAlertSubscription.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/getMetricAlertSubscription.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/listActionGroups.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listActionGroups.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/listActionGroups.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listActionGroups.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/listMetricAlert.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/listMetricAlert.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/listMetricAlert.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/patchActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/patchActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/examples/patchActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/examples/patchActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-03-01/metricAlert_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRule-LogToMetricAction.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRule-LogToMetricAction.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRule-LogToMetricAction.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRule-LogToMetricAction.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRules.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRuleswithCrossResource.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRuleswithCrossResource.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRuleswithCrossResource.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/createOrUpdateScheduledQueryRuleswithCrossResource.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/deleteScheduledQueryRules.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/getScheduledQueryRules.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/getScheduledQueryRules.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/getScheduledQueryRules.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/listScheduledQueryRules.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/listScheduledQueryRules.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/listScheduledQueryRules.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/listScheduledQueryRules.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/patchScheduledQueryRules.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/patchScheduledQueryRules.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/examples/patchScheduledQueryRules.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/examples/patchScheduledQueryRules.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/actionGroups_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/actionGroups_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/actionGroups_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/baseline_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/baseline_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/calculateBaseline_API.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/calculateBaseline_API.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/calculateBaseline_API.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/CalculateBaseline.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/CalculateBaseline.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/CalculateBaseline.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/CalculateBaseline.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/GetBaseline.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/GetBaseline.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/GetBaseline.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/GetBaseline.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/GetBaselineMetadata.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/GetBaselineMetadata.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/GetBaselineMetadata.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/GetBaselineMetadata.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/createOrUpdateActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/deleteActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/deleteActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/deleteActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/enableReceiver.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/enableReceiver.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/enableReceiver.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/getActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/getActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/getActionGroup.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/listActionGroups.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/listActionGroups.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/listActionGroups.json diff --git a/specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/patchActionGroup.json similarity index 100% rename from specification/monitor/resource-manager/microsoft.insights/stable/2018-09-01/examples/patchActionGroup.json rename to specification/monitor/resource-manager/Microsoft.Insights/stable/2018-09-01/examples/patchActionGroup.json diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 149a54c3ee94..99c43d876c8e 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -38,25 +38,25 @@ These settings apply only when `--tag=package-2018-09` is specified on the comma ``` yaml $(tag) == 'package-2018-09' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json -- microsoft.insights/stable/2018-01-01/metricDefinitions_API.json -- microsoft.insights/stable/2018-01-01/metrics_API.json -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json -- microsoft.insights/stable/2018-03-01/metricAlert_API.json -- microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json -- microsoft.insights/preview/2017-12-01-preview/metricNamespaces_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2017-12-01-preview/metricNamespaces_API.json ``` ### Tag: package-2018-03 @@ -65,24 +65,24 @@ These settings apply only when `--tag=package-2018-03` is specified on the comma ``` yaml $(tag) == 'package-2018-03' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json -- microsoft.insights/stable/2018-01-01/metricDefinitions_API.json -- microsoft.insights/stable/2018-01-01/metrics_API.json -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json -- microsoft.insights/stable/2018-03-01/metricAlert_API.json -- microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json ``` @@ -92,22 +92,22 @@ These settings apply only when `--tag=package-2018-02-preview` is specified on t ``` yaml $(tag) == 'package-2018-02-preview' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json -- microsoft.insights/stable/2018-01-01/metricDefinitions_API.json -- microsoft.insights/stable/2018-01-01/metrics_API.json -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` @@ -117,22 +117,22 @@ These settings apply only when `--tag=package-2017-12` is specified on the comma ``` yaml $(tag) == 'package-2017-12' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json -- microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json -- microsoft.insights/preview/2017-05-01-preview/metrics_API.json -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` ### Tag: package-2017-09 @@ -141,22 +141,22 @@ These settings apply only when `--tag=package-2017-09` is specified on the comma ``` yaml $(tag) == 'package-2017-09' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json -- microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json -- microsoft.insights/preview/2017-05-01-preview/metrics_API.json -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` ### Tag: package-2017-08 @@ -165,15 +165,15 @@ These settings apply only when `--tag=package-2017-08` is specified on the comma ``` yaml $(tag) == 'package-2017-08' input-file: -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/stable/2018-09-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/stable/2018-09-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json ``` ### Tag: package-2018-01-01-only @@ -182,8 +182,8 @@ These settings apply only when `--tag=package-2018-01-01-only` is specified on t ``` yaml $(tag) == 'package-2018-01-01-only' input-file: -- microsoft.insights/stable/2018-01-01/metricDefinitions_API.json -- microsoft.insights/stable/2018-01-01/metrics_API.json +- Microsoft.Insights/stable/2018-01-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2018-01-01/metrics_API.json ``` ### Tag: package-2018-03-01-only @@ -192,8 +192,8 @@ These settings apply only when `--tag=package-2018-03-01-only` is specified on t ``` yaml $(tag) == 'package-2018-03-01-only' input-file: -- microsoft.insights/stable/2018-03-01/metricAlert_API.json -- microsoft.insights/stable/2018-03-01/actionGroups_API.json +- Microsoft.Insights/stable/2018-03-01/metricAlert_API.json +- Microsoft.Insights/stable/2018-03-01/actionGroups_API.json ``` ### Tag: package-2018-04-16-only @@ -202,7 +202,7 @@ These settings apply only when `--tag=package-2018-04-16-only` is specified on t ``` yaml $(tag) == 'package-2018-04-16-only' input-file: -- microsoft.insights/stable/2018-04-16/scheduledQueryRule_API.json +- Microsoft.Insights/stable/2018-04-16/scheduledQueryRule_API.json ``` ### Tag: package-2015-04-01-only @@ -211,11 +211,11 @@ These settings apply only when `--tag=package-2015-04-01-only` is specified on t ``` yaml $(tag) == 'package-2015-04-01-only' input-file: -- microsoft.insights/stable/2015-04-01/activityLogs_API.json -- microsoft.insights/stable/2015-04-01/autoscale_API.json -- microsoft.insights/stable/2015-04-01/eventCategories_API.json -- microsoft.insights/stable/2015-04-01/operations_API.json -- microsoft.insights/stable/2015-04-01/tenantActivityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/activityLogs_API.json +- Microsoft.Insights/stable/2015-04-01/autoscale_API.json +- Microsoft.Insights/stable/2015-04-01/eventCategories_API.json +- Microsoft.Insights/stable/2015-04-01/operations_API.json +- Microsoft.Insights/stable/2015-04-01/tenantActivityLogs_API.json ``` ### Tag: package-2016-03-01-only @@ -224,10 +224,10 @@ These settings apply only when `--tag=package-2016-03-01-only` is specified on t ``` yaml $(tag) == 'package-2016-03-01-only' input-file: -- microsoft.insights/stable/2016-03-01/alertRules_API.json -- microsoft.insights/stable/2016-03-01/alertRulesIncidents_API.json -- microsoft.insights/stable/2016-03-01/logProfiles_API.json -- microsoft.insights/stable/2016-03-01/metricDefinitions_API.json +- Microsoft.Insights/stable/2016-03-01/alertRules_API.json +- Microsoft.Insights/stable/2016-03-01/alertRulesIncidents_API.json +- Microsoft.Insights/stable/2016-03-01/logProfiles_API.json +- Microsoft.Insights/stable/2016-03-01/metricDefinitions_API.json ``` ### Tag: package-2016-09-01-only @@ -236,8 +236,8 @@ These settings apply only when `--tag=package-2016-09-01-only` is specified on t ``` yaml $(tag) == 'package-2016-09-01-only' input-file: -- microsoft.insights/stable/2016-09-01/metrics_API.json -- microsoft.insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json +- Microsoft.Insights/stable/2016-09-01/metrics_API.json +- Microsoft.Insights/stable/2016-09-01/serviceDiagnosticsSettings_API.json ``` ### Tag: package-2017-04-01-only @@ -246,8 +246,8 @@ These settings apply only when `--tag=package-2017-04-01-only` is specified on t ``` yaml $(tag) == 'package-2017-04-01-only' input-file: -- microsoft.insights/stable/2017-04-01/actionGroups_API.json -- microsoft.insights/stable/2017-04-01/activityLogAlerts_API.json +- Microsoft.Insights/stable/2017-04-01/actionGroups_API.json +- Microsoft.Insights/stable/2017-04-01/activityLogAlerts_API.json ``` ### Tag: package-2017-05-01-preview-only @@ -256,10 +256,10 @@ These settings apply only when `--tag=package-2017-05-01-preview-only` is specif ``` yaml $(tag) == 'package-2017-05-01-preview-only' input-file: -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettings_API.json -- microsoft.insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json -- microsoft.insights/preview/2017-05-01-preview/metricDefinitions_API.json -- microsoft.insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json +- Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json +- Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json ``` ### Tag: package-2017-11-01-preview-only @@ -268,8 +268,8 @@ These settings apply only when `--tag=package-2017-11-01-preview-only` is specif ``` yaml $(tag) == 'package-2017-11-01-preview-only' input-file: -- microsoft.insights/preview/2017-11-01-preview/baseline_API.json -- microsoft.insights/preview/2017-11-01-preview/calculateBaseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/baseline_API.json +- Microsoft.Insights/preview/2017-11-01-preview/calculateBaseline_API.json ``` --- From 059f3c14c00605e567ed2d0fce985125736376e1 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:10:56 -0500 Subject: [PATCH 417/464] chore: Move Microsoft.StorageSync\2017-06-05-preview (#4800) Other preview API is under the preview folder. This matches the structure of other APIs --- .../examples/CloudEndpoints_Create.json | 104 +- .../examples/CloudEndpoints_Delete.json | 58 +- .../examples/CloudEndpoints_Get.json | 66 +- .../CloudEndpoints_ListBySyncGroup.json | 0 .../examples/CloudEndpoints_PostBackup.json | 0 .../examples/CloudEndpoints_PostRestore.json | 0 .../examples/CloudEndpoints_PreBackup.json | 0 .../examples/CloudEndpoints_PreRestore.json | 0 .../CloudEndpoints_RestoreHeatbeat.json | 0 .../examples/Operations_List.json | 0 .../examples/RegisteredServers_Create.json | 112 +- .../examples/RegisteredServers_Delete.json | 56 +- .../examples/RegisteredServers_Get.json | 68 +- ...teredServers_ListByStorageSyncService.json | 0 .../examples/ServerEndpoints_Create.json | 104 +- .../examples/ServerEndpoints_Delete.json | 52 +- .../examples/ServerEndpoints_Get.json | 84 +- .../ServerEndpoints_ListBySyncGroup.json | 0 .../examples/ServerEndpoints_Recall.json | 0 .../examples/ServerEndpoints_Update.json | 100 +- .../examples/StorageSyncServices_Create.json | 52 +- .../examples/StorageSyncServices_Delete.json | 26 +- .../examples/StorageSyncServices_Get.json | 54 +- ...orageSyncServices_ListByResourceGroup.json | 0 ...torageSyncServices_ListBySubscription.json | 0 .../examples/StorageSyncServices_Update.json | 64 +- .../examples/SyncGroups_Create.json | 52 +- .../examples/SyncGroups_Delete.json | 36 +- .../examples/SyncGroups_Get.json | 50 +- .../SyncGroups_ListByStorageSyncService.json | 0 .../examples/Workflows_Abort.json | 0 .../examples/Workflows_Get.json | 56 +- .../2017-06-05-preview/storagesync.json | 6474 ++++++++--------- .../storagesync/resource-manager/readme.md | 2 +- 34 files changed, 3835 insertions(+), 3835 deletions(-) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_Create.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_Delete.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_Get.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/Operations_List.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/RegisteredServers_Create.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/RegisteredServers_Delete.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/RegisteredServers_Get.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_Create.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_Delete.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_Get.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_Recall.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/ServerEndpoints_Update.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_Create.json (97%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_Delete.json (96%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_Get.json (97%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/StorageSyncServices_Update.json (97%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/SyncGroups_Create.json (97%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/SyncGroups_Delete.json (96%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/SyncGroups_Get.json (97%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/Workflows_Abort.json (100%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/examples/Workflows_Get.json (98%) rename specification/storagesync/resource-manager/Microsoft.StorageSync/{ => preview}/2017-06-05-preview/storagesync.json (96%) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Create.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Create.json index aa40e989b56d..a0b6154a71e1 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Create.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview", - "parameters": { - "properties": { - "provisioningState": "Created", - "storageAccountKey": "storageaccountkeyvalue", - "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", - "storageAccountResourceId": "", - "storageAccountShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleCloudEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "friendlyName": "ankushbsubscriptionmgmtmab", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/cloudEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": { + "provisioningState": "Created", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleCloudEndpoint", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"" + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccount": "https://storageaccounturl/ankushbsubscriptionmgmtmab", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "friendlyName": "ankushbsubscriptionmgmtmab", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/6fe524cf-5944-4e87-816f-e4a85a1f3533", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8RjhDODcwQTItMkFGNi00NDUyLTgzMDgtRjJCQTZEQjI3RkEwfEdFTkVSSUN8NTJCOERBMkYtNjFFMC00QTFGLThEREUtMzM2OTExRjM2N0ZC" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/cloudEndpoints/SampleCloudEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/cloudEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operations/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncservice_1/workflows/c1d54be7-4738-4898-8212-cc36774314f8/operationresults/7ce689b2-0eca-48f5-86f0-0b8d6ceef14a?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Delete.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Delete.json index 928e1f985f9d..b5ccf6fdd067 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Delete.json @@ -1,30 +1,30 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operations/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/78a71465-77ef-4509-a026-2c0cd8b30208/operationresults/2d7f573a-7acd-4a3c-9425-fed7d029c69d?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Get.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Get.json index ed74fda28ebb..552b04fb22ee 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_Get.json @@ -1,34 +1,34 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleCloudEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "storageAccountKey": "storageaccountkeyvalue", - "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", - "storageAccountResourceId": "", - "storageAccountShareName": "", - "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", - "friendlyName": "SampleAzureFileShareName_1", - "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleCloudEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "storageAccountKey": "storageaccountkeyvalue", + "storageAccount": "https://storageaccounturl/SampleAzureFileShareName_1", + "storageAccountResourceId": "", + "storageAccountShareName": "", + "storageAccountTenantId": "\"a4d1b191-c1af-4cef-a14b-f670e0beea52\"", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/a377fdd5-949a-40ab-9629-06cd0e9852f9", + "friendlyName": "SampleAzureFileShareName_1", + "partnershipId": "1|U0VSVkVSQVNTWU5DQ0xJRU5USEZTVjJ8MTkxNjYwQ0QtNkExQS00RjhDLTk3ODctQTZCRUQyMDZBMUREfEdFTkVSSUN8M0EwNDgyODMtMzM4Ri00MDAyLUE5REQtQTUwRkRBRENCMzky" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/cloudEndpoints/CEP_Restore_08-08_Test112", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/cloudEndpoints" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_ListBySyncGroup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PostBackup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PostRestore.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PreBackup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_PreRestore.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/CloudEndpoints_RestoreHeatbeat.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Operations_List.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Operations_List.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Operations_List.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Operations_List.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Create.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Create.json index ad6a75deedb6..66b144ae5a56 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Create.json @@ -1,56 +1,56 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", - "parameters": { - "name": "SampleServer-prod3.redmond.corp.microsoft.com", - "properties": { - "serverRole": "Standalone", - "provisioningState": "Created", - "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", - "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.277.0" - }, - "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "type": "10.91.86.47/storageSyncServices/registeredServers", - "name": "ankushb-prod3.redmond.corp.microsoft.com", - "properties": { - "serverId": "\"530a0384-50ac-456d-8240-9d6621404151\"", - "serverRole": "Standalone", - "provisioningState": "Succeeded", - "clusterId": "\"00000000-0000-0000-0000-000000000000\"", - "lastHeartBeat": "\"2017-08-21T13:24:18.2641509-07:00\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.278.0", - "storageSyncServiceUid": "\"56cfb290-f846-4c96-abc4-ee338bd252e8\"", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/c36c3bcb-a72e-492a-b700-4ad74a8e3d69" - } - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "parameters": { + "name": "SampleServer-prod3.redmond.corp.microsoft.com", + "properties": { + "serverRole": "Standalone", + "provisioningState": "Created", + "serverCertificate": "\"MIIDFjCCAf6gAwIBAgIQQS+DS8uhc4VNzUkTw7wbRjANBgkqhkiG9w0BAQ0FADAzMTEwLwYDVQQDEyhhbmt1c2hiLXByb2QzLnJlZG1vbmQuY29ycC5taWNyb3NvZnQuY29tMB4XDTE3MDgwMzE3MDQyNFoXDTE4MDgwNDE3MDQyNFowMzExMC8GA1UEAxMoYW5rdXNoYi1wcm9kMy5yZWRtb25kLmNvcnAubWljcm9zb2Z0LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALDRvV4gmsIy6jGDPiHsXmvgVP749NNP7DopdlbHaNhjFmYINHl0uWylyaZmgJrROt2mnxN/zEyJtGnqYHlzUr4xvGq/qV5pqgdB9tag/sw9i22gfe9PRZ0FmSOZnXMbLYgLiDFqLtut5gHcOuWMj03YnkfoBEKlFBxWbagvW2yxz/Sxi9OVSJOKCaXra0RpcIHrO/KFl6ho2eE1/7Ykmfa8hZvSdoPd5gHdLiQcMB/pxq+mWp1fI6c8vFZoDu7Atn+NXTzYPKUxKzaisF12TsaKpohUsJpbB3Wocb0F5frn614D2pg14ERB5otjAMWw1m65csQWPI6dP8KIYe0+QPkCAwEAAaMmMCQwIgYDVR0lAQH/BBgwFgYIKwYBBQUHAwIGCisGAQQBgjcKAwwwDQYJKoZIhvcNAQENBQADggEBAA4RhVIBkw34M1RwakJgHvtjsOFxF1tVQA941NtLokx1l2Z8+GFQkcG4xpZSt+UN6wLerdCbnNhtkCErWUDeaT0jxk4g71Ofex7iM04crT4iHJr8mi96/XnhnkTUs+GDk12VgdeeNEczMZz+8Mxw9dJ5NCnYgTwO0SzGlclRsDvjzkLo8rh2ZG6n/jKrEyNXXo+hOqhupij0QbRP2Tvexdfw201kgN1jdZify8XzJ8Oi0bTS0KpJf2pNPOlooK2bjMUei9ANtEdXwwfVZGWvVh6tJjdv6k14wWWJ1L7zhA1IIVb1J+sQUzJji5iX0DrezjTz1Fg+gAzITaA/WsuujlM=\"", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652Z\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0" + }, + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "type": "10.91.86.47/storageSyncServices/registeredServers", + "name": "ankushb-prod3.redmond.corp.microsoft.com", + "properties": { + "serverId": "\"530a0384-50ac-456d-8240-9d6621404151\"", + "serverRole": "Standalone", + "provisioningState": "Succeeded", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "lastHeartBeat": "\"2017-08-21T13:24:18.2641509-07:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.278.0", + "storageSyncServiceUid": "\"56cfb290-f846-4c96-abc4-ee338bd252e8\"", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/c36c3bcb-a72e-492a-b700-4ad74a8e3d69" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operations/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/63e554fd-4d27-4b91-8249-2fc697de7c69/operationresults/d4b00aa1-7ae0-47f0-9fa7-7ed3ea527bc9?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Delete.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Delete.json index dcc4d32ee75d..77ed370cdf85 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Delete.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "41166691-ab03-43e9-ab3e-0330eda162ac", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operations/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/cdb963fd-ea36-457e-9222-f85754ff398c/operationresults/20675646-8111-4158-954b-6b637e922cbf?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Get.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Get.json index ab6410ba74e3..66239532fab2 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_Get.json @@ -1,35 +1,35 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", - "properties": { - "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", - "serverRole": "Standalone", - "provisioningState": "Created", - "clusterId": "\"00000000-0000-0000-0000-000000000000\"", - "clusterName": "", - "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", - "serverManagementtErrorCode": 0, - "serverOSVersion": "10.0.14393.0", - "agentVersion": "1.0.277.0", - "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", - "lastWorkflowId": "" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "serverId": "080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleRegisteredServer_1.redmond.corp.microsoft.com", + "properties": { + "serverId": "\"080d4133-bdb5-40a0-96a0-71a6057bfe9a\"", + "serverRole": "Standalone", + "provisioningState": "Created", + "clusterId": "\"00000000-0000-0000-0000-000000000000\"", + "clusterName": "", + "lastHeartBeat": "\"2017-08-08T18:29:06.470652+00:00\"", + "serverManagementtErrorCode": 0, + "serverOSVersion": "10.0.14393.0", + "agentVersion": "1.0.277.0", + "storageSyncServiceUid": "\"3d1bf292-0f2a-4cc1-a3e1-60f35800e40c\"", + "lastWorkflowId": "" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "type": "Microsoft.StorageSync/storageSyncServices/registeredServers" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/RegisteredServers_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Create.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Create.json index 75cd89e9b722..5010aaf781d2 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Create.json @@ -1,52 +1,52 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "serverEndpointName": "SampleServerEndpoint_1", - "parameters": { - "properties": { - "provisioningState": "Created", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "cloudTiering": "off", - "volumeFreeSpacePercent": 100 - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters": { + "properties": { + "provisioningState": "Created", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncServer_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operations/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75/operationresults/fe680c98-5725-49c8-b0dc-5e29745f752b?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Delete.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Delete.json index 7c9a14e729c0..a56776d040c6 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Delete.json @@ -1,27 +1,27 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operations/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/9122d971-147b-4dba-bada-1ceb7c9311e5/operationresults/6dce076b-1df5-4449-829b-69b24f38b5a1?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Get.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Get.json index d4afef4a2dfc..3d53b79d8267 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Get.json @@ -1,43 +1,43 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", - "friendlyName": "SampleRegisteredServer-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", - "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", - "syncErrorState": "0", - "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", - "syncErrorDirection": "none", - "syncErrorContext": "", - "itemDownloadErrorCount": 0, - "itemUploadErrorCount": 0, - "currentProgressType": "none", - "itemProgressCount": 0, - "itemTotalCount": 0, - "byteProgress": 0 - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/registeredServers/080d4133-bdb5-40a0-96a0-71a6057bfe9a", + "friendlyName": "SampleRegisteredServer-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/219c62f3-8507-4b87-a85b-ac676ad198d1", + "lastSyncSuccess": "2017-02-24T22:24:43.3216408Z", + "syncErrorState": "0", + "syncErrorStateTimestamp": "2017-02-24T22:24:43.3216408Z", + "syncErrorDirection": "none", + "syncErrorContext": "", + "itemDownloadErrorCount": 0, + "itemUploadErrorCount": 0, + "currentProgressType": "none", + "itemProgressCount": 0, + "itemTotalCount": 0, + "byteProgress": 0 + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SyncGroup_Restore_08-08_Test112/serverEndpoints/SampleServerEndpoint_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_ListBySyncGroup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Recall.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Recall.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Recall.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Recall.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Update.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Update.json index 21baf9772497..9d0e6b47f5b6 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/ServerEndpoints_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/ServerEndpoints_Update.json @@ -1,50 +1,50 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "cloudEndpointName": "SampleCloudEndpoint_1", - "syncGroupName": "SampleSyncGroup_1", - "serverEndpointName": "SampleServerEndpoint_1", - "parameters" : { - "properties": { - "provisioningState": "Created", - "cloudTiering": "off", - "volumeFreeSpacePercent": 100 - }, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleServerEndpoint_1", - "properties": { - "provisioningState": "Succeeded", - "serverLocalPath": "D:\\SampleServerEndpoint_1", - "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", - "cloudTiering": "off", - "volumeFreeSpacePercent": 20, - "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", - "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" - }, - "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", - "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" - } - }, - "202": { - "headers": { - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", - "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", - "Retry-After": "10", - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "cloudEndpointName": "SampleCloudEndpoint_1", + "syncGroupName": "SampleSyncGroup_1", + "serverEndpointName": "SampleServerEndpoint_1", + "parameters" : { + "properties": { + "provisioningState": "Created", + "cloudTiering": "off", + "volumeFreeSpacePercent": 100 + }, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups/serverEndpoints" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleServerEndpoint_1", + "properties": { + "provisioningState": "Succeeded", + "serverLocalPath": "D:\\SampleServerEndpoint_1", + "serverResourceId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/registeredServers/530a0384-50ac-456d-8240-9d6621404151", + "cloudTiering": "off", + "volumeFreeSpacePercent": 20, + "friendlyName": "ankushb-prod3.redmond.corp.microsoft.com", + "lastWorkflowId": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/workflows/901054e8-d66f-4e2f-8266-f05a68dbfce4" + }, + "id": "/subscriptions/52b8da2f-61e0-4a1f-8dde-336911f367fb/resourceGroups/SampleResourceGroup_1/providers/10.91.86.47/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1/serverEndpoints/SampleServerEndpoint_1", + "type": "10.91.86.47/storageSyncServices/syncGroups/serverEndpoints" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operations/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", + "Location": "https://management.azure.com/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Swagger_08-09_Test212/workflows/3af798a9-26fd-44e7-a121-a4ad65f451bd/operationresults/ef2a30f4-9bb8-40e7-b403-5d6d3dc67a3c?api-version=2017-06-05-preview", + "Retry-After": "10", + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Create.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Create.json index 31429cb7d7ce..7fb1b01e89ff 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Create.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "parameters": { - "location": "WestUS", - "tags": {}, - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices" - }, - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": {}, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "parameters": { + "location": "WestUS", + "tags": {}, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + }, + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": {}, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Delete.json similarity index 96% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Delete.json index 26001b6c507a..445b5af000e0 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Delete.json @@ -1,14 +1,14 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - }, - "204": { - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Get.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Get.json index aa243d6bfe67..d0e22bc81ebe 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Get.json @@ -1,28 +1,28 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": {}, - "properties": { - "storageSyncServiceStatus": 0, - "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": {}, + "properties": { + "storageSyncServiceStatus": 0, + "storageSyncServiceUid": "\"2de01144-72da-4d7f-9d0c-e858855114a8\"" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_ListByResourceGroup.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_ListBySubscription.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Update.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Update.json index a930e70b6d43..b0a22de445fe 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/StorageSyncServices_Update.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/StorageSyncServices_Update.json @@ -1,32 +1,32 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "api-version": "2017-06-05-preview", - "parameters": { - "location": "WestUS", - "tags": { - "Environment": "Test", - "Dept": "IT" - }, - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices" - } - }, - "responses": { - "200": { - "body": { - "name": "SampleStorageSyncService_1", - "location": "WestUS", - "tags": { - "Environment": "Test", - "Dept": "IT" - }, - "properties": {}, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", - "type": "Microsoft.StorageSync/storageSyncServices" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "api-version": "2017-06-05-preview", + "parameters": { + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices" + } + }, + "responses": { + "200": { + "body": { + "name": "SampleStorageSyncService_1", + "location": "WestUS", + "tags": { + "Environment": "Test", + "Dept": "IT" + }, + "properties": {}, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1", + "type": "Microsoft.StorageSync/storageSyncServices" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Create.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Create.json index ccad6278ba86..b5272fd3a976 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Create.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Create.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview", - "parameters": { - "properties": {}, - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - - }, - "responses": { - "200": { - "body": { - "name": "SampleSyncGroup_1", - "properties": { - "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - } - } -} +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview", + "parameters": { + "properties": {}, + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + + }, + "responses": { + "200": { + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "7868e4ee-8ddd-4a2d-941b-0041f6052a8a" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } +} diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Delete.json similarity index 96% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Delete.json index f4db86a29658..c6979666be76 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Delete.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Delete.json @@ -1,19 +1,19 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - } - }, - "204": { - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + } + }, + "204": { + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Get.json similarity index 97% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Get.json index 3acf7719e43d..dc72917fb604 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_Get.json @@ -1,26 +1,26 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "syncGroupName": "SampleSyncGroup_1", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "SampleSyncGroup_1", - "properties": { - "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", - "syncGroupStatus": "0" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", - "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "syncGroupName": "SampleSyncGroup_1", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "SampleSyncGroup_1", + "properties": { + "uniqueId": "191660cd-6a1a-4f8c-9787-a6bed206a1dd", + "syncGroupStatus": "0" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SSS_Restore_08-08_Test112/syncGroups/SampleSyncGroup_1", + "type": "Microsoft.StorageSync/storageSyncServices/syncGroups" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/SyncGroups_ListByStorageSyncService.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Abort.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Workflows_Abort.json similarity index 100% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Abort.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Workflows_Abort.json diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Workflows_Get.json similarity index 98% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Workflows_Get.json index 2cc2213d9548..939c2b0200a7 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/examples/Workflows_Get.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/examples/Workflows_Get.json @@ -1,29 +1,29 @@ -{ - "parameters": { - "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", - "resourceGroupName": "SampleResourceGroup_1", - "storageSyncServiceName": "SampleStorageSyncService_1", - "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", - "api-version": "2017-06-05-preview" - }, - "responses": { - "200": { - "headers": { - "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", - "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" - }, - "body": { - "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", - "properties": { - "status": "succeeded", - "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", - "operation": "do", - "lastStepName": "runServerJob", - "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" - }, - "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", - "type": "Microsoft.StorageSync/storageSyncServices/workflows" - } - } - } +{ + "parameters": { + "subscriptionId": "52b8da2f-61e0-4a1f-8dde-336911f367fb", + "resourceGroupName": "SampleResourceGroup_1", + "storageSyncServiceName": "SampleStorageSyncService_1", + "workflowId": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "api-version": "2017-06-05-preview" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "74e55a4d-1c6f-46de-9a8d-278e53a47403", + "x-ms-correlation-request-id": "d166ca76-dad2-49df-b409-d2acfd42d730" + }, + "body": { + "name": "828219ea-083e-48b5-89ea-8fd9991b2e75", + "properties": { + "status": "succeeded", + "lastOperationId": "\"fe680c98-5725-49c8-b0dc-5e29745f752b\"", + "operation": "do", + "lastStepName": "runServerJob", + "steps": "[{\"name\":\"validateInput\",\"friendlyName\":\"validateInput\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"newServerEndpoint\",\"friendlyName\":\"newServerEndpoint\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"updateReplicaGroupCertificates\",\"friendlyName\":\"updateReplicaGroupCertificates\",\"status\":\"Succeeded\",\"error\":null},{\"name\":\"runServerJob\",\"friendlyName\":\"runServerJob\",\"status\":\"Succeeded\",\"error\":null}]" + }, + "id": "/subscriptions/3a048283-338f-4002-a9dd-a50fdadcb392/resourceGroups/SampleResourceGroup_1/providers/Microsoft.StorageSync/storageSyncServices/SampleStorageSyncService_1/workflows/828219ea-083e-48b5-89ea-8fd9991b2e75", + "type": "Microsoft.StorageSync/storageSyncServices/workflows" + } + } + } } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json similarity index 96% rename from specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json rename to specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json index cf1728014480..636ed62c765d 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/2017-06-05-preview/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json @@ -1,3238 +1,3238 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft Storage Sync", - "description": "Microsoft Storage Sync Service API", - "version": "2017-06-05-preview", - "x-ms-code-generation-settings": { - "name": "StorageSyncManagementClient" - } - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.StorageSync/operations": { - "get": { - "tags": [ - "ResourceProvider", - "Operations" - ], - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "description": "Lists all of the available Storage Sync Rest API operations.", - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "responses": { - "200": { - "description": "Array of operations resources in the Resource Provider", - "schema": { - "$ref": "#/definitions/OperationEntityListResult" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "deprecated": false, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Storage Sync Service resource name.", - "required": true, - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Create", - "description": "Create a new StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Create": { - "$ref": "./examples/StorageSyncServices_Create.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object created/updated", - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Get", - "description": "Get a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Get": { - "$ref": "./examples/StorageSyncServices_Get.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object", - "schema": { - "$ref": "#/definitions/StorageSyncService" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "patch": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Storage Sync Service resource.", - "schema": { - "$ref": "#/definitions/StorageSyncService" - } - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Update", - "description": "Patch a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Update": { - "$ref": "./examples/StorageSyncServices_Update.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object created/updated", - "schema": { - "$ref": "#/definitions/StorageSyncService" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_Delete", - "description": "Delete a given StorageSyncService.", - "x-ms-examples": { - "StorageSyncServices_Delete": { - "$ref": "./examples/StorageSyncServices_Delete.json" - } - }, - "responses": { - "200": { - "description": "Storage Sync Service object was deleted.", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "204": { - "description": "Storage Sync Service Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_ListByResourceGroup", - "description": "Get a StorageSyncService list by Resource group name.", - "x-ms-examples": { - "StorageSyncServices_ListByResourceGroup": { - "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of registered Storage Sync Service resources in the Resource Group", - "schema": { - "$ref": "#/definitions/StorageSyncServiceArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "tags": [ - "StorageSyncServices Resource" - ], - "operationId": "StorageSyncServices_ListBySubscription", - "description": "Get a StorageSyncService list by subscription.", - "x-ms-examples": { - "StorageSyncServices_ListBySubscription": { - "$ref": "./examples/StorageSyncServices_ListBySubscription.json" - } - }, - "responses": { - "200": { - "description": "Array of registered Storage Sync Service resources in the subscription.", - "schema": { - "$ref": "#/definitions/StorageSyncServiceArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_ListByStorageSyncService", - "description": "Get a SyncGroup List.", - "x-ms-examples": { - "SyncGroups_ListByStorageSyncService": { - "$ref": "./examples/SyncGroups_ListByStorageSyncService.json" - } - }, - "responses": { - "200": { - "description": "Array of Sync Group resources in Storage Sync Service", - "schema": { - "$ref": "#/definitions/SyncGroupArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Sync Group Body", - "required": true, - "schema": { - "$ref": "#/definitions/SyncGroup" - } - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Create", - "description": "Create a new SyncGroup.", - "x-ms-examples": { - "SyncGroups_Create": { - "$ref": "./examples/SyncGroups_Create.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object", - "schema": { - "$ref": "#/definitions/SyncGroup" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Get", - "description": "Get a given SyncGroup.", - "x-ms-examples": { - "SyncGroups_Get": { - "$ref": "./examples/SyncGroups_Get.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object", - "schema": { - "$ref": "#/definitions/SyncGroup" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "SyncGroup Resource" - ], - "operationId": "SyncGroups_Delete", - "description": "Delete a given SyncGroup.", - "x-ms-examples": { - "SyncGroups_Delete": { - "$ref": "./examples/SyncGroups_Delete.json" - } - }, - "responses": { - "200": { - "description": "Sync Group object was deleted", - "headers": { - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint resource.", - "required": true, - "schema": { - "$ref": "#/definitions/CloudEndpoint" - } - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Create", - "description": "Create a new CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Create": { - "$ref": "./examples/CloudEndpoints_Create.json" - } - }, - "responses": { - "200": { - "description": "Cloud Endpoint object", - "schema": { - "$ref": "#/definitions/CloudEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Retry-After": { - "description": "Retry After", - "type": "string" - }, - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Get", - "description": "Get a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Get": { - "$ref": "./examples/CloudEndpoints_Get.json" - } - }, - "responses": { - "200": { - "description": "Cloud Endpoint object", - "schema": { - "$ref": "#/definitions/CloudEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_Delete", - "description": "Delete a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_Delete": { - "$ref": "./examples/CloudEndpoints_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Retry-After": { - "description": "Retry After", - "type": "string" - }, - "x-ms-request-id": { - "description": "Request id", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource" - ], - "operationId": "CloudEndpoints_ListBySyncGroup", - "description": "Get a CloudEndpoint List.", - "x-ms-examples": { - "CloudEndpoints_ListBySyncGroup": { - "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of Cloud Endpoint resources in Sync Group", - "schema": { - "$ref": "#/definitions/CloudEndpointArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Backup request.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PreBackup", - "description": "Pre Backup a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PreBackup": { - "$ref": "./examples/CloudEndpoints_PreBackup.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Backup request.", - "required": true, - "schema": { - "$ref": "#/definitions/BackupRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PostBackup", - "description": "Post Backup a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PostBackup": { - "$ref": "./examples/CloudEndpoints_PostBackup.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/PostBackupResponse" - }, - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/PreRestoreRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PreRestore", - "description": "Pre Restore a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PreRestore": { - "$ref": "./examples/CloudEndpoints_PreRestore.json" - } - }, - "responses": { - "200": { - "description": "Ok" - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_RestoreHeatbeat", - "description": "Restore Heartbeat a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_RestoreHeatbeat": { - "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json" - } - }, - "responses": { - "200": { - "description": "Restore Heartbeat Operation has ran successfully.", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "cloudEndpointName", - "in": "path", - "description": "Name of Cloud Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Cloud Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/PostRestoreRequest" - } - } - ], - "tags": [ - "CloudEndpoint Resource", - "Actions", - "Backup Restore" - ], - "operationId": "CloudEndpoints_PostRestore", - "description": "Post Restore a given CloudEndpoint.", - "x-ms-examples": { - "CloudEndpoints_PostRestore": { - "$ref": "./examples/CloudEndpoints_PostRestore.json" - } - }, - "responses": { - "200": { - "description": "Ok" - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": { - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Server Endpoint object.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerEndpoint" - } - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Create", - "description": "Create a new ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Create": { - "$ref": "./examples/ServerEndpoints_Create.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Any of the properties applicable in PUT request.", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - } - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Update", - "description": "Patch a given ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Update": { - "$ref": "./examples/ServerEndpoints_Update.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Get", - "description": "Get a ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Get": { - "$ref": "./examples/ServerEndpoints_Get.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "schema": { - "$ref": "#/definitions/ServerEndpoint" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_Delete", - "description": "Delete a given ServerEndpoint.", - "x-ms-examples": { - "ServerEndpoints_Delete": { - "$ref": "./examples/ServerEndpoints_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource" - ], - "operationId": "ServerEndpoints_ListBySyncGroup", - "description": "Get a ServerEndpoint list.", - "x-ms-examples": { - "ServerEndpoints_ListBySyncGroup": { - "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json" - } - }, - "responses": { - "200": { - "description": "Array of Server Endpoint resources in Sync Group", - "schema": { - "$ref": "#/definitions/ServerEndpointArray" - }, - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "syncGroupName", - "in": "path", - "description": "Name of Sync Group resource.", - "required": true, - "type": "string" - }, - { - "name": "serverEndpointName", - "in": "path", - "description": "Name of Server Endpoint object.", - "required": true, - "type": "string" - } - ], - "tags": [ - "ServerEndpoint Resource", - "Actions" - ], - "operationId": "ServerEndpoints_Recall", - "description": "Recall a server endpoint.", - "x-ms-examples": { - "ServerEndpoints_Recall": { - "$ref": "./examples/ServerEndpoints_Recall.json" - } - }, - "responses": { - "200": { - "description": "Server Endpoint object", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_ListByStorageSyncService", - "description": "Get a given registered server list.", - "x-ms-examples": { - "RegisteredServers_ListByStorageSyncService": { - "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json" - } - }, - "responses": { - "200": { - "description": "Array of Registered Server resources in Storage Sync Service", - "schema": { - "$ref": "#/definitions/RegisteredServerArray" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Get", - "description": "Get a given registered server.", - "x-ms-examples": { - "RegisteredServers_Get": { - "$ref": "./examples/RegisteredServers_Get.json" - } - }, - "responses": { - "200": { - "description": "Registered Server resources in Sync Group", - "schema": { - "$ref": "#/definitions/RegisteredServer" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - }, - "put": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - }, - { - "name": "parameters", - "in": "body", - "description": "Body of Registered Server object.", - "required": true, - "schema": { - "$ref": "#/definitions/RegisteredServer" - } - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Create", - "description": "Add a new registered server.", - "x-ms-examples": { - "RegisteredServers_Create": { - "$ref": "./examples/RegisteredServers_Create.json" - } - }, - "responses": { - "200": { - "description": "Registered Server resources in Sync Group", - "schema": { - "$ref": "#/definitions/RegisteredServer" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Azure-AsyncOperation": { - "description": "Operation Status Location URI", - "type": "string" - }, - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "serverId", - "in": "path", - "description": "GUID identifying the on-premises server.", - "required": true, - "type": "string" - } - ], - "tags": [ - "RegisteredServer Resource" - ], - "operationId": "RegisteredServers_Delete", - "description": "Delete the given registered server.", - "x-ms-examples": { - "RegisteredServers_Delete": { - "$ref": "./examples/RegisteredServers_Delete.json" - } - }, - "responses": { - "200": { - "description": "Ok", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "202": { - "description": "Asynchronous Operation Status Location", - "headers": { - "Location": { - "description": "Operation Status Location URI", - "type": "string" - }, - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "204": { - "description": "Resource doesn't exist" - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": { - "get": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "workflowId", - "in": "path", - "description": "workflow Id", - "required": true, - "type": "string" - } - ], - "tags": [ - "Workflow Resource" - ], - "operationId": "Workflows_Get", - "description": "Get Workflows resource", - "x-ms-examples": { - "Workflows_Get": { - "$ref": "./examples/Workflows_Get.json" - } - }, - "responses": { - "200": { - "description": "Workflow object", - "schema": { - "$ref": "#/definitions/Workflow" - }, - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": { - "post": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "name": "storageSyncServiceName", - "in": "path", - "description": "Name of Storage Sync Service resource.", - "required": true, - "type": "string" - }, - { - "name": "workflowId", - "in": "path", - "description": "workflow Id", - "required": true, - "type": "string" - } - ], - "tags": [ - "Workflow Resource", - "Actions" - ], - "operationId": "Workflows_Abort", - "description": "Abort the given workflow.", - "x-ms-examples": { - "Workflows_Abort": { - "$ref": "./examples/Workflows_Abort.json" - } - }, - "responses": { - "200": { - "description": "success", - "headers": { - "x-ms-request-id": { - "description": "request id.", - "type": "string" - }, - "x-ms-correlation-request-id": { - "description": "correlation request id.", - "type": "string" - } - } - }, - "default": { - "description": "Error message indicating why the operation failed.", - "schema": { - "$ref": "#/definitions/StorageSyncError" - } - } - } - } - } - }, - "definitions": { - "StorageSyncError": { - "type": "object", - "description": "Error type", - "properties": { - "code": { - "type": "string", - "description": "Error code of the given entry." - }, - "message": { - "type": "string", - "description": "Error message of the given entry." - }, - "details": { - "$ref": "#/definitions/StorageSyncErrorDetails", - "description": "Error details of the given entry." - } - } - }, - "StorageSyncErrorDetails": { - "type": "object", - "description": "Error Details object.", - "properties": { - "code": { - "type": "string", - "description": "Error code of the given entry." - }, - "message": { - "type": "string", - "description": "Error message of the given entry." - }, - "target": { - "type": "string", - "description": "Target of the given entry." - } - } - }, - "Resource": { - "description": "The Azure Resource Manager resource.", - "properties": { - "id": { - "description": "The id of the resource.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "The name of the resource.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "The type of the resource", - "readOnly": true, - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "ARM tracked resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "The location of the resource.", - "type": "string" - }, - "tags": { - "description": "The tags of the resource.", - "type": "object" - } - } - }, - "SubscriptionState": { - "type": "object", - "description": "Subscription State object.", - "properties": { - "state": { - "type": "string", - "description": "State of Azure Subscription", - "enum": [ - "Registered", - "Unregistered", - "Warned", - "Suspended", - "Deleted" - ], - "x-ms-enum": { - "name": "Reason", - "modelAsString": true - } - }, - "istransitioning": { - "type": "boolean", - "description": "Is Transitioning", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SubscriptionStateProperties", - "description": "Subscription state properties." - } - } - }, - "StorageSyncService": { - "type": "object", - "description": "Storage Sync Service object.", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/StorageSyncServiceProperties", - "description": "Storage Sync Service properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "SyncGroup": { - "type": "object", - "description": "Sync Group object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/SyncGroupProperties", - "description": "SyncGroup properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "CloudEndpoint": { - "type": "object", - "description": "Cloud Endpoint object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/CloudEndpointProperties", - "description": "Cloud Endpoint properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "ServerEndpoint": { - "type": "object", - "description": "Server Endpoint object.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/ServerEndpointProperties", - "description": "Server Endpoint properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "RegisteredServer": { - "type": "object", - "description": "Registered Server resource.", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/RegisteredServerProperties", - "description": "RegisteredServer properties." - } - }, - "x-ms-azure-resource": true - }, - "ResourcesMoveInfo": { - "type": "object", - "description": "Resource Move Info.", - "properties": { - "targetResourceGroup": { - "type": "string", - "description": "Target resource group." - }, - "resources": { - "type": "array", - "description": "Collection of Resources.", - "items": { - "$ref": "#/definitions/ResourceId" - } - } - } - }, - "Workflow": { - "type": "object", - "description": "Workflow resource.", - "allOf": [ - { - "$ref": "#/definitions/Resource" - }, - { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WorkflowProperties", - "description": "Workflow properties." - } - } - } - ], - "x-ms-azure-resource": true - }, - "OperationEntityListResult": { - "description": "The list of storage sync operations.", - "type": "object", - "properties": { - "nextLink": { - "description": "The link used to get the next page of operations.", - "type": "string" - }, - "value": { - "description": "The list of operations.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationEntity" - } - } - } - }, - "OperationEntity": { - "description": "The operation supported by storage sync.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplayInfo", - "description": "The operation supported by storage sync." - }, - "origin": { - "type": "string", - "description": "The origin." - } - } - }, - "OperationDisplayInfo": { - "description": "The operation supported by storage sync.", - "type": "object", - "properties": { - "description": { - "description": "The description of the operation.", - "type": "string" - }, - "operation": { - "description": "The action that users can perform, based on their permission level.", - "type": "string" - }, - "provider": { - "description": "Service provider: Microsoft StorageSync.", - "type": "string" - }, - "resource": { - "description": "Resource on which the operation is performed.", - "type": "string" - } - } - }, - "OperationDisplayResource": { - "type": "object", - "description": "Operation Display Resource object.", - "properties": { - "provider": { - "type": "string", - "description": "Operation Display Resource Provider." - }, - "resource": { - "type": "string", - "description": "Operation Display Resource." - }, - "operation": { - "type": "string", - "description": "Operation Display Resource Operation." - }, - "description": { - "type": "string", - "description": "Operation Display Resource Description." - } - } - }, - "PostRestoreRequest": { - "type": "object", - "description": "Post Restore Request", - "properties": { - "partition": { - "type": "string", - "description": "Post Restore partition." - }, - "replicaGroup": { - "type": "string", - "description": "Post Restore replica group." - }, - "requestId": { - "type": "string", - "description": "Post Restore request id." - }, - "azureFileShareUri": { - "type": "string", - "description": "Post Restore Azure file share uri." - }, - "status": { - "type": "string", - "description": "Post Restore Azure status." - }, - "sourceAzureFileShareUri": { - "type": "string", - "description": "Post Restore Azure source azure file share uri." - }, - "failedFileList": { - "type": "string", - "description": "Post Restore Azure failed file list." - }, - "restoreFileSpec": { - "type": "array", - "description": "Post Restore restore file spec array.", - "items": { - "$ref": "#/definitions/RestoreFileSpec", - "description": "Post Restore restore file spec items array." - } - } - } - }, - "PreRestoreRequest": { - "type": "object", - "description": "Pre Restore request object.", - "properties": { - "partition": { - "type": "string", - "description": "Pre Restore partition." - }, - "replicaGroup": { - "type": "string", - "description": "Pre Restore replica group." - }, - "requestId": { - "type": "string", - "description": "Pre Restore request id." - }, - "azureFileShareUri": { - "type": "string", - "description": "Pre Restore Azure file share uri." - }, - "status": { - "type": "string", - "description": "Pre Restore Azure status." - }, - "sourceAzureFileShareUri": { - "type": "string", - "description": "Pre Restore Azure source azure file share uri." - }, - "backupMetadataPropertyBag": { - "type": "string", - "description": "Pre Restore backup metadata property bag." - }, - "restoreFileSpec": { - "type": "array", - "description": "Pre Restore restore file spec array.", - "items": { - "$ref": "#/definitions/RestoreFileSpec", - "description": "Pre Restore restore file spec items array." - } - }, - "pauseWaitForSyncDrainTimePeriodInSeconds": { - "type": "integer", - "description": "Pre Restore pause wait for sync drain time period in seconds." - } - } - }, - "BackupRequest": { - "type": "object", - "description": "Backup request", - "properties": { - "azureFileShare": { - "type": "string", - "description": "Azure File Share." - } - } - }, - "PostBackupResponse": { - "type": "object", - "description": "Post Backup Response", - "properties": { - "backupMetadata": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/PostBackupResponseProperties", - "description": "Post Backup Response Properties" - } - } - }, - "RestoreFileSpec": { - "type": "object", - "description": "Restore file spec.", - "properties": { - "path": { - "type": "string", - "description": "Restore file spec path" - }, - "isdir": { - "type": "boolean", - "description": "Restore file spec isdir", - "readOnly": true - } - } - }, - "StorageSyncServiceArray": { - "type": "object", - "description": "Array of StorageSyncServices", - "properties": { - "value": { - "type": "array", - "description": "Collection of StorageSyncServices.", - "items": { - "$ref": "#/definitions/StorageSyncService" - } - } - } - }, - "SyncGroupArray": { - "type": "object", - "description": "Array of SyncGroup", - "properties": { - "value": { - "type": "array", - "description": "Collection of SyncGroup.", - "items": { - "$ref": "#/definitions/SyncGroup" - } - } - } - }, - "CloudEndpointArray": { - "type": "object", - "description": "Array of CloudEndpoint", - "properties": { - "value": { - "type": "array", - "description": "Collection of CloudEndpoint.", - "items": { - "$ref": "#/definitions/CloudEndpoint" - } - } - } - }, - "ServerEndpointArray": { - "description": "Array of ServerEndpoint", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of ServerEndpoint.", - "items": { - "$ref": "#/definitions/ServerEndpoint" - } - } - } - }, - "RegisteredServerArray": { - "description": "Array of RegisteredServer", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of Registered Server.", - "items": { - "$ref": "#/definitions/RegisteredServer" - } - } - } - }, - "WorkflowArray": { - "description": "Array of Workflow", - "type": "object", - "properties": { - "value": { - "type": "array", - "description": "Collection of workflow items.", - "items": { - "$ref": "#/definitions/Workflow" - } - } - } - }, - "SubscriptionStateProperties": { - "type": "object", - "description": "Subscription State properties." - }, - "PostBackupResponseProperties": { - "type": "object", - "description": "Post Backup Response Properties object.", - "properties": { - "cloudEndpointName": { - "type": "string", - "description": "cloud endpoint Name.", - "readOnly": true - } - } - }, - "StorageSyncServiceProperties": { - "type": "object", - "description": "Storage Sync Service Properties object.", - "properties": { - "storageSyncServiceStatus": { - "type": "integer", - "description": "Storage Sync service status.", - "readOnly": true - }, - "storageSyncServiceUid": { - "type": "string", - "description": "Storage Sync service Uid", - "readOnly": true - } - } - }, - "WorkflowProperties": { - "type": "object", - "description": "Workflow Properties object.", - "properties": { - "lastStepName": { - "type": "string", - "description": "last step name" - }, - "status": { - "$ref": "#/definitions/WorkflowStatus", - "description": "workflow status." - }, - "operation": { - "$ref": "#/definitions/OperationDirection", - "description": "operation direction." - }, - "steps": { - "type": "string", - "description": "workflow steps" - }, - "lastOperationId": { - "type": "string", - "description": "workflow last operation identifier." - } - } - }, - "SyncGroupProperties": { - "type": "object", - "description": "SyncGroup Properties object.", - "properties": { - "uniqueId": { - "type": "string", - "description": "Unique Id" - }, - "syncGroupStatus": { - "type": "string", - "description": "Sync group status", - "readOnly": true - } - } - }, - "RegisteredServerProperties": { - "type": "object", - "description": "RegisteredServer Properties object.", - "properties": { - "serverCertificate": { - "type": "string", - "description": "Registered Server Certificate" - }, - "agentVersion": { - "type": "string", - "description": "Registered Server Agent Version" - }, - "serverOSVersion": { - "type": "string", - "description": "Registered Server OS Version" - }, - "serverManagementtErrorCode": { - "type": "integer", - "description": "Registered Server Management Error Code" - }, - "lastHeartBeat": { - "type": "string", - "description": "Registered Server last heart beat" - }, - "provisioningState": { - "type": "string", - "description": "Registered Server Provisioning State" - }, - "serverRole": { - "type": "string", - "description": "Registered Server serverRole" - }, - "clusterId": { - "type": "string", - "description": "Registered Server clusterId" - }, - "clusterName": { - "type": "string", - "description": "Registered Server clusterName" - }, - "serverId": { - "type": "string", - "description": "Registered Server serverId" - }, - "storageSyncServiceUid": { - "type": "string", - "description": "Registered Server storageSyncServiceUid" - }, - "lastWorkflowId": { - "type": "string", - "description": "Registered Server lastWorkflowId" - } - } - }, - "CloudEndpointProperties": { - "type": "object", - "description": "CloudEndpoint Properties object.", - "properties": { - "storageAccountKey": { - "type": "string", - "description": "Storage Account access key." - }, - "storageAccount": { - "type": "string", - "description": "Storage Account name." - }, - "storageAccountResourceId": { - "type": "string", - "description": "Storage Account Resource Id" - }, - "storageAccountShareName": { - "type": "string", - "description": "Storage Account Share name" - }, - "storageAccountTenantId": { - "type": "string", - "description": "Storage Account Tenant Id" - }, - "partnershipId": { - "type": "string", - "description": "Partnership Id" - }, - "friendlyName": { - "type": "string", - "description": "Friendly Name" - }, - "backupEnabled": { - "type": "boolean", - "description": "Backup Enabled", - "readOnly": true - }, - "provisioningState": { - "type": "string", - "description": "CloudEndpoint Provisioning State" - }, - "lastWorkflowId": { - "type": "string", - "description": "CloudEndpoint lastWorkflowId" - } - } - }, - "ServerEndpointProperties": { - "type": "object", - "description": "ServerEndpoint Properties object.", - "properties": { - "serverLocalPath": { - "$ref": "#/definitions/PhysicalPath", - "description": "Server Local path." - }, - "cloudTiering": { - "$ref": "#/definitions/FeatureStatus", - "description": "Cloud Tiering." - }, - "volumeFreeSpacePercent": { - "type": "integer", - "minimum": 0, - "maximum": 100, - "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." - }, - "friendlyName": { - "type": "string", - "description": "Friendly Name" - }, - "lastSyncSuccess": { - "type": "string", - "format": "date-time", - "description": "Last Sync Success" - }, - "syncErrorState": { - "type": "string", - "description": "Sync Error State" - }, - "syncErrorStateTimestamp": { - "type": "string", - "format": "date-time", - "description": "Sync Error State Timestamp" - }, - "syncErrorDirection": { - "$ref": "#/definitions/ProgressType", - "description": "Sync Error Direction." - }, - "itemUploadErrorCount": { - "type": "integer", - "description": "Item Upload Error Count." - }, - "itemDownloadErrorCount": { - "type": "integer", - "description": "Item download error count." - }, - "syncErrorContext": { - "type": "string", - "description": "sync error context." - }, - "currentProgressType": { - "$ref": "#/definitions/ProgressType", - "description": "current progress type." - }, - "itemProgressCount": { - "type": "integer", - "description": "Item Progress Count" - }, - "itemTotalCount": { - "type": "integer", - "description": "Item Total Count" - }, - "byteProgress": { - "type": "integer", - "description": "Bytes in progress" - }, - "totalProgress": { - "type": "integer", - "description": "Total progress" - }, - "byteTotal": { - "type": "integer", - "description": "Bytes total" - }, - "serverResourceId": { - "$ref": "#/definitions/ResourceId", - "description": "Server Resource Id." - }, - "provisioningState": { - "type": "string", - "description": "ServerEndpoint Provisioning State" - }, - "lastWorkflowId": { - "type": "string", - "description": "ServerEndpoint lastWorkflowId" - } - } - }, - "PhysicalPath": { - "type": "string", - "description": "Server folder used for data synchronization" - }, - "ResourceId": { - "type": "string", - "description": "Arm resource identifier." - }, - "TagsObject": { - "type": "object", - "description": "Tags object." - }, - "FeatureStatus": { - "type": "string", - "description": "Type of the Feature Status", - "enum": [ - "on", - "off" - ] - }, - "WorkflowStatus": { - "type": "string", - "description": "Type of the Workflow Status", - "enum": [ - "active", - "expired", - "succeeded", - "aborted", - "failed" - ] - }, - "OperationDirection": { - "type": "string", - "description": "Type of the Operation Direction", - "enum": [ - "do", - "undo", - "cancel" - ] - }, - "ProgressType": { - "type": "string", - "description": "Type of the ProgressType", - "enum": [ - "none", - "initialize", - "download", - "upload", - "recall" - ] - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client Api Version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group within the user's subscription. The name is case insensitive.", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - } - }, - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ] +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Storage Sync", + "description": "Microsoft Storage Sync Service API", + "version": "2017-06-05-preview", + "x-ms-code-generation-settings": { + "name": "StorageSyncManagementClient" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.StorageSync/operations": { + "get": { + "tags": [ + "ResourceProvider", + "Operations" + ], + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "description": "Lists all of the available Storage Sync Rest API operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "responses": { + "200": { + "description": "Array of operations resources in the Resource Provider", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource name.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Create", + "description": "Create a new StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Create": { + "$ref": "./examples/StorageSyncServices_Create.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Get", + "description": "Get a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Get": { + "$ref": "./examples/StorageSyncServices_Get.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "patch": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Storage Sync Service resource.", + "schema": { + "$ref": "#/definitions/StorageSyncService" + } + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Update", + "description": "Patch a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Update": { + "$ref": "./examples/StorageSyncServices_Update.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object created/updated", + "schema": { + "$ref": "#/definitions/StorageSyncService" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_Delete", + "description": "Delete a given StorageSyncService.", + "x-ms-examples": { + "StorageSyncServices_Delete": { + "$ref": "./examples/StorageSyncServices_Delete.json" + } + }, + "responses": { + "200": { + "description": "Storage Sync Service object was deleted.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "204": { + "description": "Storage Sync Service Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListByResourceGroup", + "description": "Get a StorageSyncService list by Resource group name.", + "x-ms-examples": { + "StorageSyncServices_ListByResourceGroup": { + "$ref": "./examples/StorageSyncServices_ListByResourceGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the Resource Group", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "tags": [ + "StorageSyncServices Resource" + ], + "operationId": "StorageSyncServices_ListBySubscription", + "description": "Get a StorageSyncService list by subscription.", + "x-ms-examples": { + "StorageSyncServices_ListBySubscription": { + "$ref": "./examples/StorageSyncServices_ListBySubscription.json" + } + }, + "responses": { + "200": { + "description": "Array of registered Storage Sync Service resources in the subscription.", + "schema": { + "$ref": "#/definitions/StorageSyncServiceArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_ListByStorageSyncService", + "description": "Get a SyncGroup List.", + "x-ms-examples": { + "SyncGroups_ListByStorageSyncService": { + "$ref": "./examples/SyncGroups_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Sync Group resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/SyncGroupArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Sync Group Body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncGroup" + } + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Create", + "description": "Create a new SyncGroup.", + "x-ms-examples": { + "SyncGroups_Create": { + "$ref": "./examples/SyncGroups_Create.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Get", + "description": "Get a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Get": { + "$ref": "./examples/SyncGroups_Get.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object", + "schema": { + "$ref": "#/definitions/SyncGroup" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "SyncGroup Resource" + ], + "operationId": "SyncGroups_Delete", + "description": "Delete a given SyncGroup.", + "x-ms-examples": { + "SyncGroups_Delete": { + "$ref": "./examples/SyncGroups_Delete.json" + } + }, + "responses": { + "200": { + "description": "Sync Group object was deleted", + "headers": { + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint resource.", + "required": true, + "schema": { + "$ref": "#/definitions/CloudEndpoint" + } + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Create", + "description": "Create a new CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Create": { + "$ref": "./examples/CloudEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Get", + "description": "Get a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Get": { + "$ref": "./examples/CloudEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Cloud Endpoint object", + "schema": { + "$ref": "#/definitions/CloudEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_Delete", + "description": "Delete a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_Delete": { + "$ref": "./examples/CloudEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Retry-After": { + "description": "Retry After", + "type": "string" + }, + "x-ms-request-id": { + "description": "Request id", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource" + ], + "operationId": "CloudEndpoints_ListBySyncGroup", + "description": "Get a CloudEndpoint List.", + "x-ms-examples": { + "CloudEndpoints_ListBySyncGroup": { + "$ref": "./examples/CloudEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Cloud Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/CloudEndpointArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreBackup", + "description": "Pre Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreBackup": { + "$ref": "./examples/CloudEndpoints_PreBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Backup request.", + "required": true, + "schema": { + "$ref": "#/definitions/BackupRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostBackup", + "description": "Post Backup a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostBackup": { + "$ref": "./examples/CloudEndpoints_PostBackup.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/PostBackupResponse" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PreRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PreRestore", + "description": "Pre Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PreRestore": { + "$ref": "./examples/CloudEndpoints_PreRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_RestoreHeatbeat", + "description": "Restore Heartbeat a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_RestoreHeatbeat": { + "$ref": "./examples/CloudEndpoints_RestoreHeatbeat.json" + } + }, + "responses": { + "200": { + "description": "Restore Heartbeat Operation has ran successfully.", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "cloudEndpointName", + "in": "path", + "description": "Name of Cloud Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Cloud Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/PostRestoreRequest" + } + } + ], + "tags": [ + "CloudEndpoint Resource", + "Actions", + "Backup Restore" + ], + "operationId": "CloudEndpoints_PostRestore", + "description": "Post Restore a given CloudEndpoint.", + "x-ms-examples": { + "CloudEndpoints_PostRestore": { + "$ref": "./examples/CloudEndpoints_PostRestore.json" + } + }, + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}": { + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Server Endpoint object.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerEndpoint" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Create", + "description": "Create a new ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Create": { + "$ref": "./examples/ServerEndpoints_Create.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Any of the properties applicable in PUT request.", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + } + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Update", + "description": "Patch a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Update": { + "$ref": "./examples/ServerEndpoints_Update.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Get", + "description": "Get a ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Get": { + "$ref": "./examples/ServerEndpoints_Get.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "schema": { + "$ref": "#/definitions/ServerEndpoint" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_Delete", + "description": "Delete a given ServerEndpoint.", + "x-ms-examples": { + "ServerEndpoints_Delete": { + "$ref": "./examples/ServerEndpoints_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource" + ], + "operationId": "ServerEndpoints_ListBySyncGroup", + "description": "Get a ServerEndpoint list.", + "x-ms-examples": { + "ServerEndpoints_ListBySyncGroup": { + "$ref": "./examples/ServerEndpoints_ListBySyncGroup.json" + } + }, + "responses": { + "200": { + "description": "Array of Server Endpoint resources in Sync Group", + "schema": { + "$ref": "#/definitions/ServerEndpointArray" + }, + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "syncGroupName", + "in": "path", + "description": "Name of Sync Group resource.", + "required": true, + "type": "string" + }, + { + "name": "serverEndpointName", + "in": "path", + "description": "Name of Server Endpoint object.", + "required": true, + "type": "string" + } + ], + "tags": [ + "ServerEndpoint Resource", + "Actions" + ], + "operationId": "ServerEndpoints_Recall", + "description": "Recall a server endpoint.", + "x-ms-examples": { + "ServerEndpoints_Recall": { + "$ref": "./examples/ServerEndpoints_Recall.json" + } + }, + "responses": { + "200": { + "description": "Server Endpoint object", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_ListByStorageSyncService", + "description": "Get a given registered server list.", + "x-ms-examples": { + "RegisteredServers_ListByStorageSyncService": { + "$ref": "./examples/RegisteredServers_ListByStorageSyncService.json" + } + }, + "responses": { + "200": { + "description": "Array of Registered Server resources in Storage Sync Service", + "schema": { + "$ref": "#/definitions/RegisteredServerArray" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Get", + "description": "Get a given registered server.", + "x-ms-examples": { + "RegisteredServers_Get": { + "$ref": "./examples/RegisteredServers_Get.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + }, + "put": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Body of Registered Server object.", + "required": true, + "schema": { + "$ref": "#/definitions/RegisteredServer" + } + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Create", + "description": "Add a new registered server.", + "x-ms-examples": { + "RegisteredServers_Create": { + "$ref": "./examples/RegisteredServers_Create.json" + } + }, + "responses": { + "200": { + "description": "Registered Server resources in Sync Group", + "schema": { + "$ref": "#/definitions/RegisteredServer" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Azure-AsyncOperation": { + "description": "Operation Status Location URI", + "type": "string" + }, + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "serverId", + "in": "path", + "description": "GUID identifying the on-premises server.", + "required": true, + "type": "string" + } + ], + "tags": [ + "RegisteredServer Resource" + ], + "operationId": "RegisteredServers_Delete", + "description": "Delete the given registered server.", + "x-ms-examples": { + "RegisteredServers_Delete": { + "$ref": "./examples/RegisteredServers_Delete.json" + } + }, + "responses": { + "200": { + "description": "Ok", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Operation Status Location", + "headers": { + "Location": { + "description": "Operation Status Location URI", + "type": "string" + }, + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "204": { + "description": "Resource doesn't exist" + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}": { + "get": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource" + ], + "operationId": "Workflows_Get", + "description": "Get Workflows resource", + "x-ms-examples": { + "Workflows_Get": { + "$ref": "./examples/Workflows_Get.json" + } + }, + "responses": { + "200": { + "description": "Workflow object", + "schema": { + "$ref": "#/definitions/Workflow" + }, + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort": { + "post": { + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "storageSyncServiceName", + "in": "path", + "description": "Name of Storage Sync Service resource.", + "required": true, + "type": "string" + }, + { + "name": "workflowId", + "in": "path", + "description": "workflow Id", + "required": true, + "type": "string" + } + ], + "tags": [ + "Workflow Resource", + "Actions" + ], + "operationId": "Workflows_Abort", + "description": "Abort the given workflow.", + "x-ms-examples": { + "Workflows_Abort": { + "$ref": "./examples/Workflows_Abort.json" + } + }, + "responses": { + "200": { + "description": "success", + "headers": { + "x-ms-request-id": { + "description": "request id.", + "type": "string" + }, + "x-ms-correlation-request-id": { + "description": "correlation request id.", + "type": "string" + } + } + }, + "default": { + "description": "Error message indicating why the operation failed.", + "schema": { + "$ref": "#/definitions/StorageSyncError" + } + } + } + } + } + }, + "definitions": { + "StorageSyncError": { + "type": "object", + "description": "Error type", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "details": { + "$ref": "#/definitions/StorageSyncErrorDetails", + "description": "Error details of the given entry." + } + } + }, + "StorageSyncErrorDetails": { + "type": "object", + "description": "Error Details object.", + "properties": { + "code": { + "type": "string", + "description": "Error code of the given entry." + }, + "message": { + "type": "string", + "description": "Error message of the given entry." + }, + "target": { + "type": "string", + "description": "Target of the given entry." + } + } + }, + "Resource": { + "description": "The Azure Resource Manager resource.", + "properties": { + "id": { + "description": "The id of the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the resource", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The location of the resource.", + "type": "string" + }, + "tags": { + "description": "The tags of the resource.", + "type": "object" + } + } + }, + "SubscriptionState": { + "type": "object", + "description": "Subscription State object.", + "properties": { + "state": { + "type": "string", + "description": "State of Azure Subscription", + "enum": [ + "Registered", + "Unregistered", + "Warned", + "Suspended", + "Deleted" + ], + "x-ms-enum": { + "name": "Reason", + "modelAsString": true + } + }, + "istransitioning": { + "type": "boolean", + "description": "Is Transitioning", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubscriptionStateProperties", + "description": "Subscription state properties." + } + } + }, + "StorageSyncService": { + "type": "object", + "description": "Storage Sync Service object.", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StorageSyncServiceProperties", + "description": "Storage Sync Service properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "SyncGroup": { + "type": "object", + "description": "Sync Group object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SyncGroupProperties", + "description": "SyncGroup properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "CloudEndpoint": { + "type": "object", + "description": "Cloud Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CloudEndpointProperties", + "description": "Cloud Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "ServerEndpoint": { + "type": "object", + "description": "Server Endpoint object.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServerEndpointProperties", + "description": "Server Endpoint properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "RegisteredServer": { + "type": "object", + "description": "Registered Server resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RegisteredServerProperties", + "description": "RegisteredServer properties." + } + }, + "x-ms-azure-resource": true + }, + "ResourcesMoveInfo": { + "type": "object", + "description": "Resource Move Info.", + "properties": { + "targetResourceGroup": { + "type": "string", + "description": "Target resource group." + }, + "resources": { + "type": "array", + "description": "Collection of Resources.", + "items": { + "$ref": "#/definitions/ResourceId" + } + } + } + }, + "Workflow": { + "type": "object", + "description": "Workflow resource.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WorkflowProperties", + "description": "Workflow properties." + } + } + } + ], + "x-ms-azure-resource": true + }, + "OperationEntityListResult": { + "description": "The list of storage sync operations.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by storage sync." + }, + "origin": { + "type": "string", + "description": "The origin." + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by storage sync.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft StorageSync.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "OperationDisplayResource": { + "type": "object", + "description": "Operation Display Resource object.", + "properties": { + "provider": { + "type": "string", + "description": "Operation Display Resource Provider." + }, + "resource": { + "type": "string", + "description": "Operation Display Resource." + }, + "operation": { + "type": "string", + "description": "Operation Display Resource Operation." + }, + "description": { + "type": "string", + "description": "Operation Display Resource Description." + } + } + }, + "PostRestoreRequest": { + "type": "object", + "description": "Post Restore Request", + "properties": { + "partition": { + "type": "string", + "description": "Post Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Post Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Post Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Post Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Post Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Post Restore Azure source azure file share uri." + }, + "failedFileList": { + "type": "string", + "description": "Post Restore Azure failed file list." + }, + "restoreFileSpec": { + "type": "array", + "description": "Post Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Post Restore restore file spec items array." + } + } + } + }, + "PreRestoreRequest": { + "type": "object", + "description": "Pre Restore request object.", + "properties": { + "partition": { + "type": "string", + "description": "Pre Restore partition." + }, + "replicaGroup": { + "type": "string", + "description": "Pre Restore replica group." + }, + "requestId": { + "type": "string", + "description": "Pre Restore request id." + }, + "azureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure file share uri." + }, + "status": { + "type": "string", + "description": "Pre Restore Azure status." + }, + "sourceAzureFileShareUri": { + "type": "string", + "description": "Pre Restore Azure source azure file share uri." + }, + "backupMetadataPropertyBag": { + "type": "string", + "description": "Pre Restore backup metadata property bag." + }, + "restoreFileSpec": { + "type": "array", + "description": "Pre Restore restore file spec array.", + "items": { + "$ref": "#/definitions/RestoreFileSpec", + "description": "Pre Restore restore file spec items array." + } + }, + "pauseWaitForSyncDrainTimePeriodInSeconds": { + "type": "integer", + "description": "Pre Restore pause wait for sync drain time period in seconds." + } + } + }, + "BackupRequest": { + "type": "object", + "description": "Backup request", + "properties": { + "azureFileShare": { + "type": "string", + "description": "Azure File Share." + } + } + }, + "PostBackupResponse": { + "type": "object", + "description": "Post Backup Response", + "properties": { + "backupMetadata": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PostBackupResponseProperties", + "description": "Post Backup Response Properties" + } + } + }, + "RestoreFileSpec": { + "type": "object", + "description": "Restore file spec.", + "properties": { + "path": { + "type": "string", + "description": "Restore file spec path" + }, + "isdir": { + "type": "boolean", + "description": "Restore file spec isdir", + "readOnly": true + } + } + }, + "StorageSyncServiceArray": { + "type": "object", + "description": "Array of StorageSyncServices", + "properties": { + "value": { + "type": "array", + "description": "Collection of StorageSyncServices.", + "items": { + "$ref": "#/definitions/StorageSyncService" + } + } + } + }, + "SyncGroupArray": { + "type": "object", + "description": "Array of SyncGroup", + "properties": { + "value": { + "type": "array", + "description": "Collection of SyncGroup.", + "items": { + "$ref": "#/definitions/SyncGroup" + } + } + } + }, + "CloudEndpointArray": { + "type": "object", + "description": "Array of CloudEndpoint", + "properties": { + "value": { + "type": "array", + "description": "Collection of CloudEndpoint.", + "items": { + "$ref": "#/definitions/CloudEndpoint" + } + } + } + }, + "ServerEndpointArray": { + "description": "Array of ServerEndpoint", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of ServerEndpoint.", + "items": { + "$ref": "#/definitions/ServerEndpoint" + } + } + } + }, + "RegisteredServerArray": { + "description": "Array of RegisteredServer", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of Registered Server.", + "items": { + "$ref": "#/definitions/RegisteredServer" + } + } + } + }, + "WorkflowArray": { + "description": "Array of Workflow", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Collection of workflow items.", + "items": { + "$ref": "#/definitions/Workflow" + } + } + } + }, + "SubscriptionStateProperties": { + "type": "object", + "description": "Subscription State properties." + }, + "PostBackupResponseProperties": { + "type": "object", + "description": "Post Backup Response Properties object.", + "properties": { + "cloudEndpointName": { + "type": "string", + "description": "cloud endpoint Name.", + "readOnly": true + } + } + }, + "StorageSyncServiceProperties": { + "type": "object", + "description": "Storage Sync Service Properties object.", + "properties": { + "storageSyncServiceStatus": { + "type": "integer", + "description": "Storage Sync service status.", + "readOnly": true + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Storage Sync service Uid", + "readOnly": true + } + } + }, + "WorkflowProperties": { + "type": "object", + "description": "Workflow Properties object.", + "properties": { + "lastStepName": { + "type": "string", + "description": "last step name" + }, + "status": { + "$ref": "#/definitions/WorkflowStatus", + "description": "workflow status." + }, + "operation": { + "$ref": "#/definitions/OperationDirection", + "description": "operation direction." + }, + "steps": { + "type": "string", + "description": "workflow steps" + }, + "lastOperationId": { + "type": "string", + "description": "workflow last operation identifier." + } + } + }, + "SyncGroupProperties": { + "type": "object", + "description": "SyncGroup Properties object.", + "properties": { + "uniqueId": { + "type": "string", + "description": "Unique Id" + }, + "syncGroupStatus": { + "type": "string", + "description": "Sync group status", + "readOnly": true + } + } + }, + "RegisteredServerProperties": { + "type": "object", + "description": "RegisteredServer Properties object.", + "properties": { + "serverCertificate": { + "type": "string", + "description": "Registered Server Certificate" + }, + "agentVersion": { + "type": "string", + "description": "Registered Server Agent Version" + }, + "serverOSVersion": { + "type": "string", + "description": "Registered Server OS Version" + }, + "serverManagementtErrorCode": { + "type": "integer", + "description": "Registered Server Management Error Code" + }, + "lastHeartBeat": { + "type": "string", + "description": "Registered Server last heart beat" + }, + "provisioningState": { + "type": "string", + "description": "Registered Server Provisioning State" + }, + "serverRole": { + "type": "string", + "description": "Registered Server serverRole" + }, + "clusterId": { + "type": "string", + "description": "Registered Server clusterId" + }, + "clusterName": { + "type": "string", + "description": "Registered Server clusterName" + }, + "serverId": { + "type": "string", + "description": "Registered Server serverId" + }, + "storageSyncServiceUid": { + "type": "string", + "description": "Registered Server storageSyncServiceUid" + }, + "lastWorkflowId": { + "type": "string", + "description": "Registered Server lastWorkflowId" + } + } + }, + "CloudEndpointProperties": { + "type": "object", + "description": "CloudEndpoint Properties object.", + "properties": { + "storageAccountKey": { + "type": "string", + "description": "Storage Account access key." + }, + "storageAccount": { + "type": "string", + "description": "Storage Account name." + }, + "storageAccountResourceId": { + "type": "string", + "description": "Storage Account Resource Id" + }, + "storageAccountShareName": { + "type": "string", + "description": "Storage Account Share name" + }, + "storageAccountTenantId": { + "type": "string", + "description": "Storage Account Tenant Id" + }, + "partnershipId": { + "type": "string", + "description": "Partnership Id" + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "backupEnabled": { + "type": "boolean", + "description": "Backup Enabled", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "CloudEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "CloudEndpoint lastWorkflowId" + } + } + }, + "ServerEndpointProperties": { + "type": "object", + "description": "ServerEndpoint Properties object.", + "properties": { + "serverLocalPath": { + "$ref": "#/definitions/PhysicalPath", + "description": "Server Local path." + }, + "cloudTiering": { + "$ref": "#/definitions/FeatureStatus", + "description": "Cloud Tiering." + }, + "volumeFreeSpacePercent": { + "type": "integer", + "minimum": 0, + "maximum": 100, + "description": "Level of free space to be maintained by Cloud Tiering if it is enabled." + }, + "friendlyName": { + "type": "string", + "description": "Friendly Name" + }, + "lastSyncSuccess": { + "type": "string", + "format": "date-time", + "description": "Last Sync Success" + }, + "syncErrorState": { + "type": "string", + "description": "Sync Error State" + }, + "syncErrorStateTimestamp": { + "type": "string", + "format": "date-time", + "description": "Sync Error State Timestamp" + }, + "syncErrorDirection": { + "$ref": "#/definitions/ProgressType", + "description": "Sync Error Direction." + }, + "itemUploadErrorCount": { + "type": "integer", + "description": "Item Upload Error Count." + }, + "itemDownloadErrorCount": { + "type": "integer", + "description": "Item download error count." + }, + "syncErrorContext": { + "type": "string", + "description": "sync error context." + }, + "currentProgressType": { + "$ref": "#/definitions/ProgressType", + "description": "current progress type." + }, + "itemProgressCount": { + "type": "integer", + "description": "Item Progress Count" + }, + "itemTotalCount": { + "type": "integer", + "description": "Item Total Count" + }, + "byteProgress": { + "type": "integer", + "description": "Bytes in progress" + }, + "totalProgress": { + "type": "integer", + "description": "Total progress" + }, + "byteTotal": { + "type": "integer", + "description": "Bytes total" + }, + "serverResourceId": { + "$ref": "#/definitions/ResourceId", + "description": "Server Resource Id." + }, + "provisioningState": { + "type": "string", + "description": "ServerEndpoint Provisioning State" + }, + "lastWorkflowId": { + "type": "string", + "description": "ServerEndpoint lastWorkflowId" + } + } + }, + "PhysicalPath": { + "type": "string", + "description": "Server folder used for data synchronization" + }, + "ResourceId": { + "type": "string", + "description": "Arm resource identifier." + }, + "TagsObject": { + "type": "object", + "description": "Tags object." + }, + "FeatureStatus": { + "type": "string", + "description": "Type of the Feature Status", + "enum": [ + "on", + "off" + ] + }, + "WorkflowStatus": { + "type": "string", + "description": "Type of the Workflow Status", + "enum": [ + "active", + "expired", + "succeeded", + "aborted", + "failed" + ] + }, + "OperationDirection": { + "type": "string", + "description": "Type of the Operation Direction", + "enum": [ + "do", + "undo", + "cancel" + ] + }, + "ProgressType": { + "type": "string", + "description": "Type of the ProgressType", + "enum": [ + "none", + "initialize", + "download", + "upload", + "recall" + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the user's subscription. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] } \ No newline at end of file diff --git a/specification/storagesync/resource-manager/readme.md b/specification/storagesync/resource-manager/readme.md index 4561384d9e80..962d305e0080 100644 --- a/specification/storagesync/resource-manager/readme.md +++ b/specification/storagesync/resource-manager/readme.md @@ -67,7 +67,7 @@ These settings apply only when `--tag=package-2017-06-05-preview` is specified o ``` yaml $(tag) == 'package-2017-06-05-preview' input-file: -- Microsoft.StorageSync/2017-06-05-preview/storagesync.json +- Microsoft.StorageSync/preview/2017-06-05-preview/storagesync.json ``` From 0aafa5b6da03ba2ae5155d2de762a6e1b1c265d0 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:14:10 -0500 Subject: [PATCH 418/464] fix: Example automation\resource-manager\Microsoft.Automation (#4875) - "skip" -> "$skip", although neither is definied in the model --- .../examples/listConnectionsByAutomationAccount_Next100.json | 2 +- .../stable/2015-10-31/examples/listVariables_Next100.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listConnectionsByAutomationAccount_Next100.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listConnectionsByAutomationAccount_Next100.json index a62bceacc867..554d2f5f9eb6 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listConnectionsByAutomationAccount_Next100.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listConnectionsByAutomationAccount_Next100.json @@ -4,7 +4,7 @@ "resourceGroupName": "rg", "automationAccountName": "myAutomationAccount28", "api-version": "2015-10-31", - "skip": "100" + "$skip": 100 }, "responses": { "200": { diff --git a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listVariables_Next100.json b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listVariables_Next100.json index d76e899952ce..a5176ad97524 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listVariables_Next100.json +++ b/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/examples/listVariables_Next100.json @@ -4,7 +4,7 @@ "resourceGroupName": "rg", "automationAccountName": "sampleAccount9", "api-version": "2015-10-31", - "skip":"100" + "$skip": 100 }, "responses": { "200": { From 1d18877912fb57d1b5902673cc6b59caf0782080 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:25:26 -0500 Subject: [PATCH 419/464] typo: web/resource-manager/Microsoft.Web (#4505) - API capitilization - policies -> polcies - accesible -> accessible - conenction -> connection - Contsent -> Consent - Retrive -> Retrieve - specificed -> specified - subcription -> subscription - multiRool -> multiRole - Sevice -> Service - VNets capitalization - configuraiton -> configuration - performa -> perform - BizTalk capitalization - ceritificate -> certificate - expriration -> expiration - Double word "be" - crendentials -> credentials - serverfarm -> server farm - polymophic -> polymorphic - Double word "to" - resourse -> resource - defintions -> definitions - Succesfully -> Successfully - Instrunctions -> Instructions - corelated -> correlated - Reponse -> Response - recommedation -> recommendation - availbility -> availability - VM's -> VMs - desciption -> description - identifider -> identifier - siteextensions -> site extensions - sourcecontrol -> source control - htere -> there - sku's -> SKUs - shoud -> should --- .../logicAppsManagementClient.json | 19 +++-- .../stable/2015-08-01/service.json | 66 ++++++++-------- .../stable/2016-03-01/Certificates.json | 6 +- .../stable/2016-03-01/CommonDefinitions.json | 2 +- .../stable/2016-03-01/Diagnostics.json | 9 +-- .../stable/2016-03-01/Recommendations.json | 2 +- .../stable/2016-03-01/ResourceProvider.json | 4 +- .../2016-06-01/logicAppsManagementClient.json | 8 +- .../stable/2016-08-01/WebApps.json | 76 +++++++++---------- .../stable/2016-09-01/AppServicePlans.json | 14 ++-- .../stable/2018-02-01/AppServicePlans.json | 14 ++-- .../stable/2018-02-01/Certificates.json | 6 +- .../stable/2018-02-01/CommonDefinitions.json | 4 +- .../stable/2018-02-01/Diagnostics.json | 8 +- .../stable/2018-02-01/Recommendations.json | 4 +- .../stable/2018-02-01/ResourceProvider.json | 4 +- .../stable/2018-02-01/WebApps.json | 68 ++++++++--------- 17 files changed, 156 insertions(+), 158 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json b/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json index f96b9d49e2a8..4350aaa2fd16 100644 --- a/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json +++ b/specification/web/resource-manager/Microsoft.Web/preview/2015-08-01-preview/logicAppsManagementClient.json @@ -53,7 +53,7 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/managedApis/{apiName}": { "get": { "tags": [ "Managed Apis" ], - "summary": "Get managed Api", + "summary": "Get managed API", "operationId": "ManagedApis_Get", "description": "Gets a managed API.", "parameters": [ @@ -463,14 +463,14 @@ }, "policies": { "$ref": "#/definitions/ApiPolicies", - "description": "Api polcies" + "description": "API policies" }, "backendService": { "$ref": "#/definitions/BackendServiceDefinition", "description": "Backend service definition" }, "apiDefinitionUrl": { - "description": "Api definition Url - url where the swagger can be downloaded from", + "description": "API definition Url - url where the swagger can be downloaded from", "type": "string" }, "metadata": { @@ -547,7 +547,7 @@ } }, "ApiPolicies": { - "description": "Api policies", + "description": "API policies", "type": "object", "allOf": [ { @@ -596,7 +596,6 @@ "Object": { "type": "object", "properties": { - } }, "ConnectionParameter": { @@ -653,13 +652,13 @@ "type": "string" }, "useInternalRouting": { - "description": "When the backend url is in same ASE, for performance reason this flag can be set to true\r\n If WebApp.DisableHostNames is also set it improves the security by making the back end accesible only \r\n via API calls\r\n Note: calls will fail if this option is used but back end is not on the same ASE", + "description": "When the backend url is in same ASE, for performance reason this flag can be set to true\r\n If WebApp.DisableHostNames is also set it improves the security by making the back end accessible only \r\n via API calls\r\n Note: calls will fail if this option is used but back end is not on the same ASE", "type": "boolean" } } }, "ApiOAuthSettings": { - "description": "OAuth settings for the conenction provider", + "description": "OAuth settings for the connection provider", "type": "object", "properties": { "identityProvider": { @@ -717,7 +716,7 @@ } }, "ConnectionCollection": { - "description": "Collection of conenctions", + "description": "Collection of connections", "type": "object", "properties": { "value": { @@ -734,7 +733,7 @@ } }, "Connection": { - "description": "Api Connection", + "description": "API Connection", "type": "object", "allOf": [ { @@ -1033,7 +1032,7 @@ } }, "ConsentLinkInput": { - "description": "Connection Constent Link payload", + "description": "Connection Consent Link payload", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json b/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json index 7221cf02d5c0..f7870916f11c 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json @@ -722,7 +722,7 @@ "tags": [ "CertificateOrders" ], - "summary": "Retrive email history", + "summary": "Retrieve email history", "operationId": "CertificateOrders_RetrieveCertificateEmailHistory", "consumes": [], "produces": [ @@ -1010,7 +1010,7 @@ "tags": [ "Certificates" ], - "summary": "Delete a certificate by name in a specificed subscription and resourcegroup.", + "summary": "Delete a certificate by name in a specified subscription and resourcegroup.", "operationId": "Certificates_DeleteCertificate", "consumes": [], "produces": [ @@ -1986,7 +1986,7 @@ "tags": [ "Global" ], - "summary": "Gets all App Service Plans for a subcription", + "summary": "Gets all App Service Plans for a subscription", "operationId": "Global_GetAllServerFarms", "consumes": [], "produces": [ @@ -3972,7 +3972,7 @@ "tags": [ "HostingEnvironments" ], - "summary": "Get properties of a multiRool pool.", + "summary": "Get properties of a multiRole pool.", "operationId": "HostingEnvironments_GetMultiRolePool", "consumes": [], "produces": [ @@ -5842,7 +5842,7 @@ "tags": [ "ServerFarms" ], - "summary": "Queries for App Serice Plan metrics", + "summary": "Queries for App Service Plan metrics", "operationId": "ServerFarms_GetServerFarmMetrics", "consumes": [], "produces": [ @@ -5951,7 +5951,7 @@ "tags": [ "ServerFarms" ], - "summary": "Gets list of vnets associated with App Service Plan", + "summary": "Gets list of VNets associated with App Service Plan", "operationId": "ServerFarms_GetVnetsForServerFarm", "consumes": [], "produces": [ @@ -10694,7 +10694,7 @@ { "name": "siteConfig", "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", + "description": "Request body that contains the configuration setting for the web app", "required": true, "schema": { "$ref": "#/definitions/SiteConfig" @@ -10752,7 +10752,7 @@ { "name": "siteConfig", "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", + "description": "Request body that contains the configuration setting for the web app", "required": true, "schema": { "$ref": "#/definitions/SiteConfig" @@ -10864,7 +10864,7 @@ { "name": "siteConfig", "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", + "description": "Request body that contains the configuration setting for the web app", "required": true, "schema": { "$ref": "#/definitions/SiteConfig" @@ -10929,7 +10929,7 @@ { "name": "siteConfig", "in": "body", - "description": "Request body that contains the configuraiton setting for the web app", + "description": "Request body that contains the configuration setting for the web app", "required": true, "schema": { "$ref": "#/definitions/SiteConfig" @@ -15183,7 +15183,7 @@ "tags": [ "Sites" ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "summary": "Retrieves a BizTalk Hybrid Connection identified by its entity name.", "operationId": "Sites_GetSiteRelayServiceConnection", "consumes": [], "produces": [ @@ -15235,7 +15235,7 @@ "tags": [ "Sites" ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "summary": "Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.", "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnection", "consumes": [ "application/json", @@ -15300,7 +15300,7 @@ "tags": [ "Sites" ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", + "summary": "Removes the association to a BizTalk Hybrid Connection, identified by its entity name.", "operationId": "Sites_DeleteSiteRelayServiceConnection", "consumes": [], "produces": [ @@ -15352,7 +15352,7 @@ "tags": [ "Sites" ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "summary": "Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.", "operationId": "Sites_UpdateSiteRelayServiceConnection", "consumes": [ "application/json", @@ -15419,7 +15419,7 @@ "tags": [ "Sites" ], - "summary": "Retrieves a Biztalk Hybrid Connection identified by its entity name.", + "summary": "Retrieves a BizTalk Hybrid Connection identified by its entity name.", "operationId": "Sites_GetSiteRelayServiceConnectionSlot", "consumes": [], "produces": [ @@ -15478,7 +15478,7 @@ "tags": [ "Sites" ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "summary": "Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.", "operationId": "Sites_CreateOrUpdateSiteRelayServiceConnectionSlot", "consumes": [ "application/json", @@ -15550,7 +15550,7 @@ "tags": [ "Sites" ], - "summary": "Removes the association to a Biztalk Hybrid Connection, identified by its entity name.", + "summary": "Removes the association to a BizTalk Hybrid Connection, identified by its entity name.", "operationId": "Sites_DeleteSiteRelayServiceConnectionSlot", "consumes": [], "produces": [ @@ -15609,7 +15609,7 @@ "tags": [ "Sites" ], - "summary": "Creates a new association to a Biztalk Hybrid Connection, or updates an existing one.", + "summary": "Creates a new association to a BizTalk Hybrid Connection, or updates an existing one.", "operationId": "Sites_UpdateSiteRelayServiceConnectionSlot", "consumes": [ "application/json", @@ -15683,7 +15683,7 @@ "tags": [ "Sites" ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", + "summary": "Retrieves all BizTalk Hybrid Connections associated with this web app.", "operationId": "Sites_ListSiteRelayServiceConnectionsSlot", "consumes": [], "produces": [ @@ -15737,7 +15737,7 @@ "tags": [ "Sites" ], - "summary": "Retrieves all Biztalk Hybrid Connections associated with this web app.", + "summary": "Retrieves all BizTalk Hybrid Connections associated with this web app.", "operationId": "Sites_ListSiteRelayServiceConnections", "consumes": [], "produces": [ @@ -16796,7 +16796,7 @@ } }, "CertificateOrderCollection": { - "description": "Collection of ceritificate orders", + "description": "Collection of certificate orders", "type": "object", "properties": { "value": { @@ -16813,7 +16813,7 @@ } }, "CertificateOrderCertificateCollection": { - "description": "Collection of ceritificateorder certificates", + "description": "Collection of certificate order certificates", "type": "object", "properties": { "value": { @@ -17010,7 +17010,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expriration date", + "description": "Certificate expiration date", "type": "string" }, "password": { @@ -17084,7 +17084,7 @@ "type": "string" }, "pfxBlob": { - "description": "PFX certifcate of created certificate", + "description": "PFX certificate of created certificate", "type": "string" }, "password": { @@ -17294,7 +17294,7 @@ } }, "Contact": { - "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be be made publicly available through the Whois directories as per ICANN requirements.", + "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information will be made publicly available through the Whois directories as per ICANN requirements.", "type": "object", "properties": { "addressMailing": { @@ -17445,7 +17445,7 @@ } }, "User": { - "description": "Represents user crendentials used for publishing activity", + "description": "Represents user credentials used for publishing activity", "type": "object", "allOf": [ { @@ -17607,7 +17607,7 @@ "readOnly": true }, "resourceGroup": { - "description": "Resource group of the serverfarm", + "description": "Resource group of the server farm", "type": "string", "readOnly": true }, @@ -18059,7 +18059,7 @@ }, "experiments": { "$ref": "#/definitions/Experiments", - "description": "This is work around for polymophic types" + "description": "This is work around for polymorphic types" }, "limits": { "$ref": "#/definitions/SiteLimits", @@ -18504,7 +18504,7 @@ }, "changeStep": { "format": "double", - "description": "[Optional] In auto ramp up scenario this is the step to to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specificed in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}", + "description": "[Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}", "type": "number" }, "changeIntervalInMinutes": { @@ -19700,7 +19700,7 @@ "type": "object", "properties": { "unit": { - "description": "Units of measurement for the quota resourse", + "description": "Units of measurement for the quota resource", "type": "string" }, "nextResetTime": { @@ -19739,7 +19739,7 @@ } }, "MetricDefinitionCollection": { - "description": "Collection of metric defintions", + "description": "Collection of metric definitions", "type": "object", "properties": { "value": { @@ -20285,7 +20285,7 @@ } }, "RelayServiceConnectionEntity": { - "description": "Class that represents a Biztalk Hybrid Connection", + "description": "Class that represents a BizTalk Hybrid Connection", "type": "object", "allOf": [ { @@ -20748,7 +20748,7 @@ } }, "Deployment": { - "description": "Represents user crendentials used for publishing activity", + "description": "Represents user credentials used for publishing activity", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Certificates.json index 0e2a1c7b4601..13505c17f233 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Certificates.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Certificates.json @@ -201,7 +201,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate." + "description": "Successfully deleted certificate." }, "204": { "description": "Certificate does not exist." @@ -324,7 +324,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expriration date.", + "description": "Certificate expiration date.", "type": "string", "readOnly": true }, @@ -486,7 +486,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expriration date.", + "description": "Certificate expiration date.", "type": "string", "readOnly": true }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json index 950eb802a997..5569718a588b 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/CommonDefinitions.json @@ -2123,7 +2123,7 @@ }, "experiments": { "$ref": "#/definitions/Experiments", - "description": "This is work around for polymophic types." + "description": "This is work around for polymorphic types." }, "limits": { "$ref": "#/definitions/SiteLimits", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Diagnostics.json index 7a9ff21477e4..012d365b5389 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Diagnostics.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Diagnostics.json @@ -1344,7 +1344,7 @@ "type": "object", "properties": { "instructions": { - "description": "Instrunctions if any for the data source", + "description": "Instructions if any for the data source", "type": "array", "items": { "type": "string" @@ -1410,12 +1410,12 @@ "properties": { "startTime": { "format": "date-time", - "description": "Start time of the corelated event", + "description": "Start time of the correlated event", "type": "string" }, "endTime": { "format": "date-time", - "description": "End time of the corelated event", + "description": "End time of the correlated event", "type": "string" }, "message": { @@ -1555,7 +1555,6 @@ "$ref": "#/definitions/DiagnosticData" } } - }, "x-ms-client-flatten": true } @@ -1730,7 +1729,7 @@ } }, "DiagnosticDetectorResponse": { - "description": "Class representing Reponse from Diagnostic Detectors", + "description": "Class representing Response from Diagnostic Detectors", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json index 589495fd27ad..7b7e016f91f5 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/Recommendations.json @@ -309,7 +309,7 @@ { "name": "recommendationId", "in": "query", - "description": "The GUID of the recommedation object if you query an expired one. You don't need to specify it to query an active entry.", + "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.", "type": "string" }, { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json index b9f72292fefe..3a5522f24e13 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-03-01/ResourceProvider.json @@ -814,7 +814,7 @@ } }, "ResourceNameAvailability": { - "description": "Information regarding availbility of a resource name.", + "description": "Information regarding availability of a resource name.", "type": "object", "properties": { "nameAvailable": { @@ -973,7 +973,7 @@ }, "capacity": { "format": "int32", - "description": "Target capacity of the App Service plan (number of VM's).", + "description": "Target capacity of the App Service plan (number of VMs).", "minimum": 1, "type": "integer" }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json index d190dcbf913a..758d407fa995 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-06-01/logicAppsManagementClient.json @@ -562,7 +562,7 @@ ], "responses": { "200": { - "description": "custom API succesfully moved" + "description": "custom API successfully moved" } } } @@ -1446,7 +1446,7 @@ }, "description": { "type": "string", - "description": "The custom API desciption" + "description": "The custom API description" }, "displayName": { "type": "string", @@ -1499,7 +1499,7 @@ } }, "ApiOAuthSettings": { - "description": "OAuth settings for the conenction provider", + "description": "OAuth settings for the connection provider", "type": "object", "properties": { "identityProvider": { @@ -1680,7 +1680,7 @@ }, "description": { "type": "string", - "description": "The custom API desciption" + "description": "The custom API description" }, "displayName": { "type": "string", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json index 3d0cfa40301a..9fa698acc458 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json @@ -558,7 +558,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app backup item." + "description": "Successfully deleted web app backup item." }, "404": { "description": "Web app backup item does not exist." @@ -943,7 +943,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted backup configuration." + "description": "Successfully deleted backup configuration." } } } @@ -1868,7 +1868,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Continuous web job does not exist." @@ -2127,7 +2127,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment." + "description": "Successfully deleted deployment." }, "204": { "description": "Deployment does not exist." @@ -2343,10 +2343,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -2947,7 +2947,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -3102,7 +3102,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hybrid connection." + "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." @@ -3415,7 +3415,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted relay service connection." + "description": "Successfully deleted relay service connection." }, "404": { "description": "Relay service connection does not exist." @@ -4806,7 +4806,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "Successfully deleted premier add-on." } } } @@ -5355,7 +5355,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -5540,8 +5540,8 @@ "tags": [ "WebApps" ], - "summary": "Get list of siteextensions for a web site, or a deployment slot.", - "description": "Get list of siteextensions for a web site, or a deployment slot.", + "summary": "Get list of site extensions for a web site, or a deployment slot.", + "description": "Get list of site extensions for a web site, or a deployment slot.", "operationId": "WebApps_ListSiteExtensions", "parameters": [ { @@ -6361,7 +6361,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app backup item." + "description": "Successfully deleted web app backup item." }, "404": { "description": "Web app backup item does not exist." @@ -6809,7 +6809,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted backup configuration." + "description": "Successfully deleted backup configuration." } } } @@ -7802,7 +7802,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Continuous web job does not exist." @@ -8103,7 +8103,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment." + "description": "Successfully deleted deployment." }, "204": { "description": "Deployment does not exist." @@ -8354,10 +8354,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -9056,7 +9056,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -9232,7 +9232,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hybrid connection." + "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." @@ -9594,7 +9594,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted relay service connection." + "description": "Successfully deleted relay service connection." }, "404": { "description": "Relay service connection does not exist." @@ -11082,7 +11082,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "Successfully deleted premier add-on." } } } @@ -11715,7 +11715,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -11928,8 +11928,8 @@ "tags": [ "WebApps" ], - "summary": "Get list of siteextensions for a web site, or a deployment slot.", - "description": "Get list of siteextensions for a web site, or a deployment slot.", + "summary": "Get list of site extensions for a web site, or a deployment slot.", + "description": "Get list of site extensions for a web site, or a deployment slot.", "operationId": "WebApps_ListSiteExtensionsSlot", "parameters": [ { @@ -12437,7 +12437,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." + "description": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." @@ -12490,7 +12490,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -12619,7 +12619,7 @@ ], "responses": { "200": { - "description": "Successfully sync sourcecontrol." + "description": "Successfully sync source control." } } } @@ -12803,7 +12803,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Triggered web job does not exist." @@ -13223,7 +13223,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -13836,7 +13836,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." + "description": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." @@ -13882,7 +13882,7 @@ ], "responses": { "200": { - "description": "Succesfully created or updated source control for web app.", + "description": "Successfully created or updated source control for web app.", "schema": { "$ref": "#/definitions/SiteSourceControl" } @@ -13990,7 +13990,7 @@ ], "responses": { "200": { - "description": "Successfully sync sourcecontrol." + "description": "Successfully sync source control." } } } @@ -14146,7 +14146,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Triggered web job does not exist." @@ -14510,7 +14510,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -15397,7 +15397,7 @@ "readOnly": true }, "hasConflictAcrossSubscription": { - "description": "true if htere is a conflict across subscriptions; otherwise, false.", + "description": "true if there is a conflict across subscriptions; otherwise, false.", "type": "boolean", "readOnly": true }, @@ -15481,7 +15481,7 @@ } }, "Deployment": { - "description": "User crendentials used for publishing activity.", + "description": "User credentials used for publishing activity.", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json index 654b70fae20a..782eda7bbd81 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-09-01/AppServicePlans.json @@ -20,8 +20,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Get all App Service plans for a subcription.", - "description": "Get all App Service plans for a subcription.", + "summary": "Get all App Service plans for a subscription.", + "description": "Get all App Service plans for a subscription.", "operationId": "AppServicePlans_List", "parameters": [ { @@ -643,8 +643,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Get metrics for an App Serice plan.", - "description": "Get metrics for an App Serice plan.", + "summary": "Get metrics for an App Service plan.", + "description": "Get metrics for an App Service plan.", "operationId": "AppServicePlans_ListMetrics", "parameters": [ { @@ -712,7 +712,7 @@ { "name": "softRestart", "in": "query", - "description": "Specify true to performa a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps", + "description": "Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps", "type": "boolean" }, { @@ -792,8 +792,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Gets all selectable sku's for a given App Service Plan", - "description": "Gets all selectable sku's for a given App Service Plan", + "summary": "Gets all selectable SKUs for a given App Service Plan", + "description": "Gets all selectable SKUs for a given App Service Plan", "operationId": "AppServicePlans_GetServerFarmSkus", "parameters": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json index d26732e4a063..525c6f4b2ee0 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/AppServicePlans.json @@ -20,8 +20,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Get all App Service plans for a subcription.", - "description": "Get all App Service plans for a subcription.", + "summary": "Get all App Service plans for a subscription.", + "description": "Get all App Service plans for a subscription.", "operationId": "AppServicePlans_List", "parameters": [ { @@ -709,8 +709,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Get metrics for an App Serice plan.", - "description": "Get metrics for an App Serice plan.", + "summary": "Get metrics for an App Service plan.", + "description": "Get metrics for an App Service plan.", "operationId": "AppServicePlans_ListMetrics", "parameters": [ { @@ -784,7 +784,7 @@ { "name": "softRestart", "in": "query", - "description": "Specify true to performa a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps", + "description": "Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps", "type": "boolean" }, { @@ -870,8 +870,8 @@ "tags": [ "AppServicePlans" ], - "summary": "Gets all selectable sku's for a given App Service Plan", - "description": "Gets all selectable sku's for a given App Service Plan", + "summary": "Gets all selectable SKUs for a given App Service Plan", + "description": "Gets all selectable SKUs for a given App Service Plan", "operationId": "AppServicePlans_GetServerFarmSkus", "parameters": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json index 92d90365655c..c310e8fb81c5 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Certificates.json @@ -225,7 +225,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted certificate." + "description": "Successfully deleted certificate." }, "204": { "description": "Certificate does not exist." @@ -354,7 +354,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expriration date.", + "description": "Certificate expiration date.", "type": "string", "readOnly": true }, @@ -511,7 +511,7 @@ }, "expirationDate": { "format": "date-time", - "description": "Certificate expriration date.", + "description": "Certificate expiration date.", "type": "string", "readOnly": true }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json index 1cfb2195d44a..3e519c4514e1 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/CommonDefinitions.json @@ -760,7 +760,7 @@ "type": "object", "properties": { "unit": { - "description": "Units of measurement for the quota resourse.", + "description": "Units of measurement for the quota resource.", "type": "string" }, "nextResetTime": { @@ -2336,7 +2336,7 @@ }, "experiments": { "$ref": "#/definitions/Experiments", - "description": "This is work around for polymophic types." + "description": "This is work around for polymorphic types." }, "limits": { "$ref": "#/definitions/SiteLimits", diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json index 997781c6bbc9..4be504604c9b 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Diagnostics.json @@ -1500,7 +1500,7 @@ "type": "object", "properties": { "instructions": { - "description": "Instrunctions if any for the data source", + "description": "Instructions if any for the data source", "type": "array", "items": { "type": "string" @@ -1566,12 +1566,12 @@ "properties": { "startTime": { "format": "date-time", - "description": "Start time of the corelated event", + "description": "Start time of the correlated event", "type": "string" }, "endTime": { "format": "date-time", - "description": "End time of the corelated event", + "description": "End time of the correlated event", "type": "string" }, "message": { @@ -1885,7 +1885,7 @@ } }, "DiagnosticDetectorResponse": { - "description": "Class representing Reponse from Diagnostic Detectors", + "description": "Class representing Response from Diagnostic Detectors", "type": "object", "allOf": [ { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json index 10a506067507..9c9c5d08e48d 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/Recommendations.json @@ -333,7 +333,7 @@ { "name": "recommendationId", "in": "query", - "description": "The GUID of the recommedation object if you query an expired one. You don't need to specify it to query an active entry.", + "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.", "type": "string" }, { @@ -500,7 +500,7 @@ "type": "integer" }, "states": { - "description": "The list of states of this recommendation. If it's null then it shoud be considered \"Active\".", + "description": "The list of states of this recommendation. If it's null then it should be considered \"Active\".", "type": "array", "items": { "type": "string" diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json index c42e42c20427..1851c6b89ac6 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/ResourceProvider.json @@ -913,7 +913,7 @@ } }, "ResourceNameAvailability": { - "description": "Information regarding availbility of a resource name.", + "description": "Information regarding availability of a resource name.", "type": "object", "properties": { "nameAvailable": { @@ -1068,7 +1068,7 @@ }, "capacity": { "format": "int32", - "description": "Target capacity of the App Service plan (number of VM's).", + "description": "Target capacity of the App Service plan (number of VMs).", "minimum": 1, "type": "integer" }, diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index 5b3569472564..46d0444b6595 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -561,7 +561,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app backup item." + "description": "Successfully deleted web app backup item." }, "404": { "description": "Web app backup item does not exist." @@ -1081,7 +1081,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted backup configuration." + "description": "Successfully deleted backup configuration." } } } @@ -1749,7 +1749,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -2288,7 +2288,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Continuous web job does not exist." @@ -2565,7 +2565,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment." + "description": "Successfully deleted deployment." }, "204": { "description": "Deployment does not exist." @@ -2856,10 +2856,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -3508,7 +3508,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -3675,7 +3675,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hybrid connection." + "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." @@ -4024,7 +4024,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted relay service connection." + "description": "Successfully deleted relay service connection." }, "404": { "description": "Relay service connection does not exist." @@ -5842,7 +5842,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "Successfully deleted premier add-on." } } }, @@ -6556,7 +6556,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -7596,7 +7596,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted web app backup item." + "description": "Successfully deleted web app backup item." }, "404": { "description": "Web app backup item does not exist." @@ -8193,7 +8193,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted backup configuration." + "description": "Successfully deleted backup configuration." } } } @@ -8861,7 +8861,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -9484,7 +9484,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Continuous web job does not exist." @@ -9803,7 +9803,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted deployment." + "description": "Successfully deleted deployment." }, "204": { "description": "Deployment does not exist." @@ -10136,10 +10136,10 @@ ], "responses": { "200": { - "description": "Succesfully deleted domain ownership identifier." + "description": "Successfully deleted domain ownership identifier." }, "204": { - "description": "Domain ownership identifider does not exist." + "description": "Domain ownership identifier does not exist." } } }, @@ -10886,7 +10886,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -11074,7 +11074,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hybrid connection." + "description": "Successfully deleted hybrid connection." }, "404": { "description": "Hybrid connection does not exist." @@ -11472,7 +11472,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted relay service connection." + "description": "Successfully deleted relay service connection." }, "404": { "description": "Relay service connection does not exist." @@ -13410,7 +13410,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted premier add-on." + "description": "Successfully deleted premier add-on." } } }, @@ -14229,7 +14229,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted hostname binding." + "description": "Successfully deleted hostname binding." }, "204": { "description": "Hostname binding does not exist." @@ -15138,7 +15138,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." + "description": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." @@ -15467,7 +15467,7 @@ ], "responses": { "200": { - "description": "Successfully sync sourcecontrol." + "description": "Successfully sync source control." } } } @@ -15657,7 +15657,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Triggered web job does not exist." @@ -16101,7 +16101,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -16812,7 +16812,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted source control for web app." + "description": "Successfully deleted source control for web app." }, "202": { "description": "Source control delete operation in progress." @@ -17099,7 +17099,7 @@ ], "responses": { "200": { - "description": "Successfully sync sourcecontrol." + "description": "Successfully sync source control." } } } @@ -17261,7 +17261,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted continuous web job." + "description": "Successfully deleted continuous web job." }, "204": { "description": "Triggered web job does not exist." @@ -17649,7 +17649,7 @@ ], "responses": { "200": { - "description": "Succesfully deleted virtual network." + "description": "Successfully deleted virtual network." }, "404": { "description": "Virtual network does not exist." @@ -18569,7 +18569,7 @@ "readOnly": true }, "hasConflictAcrossSubscription": { - "description": "true if htere is a conflict across subscriptions; otherwise, false.", + "description": "true if there is a conflict across subscriptions; otherwise, false.", "type": "boolean", "readOnly": true }, @@ -18686,7 +18686,7 @@ } }, "Deployment": { - "description": "User crendentials used for publishing activity.", + "description": "User credentials used for publishing activity.", "type": "object", "allOf": [ { From 36b79d1cb68f209fed191649027f739d2c78ff07 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:28:46 -0500 Subject: [PATCH 420/464] typo: containerservice/Microsoft.ContainerService (#4663) - chamge -> change - clusteradmin -> cluster admin - clusteruser -> cluster user - agentpool -> an agent pool - vnet's -> VNet's - FDQN - > FQDN - openshift -> OpenShift - verison -> version --- .../2018-08-01-preview/managedClusters.json | 22 +++++++------- .../openShiftManagedClusters.json | 30 +++++++++---------- .../stable/2016-03-30/containerService.json | 4 +-- .../stable/2016-09-30/containerService.json | 4 +-- .../stable/2017-01-31/containerService.json | 4 +-- .../stable/2017-07-01/containerService.json | 10 +++---- .../stable/2017-08-31/managedClusters.json | 12 ++++---- .../stable/2017-09-30/location.json | 2 +- .../stable/2018-03-31/managedClusters.json | 18 +++++------ .../resource-manager/readme.md | 2 +- 10 files changed, 54 insertions(+), 54 deletions(-) diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json index 7b8742583380..7a3fb8844ed6 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json @@ -237,8 +237,8 @@ "ManagedClusters" ], "operationId": "ManagedClusters_ListClusterAdminCredentials", - "summary": "Gets clusteradmin credential of a managed cluster.", - "description": "Gets clusteradmin credential of the managed cluster with a specified resource group and name.", + "summary": "Gets cluster admin credential of a managed cluster.", + "description": "Gets cluster admin credential of the managed cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -282,8 +282,8 @@ "ManagedClusters" ], "operationId": "ManagedClusters_ListClusterUserCredentials", - "summary": "Gets clusteruser credential of a managed cluster.", - "description": "Gets clusteruser credential of the managed cluster with a specified resource group and name.", + "summary": "Gets cluster user credential of a managed cluster.", + "description": "Gets cluster user credential of the managed cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -654,7 +654,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -887,7 +887,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -901,7 +901,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." } }, "required": [ @@ -934,7 +934,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "maxPods": { "type": "integer", @@ -961,7 +961,7 @@ }, "type": { "$ref": "#/definitions/AgentPoolType", - "description": "AgentPoolType represents types of agentpool" + "description": "AgentPoolType represents types of an agent pool" } }, "required": [ @@ -981,7 +981,7 @@ "name": "AgentPoolType", "modelAsString": true }, - "description": "AgentPoolType represents types of agentpool" + "description": "AgentPoolType represents types of an agent pool" }, "ContainerServiceWindowsProfile": { "properties": { @@ -1181,7 +1181,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." }, "agentPoolProfiles": { "type": "array", diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json index 3c0f404db22a..30adc9533b33 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-09-30-preview/openShiftManagedClusters.json @@ -101,8 +101,8 @@ "get": { "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_Get", - "summary": "Gets a openshift managed cluster.", - "description": "Gets the details of the managed openshift cluster with a specified resource group and name.", + "summary": "Gets a OpenShift managed cluster.", + "description": "Gets the details of the managed OpenShift cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -122,7 +122,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the openshift managed cluster resource." + "description": "The name of the OpenShift managed cluster resource." } ], "responses": { @@ -148,8 +148,8 @@ "put": { "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_CreateOrUpdate", - "summary": "Creates or updates an openshift managed cluster.", - "description": "Creates or updates a openshift managed cluster with the specified configuration for agents and OpenShift version.", + "summary": "Creates or updates an OpenShift managed cluster.", + "description": "Creates or updates a OpenShift managed cluster with the specified configuration for agents and OpenShift version.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -169,7 +169,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the openshift managed cluster resource." + "description": "The name of the OpenShift managed cluster resource." }, { "name": "parameters", @@ -211,8 +211,8 @@ "patch": { "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_UpdateTags", - "summary": "Updates tags on an openshift managed cluster.", - "description": "Updates an openshift managed cluster with the specified tags.", + "summary": "Updates tags on an OpenShift managed cluster.", + "description": "Updates an OpenShift managed cluster with the specified tags.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -232,7 +232,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the openshift managed cluster resource." + "description": "The name of the OpenShift managed cluster resource." }, { "name": "parameters", @@ -268,8 +268,8 @@ "delete": { "tags": ["OpenShiftManagedClusters"], "operationId": "OpenShiftManagedClusters_Delete", - "summary": "Deletes an openshift managed cluster.", - "description": "Deletes the openshift managed cluster with a specified resource group and name.", + "summary": "Deletes an OpenShift managed cluster.", + "description": "Deletes the OpenShift managed cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -289,7 +289,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the openshift managed cluster resource." + "description": "The name of the OpenShift managed cluster resource." } ], "responses": { @@ -414,7 +414,7 @@ }, "publicSubdomain": { "type": "string", - "description": "DNS subdomain for openshift router." + "description": "DNS subdomain for OpenShift router." }, "fqdn": { "readOnly": true, @@ -631,7 +631,7 @@ } }, "required": ["openShiftVersion"], - "description": "Properties of the openshift managed cluster." + "description": "Properties of the OpenShift managed cluster." }, "OpenShiftManagedCluster": { "allOf": [ @@ -645,7 +645,7 @@ "$ref": "#/definitions/PurchasePlan" }, "properties": { - "description": "Properties of a openshift managed cluster.", + "description": "Properties of a OpenShift managed cluster.", "$ref": "#/definitions/OpenShiftManagedClusterProperties", "x-ms-client-flatten": true } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json index f0d7ec663d6c..a09cb216a1b9 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json @@ -290,7 +290,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -375,7 +375,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json index 3d65d2e69b3f..39d97dbc3e87 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json @@ -324,7 +324,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -410,7 +410,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json index 203f1728ccb7..cf7a1df8e4a7 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json @@ -367,7 +367,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master." + "description": "FQDN for the master." } }, "required": [ @@ -453,7 +453,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." } }, "required": [ diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json index 65156e39204e..7bf721fb0bc5 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json @@ -309,7 +309,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -606,7 +606,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -620,7 +620,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." } }, "required": [ @@ -658,7 +658,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." }, "ports": { "type": "array", @@ -675,7 +675,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "osType": { "$ref": "#/definitions/OSType", diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json index 7d204d355334..a639544bdd58 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-08-31/managedClusters.json @@ -469,7 +469,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -727,7 +727,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -741,7 +741,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." } }, "required": [ @@ -779,7 +779,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the agent pool." + "description": "FQDN for the agent pool." }, "ports": { "type": "array", @@ -796,7 +796,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "osType": { "$ref": "#/definitions/OSType", @@ -950,7 +950,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." }, "kubernetesVersion": { "type": "string", diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json index 47963f51484b..fc0cb0c73f34 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-09-30/location.json @@ -41,7 +41,7 @@ ], "operationId": "ContainerServices_ListOrchestrators", "summary": "Gets a list of supported orchestrators in the specified subscription.", - "description": "Gets a list of supported orchestrators in the specified subscription. The operation returns properties of each orchestrator including verison and available upgrades.", + "description": "Gets a list of supported orchestrators in the specified subscription. The operation returns properties of each orchestrator including version and available upgrades.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json index 2353eeb279eb..aa36a7aaea6a 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json @@ -237,8 +237,8 @@ "ManagedClusters" ], "operationId": "ManagedClusters_ListClusterAdminCredentials", - "summary": "Gets clusteradmin credential of a managed cluster.", - "description": "Gets clusteradmin credential of the managed cluster with a specified resource group and name.", + "summary": "Gets cluster admin credential of a managed cluster.", + "description": "Gets cluster admin credential of the managed cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -282,8 +282,8 @@ "ManagedClusters" ], "operationId": "ManagedClusters_ListClusterUserCredentials", - "summary": "Gets clusteruser credential of a managed cluster.", - "description": "Gets clusteruser credential of the managed cluster with a specified resource group and name.", + "summary": "Gets cluster user credential of a managed cluster.", + "description": "Gets cluster user credential of the managed cluster with a specified resource group and name.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -654,7 +654,7 @@ }, "ContainerServiceVnetSubnetID": { "type": "string", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "ContainerServiceVMSize": { "type": "string", @@ -887,7 +887,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "firstConsecutiveStaticIP": { "type": "string", @@ -901,7 +901,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." } }, "required": [ @@ -939,7 +939,7 @@ }, "vnetSubnetID": { "$ref": "#/definitions/ContainerServiceVnetSubnetID", - "description": "VNet SubnetID specifies the vnet's subnet identifier." + "description": "VNet SubnetID specifies the VNet's subnet identifier." }, "maxPods": { "type": "integer", @@ -1155,7 +1155,7 @@ "fqdn": { "readOnly": true, "type": "string", - "description": "FDQN for the master pool." + "description": "FQDN for the master pool." }, "agentPoolProfiles": { "type": "array", diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index ea89f9b475bd..800d8674dd7d 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -285,7 +285,7 @@ generate-interface: true directive: - suppress: DefinitionsPropertiesNamesCamelCase from: managedClusters.json - reason: Name chamge of "enableRBAC" property would break compatibility + reason: Name change of "enableRBAC" property would break compatibility - suppress: TrackedResourcePatchOperation from: containerService.json reason: ACS service is deprecated so a PATCH endpoint won't be implemented From 8372c2f142a4ee87a2d4495a6a19c6162c91024d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:30:32 -0500 Subject: [PATCH 421/464] typo: sql/resource-manager/Microsoft.Sql (#4783) - inhertied -> inherited - heirarchy -> hierarchy - succesfully -> successfully - explicity -> explicitly - Elatic -> Elastic - mising -> missing - updatess -> updates - scheduletype -> schedule type - bacukps -> backups - recoverabel -> recoverable - mininum -> minimum - recommented -> recommended - availabities -> availabilities - properites -> properties - servers's -> server's - maxiumum -> maximum - consuption -> consumption - historica -> historical --- .../preview/2015-05-01-preview/advisors.json | 8 ++++---- .../2015-05-01-preview/encryptionProtectors.json | 2 +- .../preview/2015-05-01-preview/failoverGroups.json | 14 +++++++------- .../preview/2015-05-01-preview/serverKeys.json | 4 ++-- .../2017-03-01-preview/cancelOperations.json | 4 ++-- .../preview/2017-03-01-preview/databases.json | 6 +++--- .../preview/2017-03-01-preview/jobs.json | 6 +++--- .../2017-03-01-preview/longTermRetention.json | 2 +- .../preview/2017-03-01-preview/restorePoints.json | 2 +- .../ManagedInstanceEncryptionProtectors.json | 2 +- .../2017-10-01-preview/ManagedInstanceKeys.json | 4 ++-- .../2017-10-01-preview/cancelOperations.json | 4 ++-- .../preview/2017-10-01-preview/databases.json | 8 ++++---- .../preview/2017-10-01-preview/elasticPools.json | 4 ++-- .../Microsoft.Sql/stable/2014-04-01/databases.json | 4 ++-- .../stable/2014-04-01/examples/OperationList.json | 6 +++--- .../Microsoft.Sql/stable/2014-04-01/metrics.json | 2 +- .../stable/2014-04-01/recommendedElasticPools.json | 10 +++++----- .../recommendedElasticPoolsDecoupled.json | 10 +++++----- .../Microsoft.Sql/stable/2014-04-01/sql.core.json | 2 +- .../stable/2014-04-01/tableAuditing.json | 4 ++-- 21 files changed, 54 insertions(+), 54 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json index 4d33219bb8ef..cdea72b402e9 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/advisors.json @@ -522,7 +522,7 @@ } }, "autoExecuteStatusInheritedFrom": { - "description": "Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inhertied from) different levels in the resource heirarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).", + "description": "Gets the resource from which current value of auto-execute status is inherited. Auto-execute status can be set on (and inherited from) different levels in the resource hierarchy. Possible values are 'Subscription', 'Server', 'ElasticPool', 'Database' and 'Default' (when status is not explicitly set on any level).", "enum": [ "Default", "Subscription", @@ -727,7 +727,7 @@ "type": "object", "properties": { "currentValue": { - "description": "Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> succesfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ", + "description": "Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. ", "enum": [ "Active", "Pending", @@ -751,7 +751,7 @@ } }, "actionInitiatedBy": { - "description": "Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.", + "description": "Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicitly notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it.", "enum": [ "User", "System" @@ -913,7 +913,7 @@ } }, "Advisor": { - "description": "Database, Server or Elatic Pool Advisor.", + "description": "Database, Server or Elastic Pool Advisor.", "type": "object", "allOf": [ { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json index f830b727a15b..b64b083e3e6a 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/encryptionProtectors.json @@ -161,7 +161,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json index 478a3e56320d..d7f263977af6 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/failoverGroups.json @@ -56,7 +56,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-examples": { @@ -113,7 +113,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 FailoverGroupCreateOrUpdatePartiallySucceeded - Some databases could not be added or removed.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 FailoverGroupUnableToPerformGroupOperationOnDatabases - The list of databases to add/remove to/from Failover Group contains errors that are preventing operation to complete.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 FailoverGroupCreateOrUpdatePartiallySucceeded - Some databases could not be added or removed.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 FailoverGroupUnableToPerformGroupOperationOnDatabases - The list of databases to add/remove to/from Failover Group contains errors that are preventing operation to complete.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -168,7 +168,7 @@ "description": "Successfully deleted the failover group." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -232,7 +232,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 FailoverGroupCreateOrUpdatePartiallySucceeded - Some databases could not be added or removed.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 FailoverGroupUnableToPerformGroupOperationOnDatabases - The list of databases to add/remove to/from Failover Group contains errors that are preventing operation to complete.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 FailoverGroupCreateOrUpdatePartiallySucceeded - Some databases could not be added or removed.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 409 FailoverGroupUnableToPerformGroupOperationOnDatabases - The list of databases to add/remove to/from Failover Group contains errors that are preventing operation to complete.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -279,7 +279,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-pageable": { @@ -332,7 +332,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" @@ -386,7 +386,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabases - The provided databases in the request are not valid database resource IDs.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidPartner - The given partners field in create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupCreateOrUpdateRequestDuplicatePartner - One or more of the provided partner servers are already part of the failover group. Please make sure the primary server and all of the given partner servers are unique.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidDatabaseServer - One or more of the provided databases do not exist on the primary server of the failover group. Please make sure that all the databases exist on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestUnsupportedPartnerCount - Only one partner server is supported.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpoint - The readWriteEndpoint field is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalid - The create or update failover group request body is empty or invalid.\n\n * 400 FailoverGroupUpdateOrDeleteRequestOnSecondary - Modifications to the failover group are not allowed on a secondary server. Execute the request on the primary server.\n\n * 400 FailoverGroupCreateOrUpdateRequestNegativeGracePeriodValues - Grace period value for the read-write endpoint must be non-negative.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFields - The property failoverWithDataLossGracePeriodMinutes must be provided when failover policy Automatic is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteFailoverPolicy - The failoverPolicy field for the read-write endpoint is required for create or update requests.\n\n * 400 FailoverGroupCreateOrUpdateRequestInvalidReadWriteEndpointFieldsForManualPolicy - Grace period value should not be provided when failover policy Manual is selected for the read-write endpoint.\n\n * 400 FailoverGroupCreateOrUpdateRequestReadOnlyPropertyModified - The create or update failover group request body should not modify the read-only property '{0}'.\n\n * 400 FailoverGroupFailoverRequestOnPrimary - The failover request should be initiated on the secondary server of failover group.\n\n * 400 FailoverGroupPartnerServerFromDifferentSubscription - Primary server and the partner servers of failover group are from different subscriptions. Cross subscription for servers of failover group is not allowed.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 InvalidFailoverGroupRegion - Servers specified in a Failover Group need to reside in different regions to provide isolation.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 FailoverGroupDoesNotExist - Failover group does not exist on a server.\n\n * 400 FailoverGroupNotSecondary - Failover cannot be initiated from the primary server in a Failover Group.\n\n * 400 PlannedFailoverTimedOutForDatabase - User invoked planned failover, it timed out, and a specific database appears to be to blame.\n\n * 400 PlannedFailoverTimedOut - User invoked planned failover, and it timed out while trying to contact the partner management service.\n\n * 400 DatabaseInFailoverGroupNotPrimary - GeoDR link for the database already exists, but its role is not 'Primary' or it is not continuous copy link.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SourceDatabaseNotFound - The source database does not exist.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 FailoverGroupAlreadyExists - Failover group already exists on a given server.\n\n * 409 FailoverGroupBusy - Failover Group is busy with another operation.\n\n * 409 DatabaseBelongsToOtherFailoverGroup - Database belongs to other Failover Group and cannot be consider a part of this one.\n\n * 409 DatabaseBeingAddedToFailoverGroup - The database is currently being added to Failover Group, customer needs to wait for this operation to finish to issue remove.\n\n * 409 DatabaseBeingRemovedFromFailoverGroup - The database is currently being removed from failover group, customer needs to wait for this operation to finish to issue add.\n\n * 409 FailoverGroupDnsRecordInUse - A duplicate DNS record exists for the requested endpoint.\n\n * 409 InvalidFailoverGroupName - Invalid Failover Group name was supplied.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidDatabaseStateForOperation - The operation is not allowed on the database in its current replication state.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 GeoReplicationCannotBecomePrimaryDuringUndo - User attempted to failover or force-terminate a geo-link while the secondary is in a state where it may not be physically consistent and so cannot enter the primary role.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Accepted" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json index eddac31684e7..9bb9a5bf3e96 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2015-05-01-preview/serverKeys.json @@ -147,7 +147,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" @@ -198,7 +198,7 @@ "description": "Successfully deleted the server key." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json index 92c259a2f671..7af807867dbf 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/cancelOperations.json @@ -53,7 +53,7 @@ "description": "The request for cancel has been executed successfully." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-examples": { @@ -95,7 +95,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-pageable": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json index ad95c784e765..a715b92b00b0 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json @@ -139,7 +139,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is rerquired.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Creating or updating the database is in progress." @@ -263,7 +263,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is rerquired.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Updating the database is in progress." @@ -418,7 +418,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-pageable": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json index c00788ad2829..c27e441a95d2 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json @@ -147,7 +147,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is rerquired.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 DatabaseDoesNotExist - The requested database was not found\n\n * 400 JobAgentExceededQuota - Could not create job agent because it would exceed the quota.\n\n * 400 JobAgentAlreadyExists - The job agent already exists on the server.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 JobAgentDatabaseSecondary - A job agent cannot be linked to a geo-secondary database.\n\n * 400 JobAgentDatabaseAlreadyLinked - The specified database is already linked to another job agent.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified." + "description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 DatabaseDoesNotExist - The requested database was not found\n\n * 400 JobAgentExceededQuota - Could not create job agent because it would exceed the quota.\n\n * 400 JobAgentAlreadyExists - The job agent already exists on the server.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 JobAgentDatabaseSecondary - A job agent cannot be linked to a geo-secondary database.\n\n * 400 JobAgentDatabaseAlreadyLinked - The specified database is already linked to another job agent.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified." }, "202": { "description": "Accepted" @@ -887,7 +887,7 @@ "tags": [ "JobExecutions" ], - "description": "Creates or updatess a job execution.", + "description": "Creates or updates a job execution.", "operationId": "JobExecutions_CreateOrUpdate", "parameters": [ { @@ -2791,7 +2791,7 @@ "type": "boolean" }, "interval": { - "description": "Value of the schedule's recurring interval, if the scheduletype is recurring. ISO8601 duration format.", + "description": "Value of the schedule's recurring interval, if the schedule type is recurring. ISO8601 duration format.", "type": "string" } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json index 84520a0b08bd..2f7d2d121246 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/longTermRetention.json @@ -534,7 +534,7 @@ } }, "LongTermRetentionBackupListResult": { - "description": "A list of long term retention bacukps.", + "description": "A list of long term retention backups.", "type": "object", "properties": { "value": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json index f01d7090abbc..9e95b51b6419 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/restorePoints.json @@ -222,7 +222,7 @@ }, "definitions": { "RestorePointListResult": { - "description": "A list of long term retention bacukps.", + "description": "A list of long term retention backups.", "type": "object", "properties": { "value": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json index fd615a5f68ac..03d67c78377b 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceEncryptionProtectors.json @@ -161,7 +161,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 InvalidEncryptionProtectorName - The encryption protector key name is not supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerKeyNotFound - The requested server key was not found on the current subscription.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json index 05308e3da9e0..0b474de914ca 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/ManagedInstanceKeys.json @@ -154,7 +154,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" @@ -205,7 +205,7 @@ "description": "Successfully deleted the managed instance key." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." + "description": "*** Error Responses: ***\n\n * 400 InvalidKeyName - An invalid value was given for the server key name.\n\n * 400 InvalidKeyType - The create server key type is not supported.\n\n * 400 InvalidUpsertKeyType - Service Managed type keys are managed by Azure SQL. This key type does not support create or update by the user.\n\n * 400 InvalidKeyUpsertRequest - The create server key request does not exist or has no properties object.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information ." }, "202": { "description": "Accepted" diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json index 31277778c542..3660b8b99208 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/cancelOperations.json @@ -53,7 +53,7 @@ "description": "The request for cancel has been executed successfully." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 CannotCancelOperation - The management operation is in a state that cannot be cancelled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-examples": { @@ -95,7 +95,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompetible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." } }, "x-ms-pageable": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json index ecdcd45edfc4..23c8fd393ce1 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/databases.json @@ -49,7 +49,7 @@ "description": "Successfully upgraded the data warehouse." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 UpgradeOnlyAllowedOnDataWarehouseInstances - User attempted to upgrade non-datawarehouse instance.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 UpgradeOnlyAllowedOnDataWarehouseInstances - User attempted to upgrade non-datawarehouse instance.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Upgrading the data warehouse is in progress." @@ -186,7 +186,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is rerquired.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Creating or updating the database is in progress." @@ -224,7 +224,7 @@ "Creates a database as an on-line secondary.": { "$ref": "./examples/CreateDatabaseSecondaryMode.json" }, - "Creates a database from recoverabelDatabaseId.": { + "Creates a database from recoverableDatabaseId.": { "$ref": "./examples/CreateDatabaseRecoveryMode.json" } } @@ -313,7 +313,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is rerquired.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currrently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is mising required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Serivce Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingMaxSizeBytes - MaxSizeBytes is required.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 InvalidSkuName - Invalid SKU name.\n\n * 400 MismatchedSkuNameAndCapacity - Mismatch between SKU name and capacity.\n\n * 400 MismatchedSkuNameAndTier - Mismatch between SKU name and tier.\n\n * 400 MismatchedSkuNameAndFamily - Mismatch between SKU name and family.\n\n * 400 DatabaseNameDoesNotMatchSourceDatabaseId - The database name specified doesn’t match the database name in sourceDatabaseId.\n\n * 400 ElasticPoolNotSupportedForExternalBackupRestore - Elastic pool is not supported for external backup restore\n\n * 400 InvalidRecoverableDatabaseId - Invalid recoverable database identifier.\n\n * 400 InvalidRecoveryServicesRecoveryPointId - Invalid recovery services recovery point identifier.\n\n * 400 InvalidRestorableDroppedDatabaseDeletionDate - The restorable dropped database deletion date given is invalid\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MissingRecoverableDatabaseId - Missing recoverable database identifier.\n\n * 400 MissingRecoveryServicesRecoveryPointId - Missing recovery services recovery point Id.\n\n * 400 MissingRestorableDroppedDatabaseId - Missing restorableDroppedDatabaseId\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingSourceDatabaseDeletionDate - Missing source database deletion date\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 ProvisioningDisabled - Displays error message from resources operation authorizer as is, without changes\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 CannotUpdateToFreeDatabase - Updating a database to the free sku is not supported.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 AzureKeyVaultInvalidExpirationDate - The operation could not be completed because the Azure Key Vault key expiration date is invalid.\n\n * 400 SecurityAzureKeyVaultUrlNullOrEmpty - The operation could not be completed because the Azure Key Vault Uri is null or empty.\n\n * 400 UnableToResolveRemoteServer - The remote partner server name could not be resolved due to an invalid server name or DNS connectivity issues.\n\n * 400 AzureKeyVaultInvalidUri - An invalid response from Azure Key Vault. Please use a valid Azure Key Vault URI.\n\n * 400 RemoteDatabaseCopyPermission - User does not have sufficient permission to create a database copy on the specified server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 SecurityAzureKeyVaultInvalidKeyName - The operation could not be completed because of an invalid Server Key name.\n\n * 400 ChangeUnsupportedOnEntity - User attempted an unsupported create/update/delete operation on a given entity.\n\n * 400 AzureKeyVaultMalformedVaultUri - The provided Key Vault uri is not valid.\n\n * 400 UpdateNotAllowedIfGeoDrOperationInProgress - The operation is disallowed because copy or failover operation for database '{0}' on server '{1}' is currently in progress.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 SecurityAdalPrincipalCertExpiredError - The operation could not be completed because the Azure Key Vault principal certificate has expired.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ElasticPoolOverFileSpace - Insufficient file space in the elastic pool.\n\n * 400 SecurityInvalidAzureKeyVaultRecoveryLevel - The provided Key Vault uri is not valid.\n\n * 400 InvalidAddSecondaryPermission - User does not have sufficient permission to add secondary on the specified server.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 KeyMaterialNotFoundOnRemoteServer - Remote server does not have access to key material used as a TDE protector.\n\n * 400 AzureKeyVaultMismatchError - Unexpected Key Vault region found in the http response.\n\n * 400 AzureKeyVaultRsaKeyNotSupported - The provided key vault uses unsupported RSA Key Size or Key Type. The supported RSA key size is 2048 and Key Type is RSA.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 InvalidSku - The user specified an invalid sku.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 InvalidTierSkuCombination - The specified tier does not support the specified sku.\n\n * 400 InvalidMaxSizeTierCombination - The specified tier does not support the specified database max size.\n\n * 400 FeatureDisabledOnSelectedEdition - User attempted to use a feature which is disabled on current database edition.\n\n * 400 InvalidTier - The user specified an invalid tier.\n\n * 400 OfferDisabledOnSubscription - Subscription offer type is restricted from provisioning the requested resource.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 InvalidTargetSubregion - The target server of a non-readable secondary is not in a DR paired Azure region.\n\n * 400 PartnerServerNotCompatible - The user is attempting to copy a database from a SAWA V1 server to a Sterling server or vice versa.\n\n * 400 IncorrectReplicationLinkState - The operation expects the database to be in an expected state on the replication link.\n\n * 400 ResourcePoolNotFound - Specified elastic pool does not exist in the specified logical server.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ElasticPoolSkuCombinationInvalid - Elastic pool and sku can be specified together only if sku is specified as 'ElasticPool'.\n\n * 400 ElasticPoolTierCombinationInvalid - The database tier is different than the elastic pool service tier.\n\n * 400 TierChangeUnsupportedDueToMemoryOptimizedObject - The database cannot update its sku because it has memory-optimized objects.\n\n * 400 ElasticPoolOverStorageUsage - Attempting to write data to a database when the storage limit of the elastic pool has been reached.\n\n * 400 UpdateNotAllowedInCurrentReplicationState - The operation is disallowed on the database in its current replication state.\n\n * 400 GeoReplicaLimitReached - The per-replica replication limit was reached.\n\n * 400 ElasticPoolDatabaseCountOverLimit - Attempting to create or add database to elastic pool when the database count limit of the elastic pool has been reached.\n\n * 400 ReplicationSourceAndTargetMustHaveSameName - The replication source and target databases must have the same name.\n\n * 400 CannotChangeToOrFromDataWarehouseTier - User attempted to change the sku of a database from DataWarehouse tier to non DataWarehouse tiers or vice versa.\n\n * 400 ReplicationSourceAndTargetMustBeInDifferentServers - The replication source and target databases must be in different logical servers.\n\n * 400 ElasticPoolDecreaseStorageLimitBelowUsage - Attempting to decrease the storage limit of the elastic pool below its storage usage.\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 401 AzureKeyVaultKeyDisabled - The operation could not be completed on the server because the Azure Key Vault key is disabled.\n\n * 401 AzureKeyVaultNoServerIdentity - The server identity is not correctly configured on server. Please contact support.\n\n * 401 AzureKeyVaultMissingPermissions - The server is missing required permissions on the Azure Key Vault. \n\n * 401 AdalGenericError - The operation could not be completed because an Azure Active Directory error was encountered.\n\n * 401 AdalServicePrincipalNotFound - The operation could not be completed because an Azure Active Directory library Service Principal not found error was encountered.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 405 UnsupportedReplicationOperation - An unsupported replication operation was initiated on the database.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerKeyUriAlreadyExists - The server key URI already exists on the server.\n\n * 409 ServerKeyDoesNotExists - The server key does not exist.\n\n * 409 UpdateSloInProgress - User tried to initiate an incompatible operation while a SLO update was in progress.\n\n * 409 SimultaneousSkuChangeNotAllowed - Service objective change operations cannot run on both databases of a replication relationship at the same time.\n\n * 409 AzureKeyVaultKeyNameNotFound - The operation could not be completed because the Azure Key Vault Key name does not exist.\n\n * 409 AzureKeyVaultKeyInUse - The key is currently being used by the server.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 409 SkuAssignmentInProgress - The current assignment request cannot be processed because a previous request has not completed.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ServerDtuQuotaExceeded - Could not perform the operation because server would exceed the allowed Database Throughput Unit quota.\n\n * 409 UnableToAlterDatabaseInReplication - User altered edition on a database in a replication relationship.\n\n * 409 InvalidOperationForDatabaseNotInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 InvalidOperationForDatabaseInReplicationRelationship - A replication seeding operation was performed on a database that is already in a replication relationship.\n\n * 409 DuplicateGeoDrRelation - The databases are already in a replication relation. This is a duplicate request.\n\n * 409 CurrentMemoryUsageExceedsSkuQuota - User attempted an sku update operation that cannot be completed due to the higher resource consumption.\n\n * 409 ServerKeyNameAlreadyExists - The server key already exists on the server.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 AzureKeyVaultConnectionFailed - The operation could not be completed on the server because attempts to connect to Azure Key Vault have failed\n\n * 503 AzureKeyVaultGenericConnectionError - The operation could not be completed because an error was encountered when attempting to retrieve Key Vault information .\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Updating the database is in progress." diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json index c8afd90bbed1..de76966426fa 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-10-01-preview/elasticPools.json @@ -168,7 +168,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Create or update elastic pool with mininum parameters": { + "Create or update elastic pool with minimum parameters": { "$ref": "./examples/ElasticPoolCreateOrUpdateMin.json" }, "Create or update elastic pool with all parameter": { @@ -279,7 +279,7 @@ "Update an elastic pool with all parameter": { "$ref": "./examples/ElasticPoolUpdateMax.json" }, - "Update an elastic pool with mininum parameters": { + "Update an elastic pool with minimum parameters": { "$ref": "./examples/ElasticPoolUpdateMin.json" } } diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json index be1a2425a486..a5862d292cc4 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/databases.json @@ -495,7 +495,7 @@ "Databases" ], "operationId":"Databases_GetByRecommendedElasticPool", - "description":"Gets a database inside of a recommented elastic pool.", + "description":"Gets a database inside of a recommended elastic pool.", "x-ms-examples":{ "Get a database in a recommended elastic pool":{ "$ref":"./examples/DatabaseGetByRecommendedElasticPool.json" @@ -545,7 +545,7 @@ "Databases" ], "operationId":"Databases_ListByRecommendedElasticPool", - "description":"Returns a list of databases inside a recommented elastic pool.", + "description":"Returns a list of databases inside a recommended elastic pool.", "x-ms-examples":{ "Gets databases in an elastic pool":{ "$ref":"./examples/DatabaseListByRecommendedElasticPool.json" diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json index 0b1e5f673334..7aff4dc79813 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json @@ -173,7 +173,7 @@ "provider": "Microsoft SQL Database", "resource": "Server Usage", "operation": "Get server usage details", - "description": "Return server DTU quota and current DTU consuption by all databases within the server" + "description": "Return server DTU quota and current DTU consumption by all databases within the server" } }, { @@ -182,7 +182,7 @@ "provider": "Microsoft SQL Database", "resource": "Recommended Elastic Database Pool", "operation": "Get recommended elastic database pools", - "description": "Retrieve recommendation for elastic database pools to reduce cost or improve performance based on historica resource utilization" + "description": "Retrieve recommendation for elastic database pools to reduce cost or improve performance based on historical resource utilization" } }, { @@ -308,7 +308,7 @@ "provider": "Microsoft SQL Database", "resource": "Database Usage", "operation": "Get database usage details", - "description": "Return database maxiumum size that can be reached and current size occupied by data" + "description": "Return database maximum size that can be reached and current size occupied by data" } }, { diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json index 830b4e798b50..220a9dd2fa09 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/metrics.json @@ -375,7 +375,7 @@ "items": { "$ref": "#/definitions/MetricAvailability" }, - "description": "The list of database metric availabities for the metric." + "description": "The list of database metric availabilities for the metric." } }, "description": "A database metric definition." diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json index c6d725c3029c..784ade68f7ab 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json @@ -22,7 +22,7 @@ "RecommendedElasticPools" ], "operationId": "RecommendedElasticPools_Get", - "description": "Gets a recommented elastic pool.", + "description": "Gets a recommended elastic pool.", "x-ms-examples": { "Get a recommended elastic pool": { "$ref": "./examples/RecommendedElasticPoolGet.json" @@ -104,7 +104,7 @@ "RecommendedElasticPools" ], "operationId": "RecommendedElasticPools_ListMetrics", - "description": "Returns recommented elastic pool metrics.", + "description": "Returns recommended elastic pool metrics.", "x-ms-examples": { "Get recommended elastic pool metrics": { "$ref": "./examples/RecommendedElasticPoolListMetrics.json" @@ -243,14 +243,14 @@ "description": "The list of databases housed in the server. Expanded property" } }, - "description": "Represents the properties of a recommented elastic pool." + "description": "Represents the properties of a recommended elastic pool." }, "RecommendedElasticPool": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RecommendedElasticPoolProperties", - "description": "The properites representing the resource." + "description": "The properties representing the resource." } }, "allOf": [ @@ -258,7 +258,7 @@ "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], - "description": "Represents a recommented elastic pool." + "description": "Represents a recommended elastic pool." }, "RecommendedElasticPoolListResult": { "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json index c76f6dbac969..70fa552db7eb 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/recommendedElasticPoolsDecoupled.json @@ -22,7 +22,7 @@ "RecommendedElasticPools" ], "operationId": "RecommendedElasticPools_Get", - "description": "Gets a recommented elastic pool.", + "description": "Gets a recommended elastic pool.", "x-ms-examples": { "Get a recommended elastic pool": { "$ref": "./examples/RecommendedElasticPoolGet.json" @@ -104,7 +104,7 @@ "RecommendedElasticPools" ], "operationId": "RecommendedElasticPools_ListMetrics", - "description": "Returns recommented elastic pool metrics.", + "description": "Returns recommended elastic pool metrics.", "x-ms-examples": { "Get recommended elastic pool metrics": { "$ref": "./examples/RecommendedElasticPoolListMetrics.json" @@ -243,14 +243,14 @@ "description": "The list of databases housed in the server. Expanded property" } }, - "description": "Represents the properties of a recommented elastic pool." + "description": "Represents the properties of a recommended elastic pool." }, "RecommendedElasticPool": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/RecommendedElasticPoolProperties", - "description": "The properites representing the resource." + "description": "The properties representing the resource." } }, "allOf": [ @@ -258,7 +258,7 @@ "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" } ], - "description": "Represents a recommented elastic pool." + "description": "Represents a recommended elastic pool." }, "RecommendedElasticPoolListResult": { "properties": { diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json index e405f6cd5f79..158c3b44e95c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/sql.core.json @@ -911,7 +911,7 @@ "properties": { "readOnly": true, "$ref": "#/definitions/ServiceTierAdvisorProperties", - "description": "The properites representing the resource.", + "description": "The properties representing the resource.", "x-ms-client-flatten": true } }, diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json index 0aa5073f4f95..bf0bc4b3382e 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/tableAuditing.json @@ -57,7 +57,7 @@ "tags": [ "TableAuditing" ], - "description": "Creates or updates a servers's table auditing policy. Table auditing is deprecated, use blob auditing instead.", + "description": "Creates or updates a server's table auditing policy. Table auditing is deprecated, use blob auditing instead.", "deprecated": true, "operationId": "ServerTableAuditingPolicies_CreateOrUpdate", "x-ms-examples": { @@ -110,7 +110,7 @@ "tags": [ "TableAuditing" ], - "description": "Lists a servers's table auditing policies. Table auditing is deprecated, use blob auditing instead.", + "description": "Lists a server's table auditing policies. Table auditing is deprecated, use blob auditing instead.", "deprecated": true, "operationId": "ServerTableAuditingPolicies_ListByServer", "x-ms-examples": { From 7b1fa8820ae5dd1b0875da6fd5bea1877734df63 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:32:01 -0500 Subject: [PATCH 422/464] typo: trafficmanager/resource-manager/Microsoft.Network (#4812) - trafficmanagerProfiles -> trafficManagerProfiles - Ttime -> Time - overriden -> overridden --- .../trafficmanageranalytics.json | 8 +- .../stable/2015-11-01/trafficmanager.json | 116 +++++++------- .../stable/2017-03-01/trafficmanager.json | 144 +++++++++--------- .../stable/2017-05-01/trafficmanager.json | 2 +- .../stable/2018-02-01/trafficmanager.json | 2 +- .../examples/Profile-PUT-WithAliasing.json | 4 +- .../Profile-PUT-WithCustomHeaders.json | 6 +- .../stable/2018-03-01/trafficmanager.json | 2 +- .../examples/Profile-PUT-WithAliasing.json | 4 +- .../Profile-PUT-WithCustomHeaders.json | 6 +- .../stable/2018-04-01/trafficmanager.json | 8 +- 11 files changed, 151 insertions(+), 151 deletions(-) diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json b/specification/trafficmanager/resource-manager/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json index 475d70497571..961ee9351626 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/preview/2017-09-01-preview/trafficmanageranalytics.json @@ -128,7 +128,7 @@ "200": { "description": "The subscription-level Traffic Manager Real User Metrics key.", "schema": { - "$ref": "#/definitions/TrafficManagerUserMetricsKeyModel" + "$ref": "#/definitions/TrafficManagerUserMetricsKeyModel" } }, "default": { @@ -162,8 +162,8 @@ "201": { "description": "A new subscription-level key has been created for Real User Metrics collection.", "schema": { - "$ref": "#/definitions/TrafficManagerUserMetricsKeyModel" - } + "$ref": "#/definitions/TrafficManagerUserMetricsKeyModel" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -242,7 +242,7 @@ "type": { "readOnly": true, "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." } }, "x-ms-azure-resource": true diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json index 53c5398361c4..62593906011a 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2015-11-01/trafficmanager.json @@ -70,12 +70,12 @@ } ], "responses": { - "200": { - "description": "The updated Traffic Manager endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } - } + "200": { + "description": "The updated Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + } } }, "get": { @@ -121,12 +121,12 @@ } ], "responses": { - "200": { - "description": "The Traffic Manager endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } - } + "200": { + "description": "The Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + } } }, "put": { @@ -181,18 +181,18 @@ } ], "responses": { - "200": { - "description": "The created or updated Endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } - }, - "201": { - "description": "The created or updated Endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } - } + "200": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + } } }, "delete": { @@ -238,12 +238,12 @@ } ], "responses": { - "200": { + "200": { "description": "" }, - "204": { + "204": { "description": "" - } + } } } }, @@ -269,12 +269,12 @@ } ], "responses": { - "200": { + "200": { "description": "", - "schema": { - "$ref": "#/definitions/TrafficManagerNameAvailability" - } - } + "schema": { + "$ref": "#/definitions/TrafficManagerNameAvailability" + } + } } } }, @@ -304,7 +304,7 @@ } ], "responses": { - "200": { + "200": { "description": "", "schema": { "$ref": "#/definitions/ProfileListResult" @@ -332,7 +332,7 @@ } ], "responses": { - "200": { + "200": { "description": "", "schema": { "$ref": "#/definitions/ProfileListResult" @@ -371,11 +371,11 @@ } ], "responses": { - "200": { - "description": "The Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } } } }, @@ -417,17 +417,17 @@ } ], "responses": { - "200": { - "description": "The created or updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } - }, - "201": { - "description": "The created or updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } } } }, @@ -460,10 +460,10 @@ } ], "responses": { - "200": { + "200": { "description": "" }, - "204": { + "204": { "description": "" } } @@ -506,11 +506,11 @@ } ], "responses": { - "200": { - "description": "The updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } } } } @@ -604,7 +604,7 @@ "ttl": { "type": "integer", "format": "int64", - "description": "Gets or sets the DNS Ttime-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." + "description": "Gets or sets the DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." } }, "description": "Class containing DNS settings in a Traffic Manager profile." diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-03-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-03-01/trafficmanager.json index 22eeb369e39e..ac253634265d 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-03-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-03-01/trafficmanager.json @@ -68,18 +68,18 @@ } ], "responses": { - "200": { - "description": "The updated Traffic Manager endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } + "200": { + "description": "The updated Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } - } + } } }, "get": { @@ -125,11 +125,11 @@ } ], "responses": { - "200": { - "description": "The Traffic Manager endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } + "200": { + "description": "The Traffic Manager endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -191,24 +191,24 @@ } ], "responses": { - "200": { - "description": "The created or updated Endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } - }, - "201": { - "description": "The created or updated Endpoint.", - "schema": { - "$ref": "#/definitions/Endpoint" - } + "200": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } + }, + "201": { + "description": "The created or updated Endpoint.", + "schema": { + "$ref": "#/definitions/Endpoint" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", "schema": { "$ref": "#/definitions/CloudError" } - } + } } }, "delete": { @@ -254,17 +254,17 @@ } ], "responses": { - "200": { + "200": { "description": "The Traffic Manager Endpoint was deleted successfully.", - "schema": { - "$ref": "#/definitions/DeleteOperationResult" - } + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } }, - "204": { + "204": { "description": "The Traffic Manager Endpoint does not exist. It could have been deleted on a previous request.", - "schema": { - "$ref": "#/definitions/DeleteOperationResult" - } + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -297,11 +297,11 @@ } ], "responses": { - "200": { + "200": { "description": "The Traffic Manager Name Availability.", - "schema": { - "$ref": "#/definitions/TrafficManagerNameAvailability" - } + "schema": { + "$ref": "#/definitions/TrafficManagerNameAvailability" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -338,7 +338,7 @@ } ], "responses": { - "200": { + "200": { "description": "The list of Traffic Manager profiles.", "schema": { "$ref": "#/definitions/ProfileListResult" @@ -372,7 +372,7 @@ } ], "responses": { - "200": { + "200": { "description": "The list of Traffic Manager profiles.", "schema": { "$ref": "#/definitions/ProfileListResult" @@ -417,11 +417,11 @@ } ], "responses": { - "200": { - "description": "The Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -469,17 +469,17 @@ } ], "responses": { - "200": { - "description": "The created or updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } - }, - "201": { - "description": "The created or updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } + }, + "201": { + "description": "The created or updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -518,17 +518,17 @@ } ], "responses": { - "200": { + "200": { "description": "The Traffic Manager Profile was deleted successfully.", - "schema": { - "$ref": "#/definitions/DeleteOperationResult" - } + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } }, - "204": { + "204": { "description": "The profile does not exist. It could have been deleted on a previous request.", - "schema": { - "$ref": "#/definitions/DeleteOperationResult" - } + "schema": { + "$ref": "#/definitions/DeleteOperationResult" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -576,11 +576,11 @@ } ], "responses": { - "200": { - "description": "The updated Traffic Manager profile.", - "schema": { - "$ref": "#/definitions/Profile" - } + "200": { + "description": "The updated Traffic Manager profile.", + "schema": { + "$ref": "#/definitions/Profile" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -604,11 +604,11 @@ } ], "responses": { - "200": { - "description": "The default Geographic Hierarchy.", - "schema": { - "$ref": "#/definitions/TrafficManagerGeographicHierarchy" - } + "200": { + "description": "The default Geographic Hierarchy.", + "schema": { + "$ref": "#/definitions/TrafficManagerGeographicHierarchy" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -726,7 +726,7 @@ "ttl": { "type": "integer", "format": "int64", - "description": "Gets or sets the DNS Ttime-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." + "description": "Gets or sets the DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile." } }, "description": "Class containing DNS settings in a Traffic Manager profile." diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-05-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-05-01/trafficmanager.json index 0cb985895c09..88ff6ca507b9 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-05-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2017-05-01/trafficmanager.json @@ -1027,7 +1027,7 @@ "type": { "readOnly": true, "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." } }, "x-ms-azure-resource": true diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json index 6e2d8ce0dd80..7da99e4bf151 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-02-01/trafficmanager.json @@ -1039,7 +1039,7 @@ "type": { "readOnly": true, "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." } }, "x-ms-azure-resource": true diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json index a5914a96a036..ff5478ed8cfa 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithAliasing.json @@ -74,7 +74,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -118,7 +118,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json index 60a7411104a5..652d2b5f4191 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/examples/Profile-PUT-WithCustomHeaders.json @@ -31,7 +31,7 @@ "target": "foobar.contoso.com", "endpointStatus": "Enabled", "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -77,7 +77,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -121,7 +121,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json index acaaacd34c64..b08443d2ee96 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-03-01/trafficmanager.json @@ -1297,7 +1297,7 @@ }, "type": { "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." } }, "x-ms-azure-resource": true diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json index 83edea520e57..cdfe025865a6 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithAliasing.json @@ -74,7 +74,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -118,7 +118,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json index ddf877cea9f5..5d69ea98b659 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/examples/Profile-PUT-WithCustomHeaders.json @@ -31,7 +31,7 @@ "target": "foobar.contoso.com", "endpointStatus": "Enabled", "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -77,7 +77,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] @@ -121,7 +121,7 @@ "weight": 1, "priority": 1, "endpointLocation": "North Europe", - "customHeaders" : [{"name":"header-2", "value":"value-2-overriden"}] + "customHeaders" : [{"name":"header-2", "value":"value-2-overridden"}] } } ] diff --git a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json index 38b29a15ad2d..811e3679bf75 100644 --- a/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json +++ b/specification/trafficmanager/resource-manager/Microsoft.Network/stable/2018-04-01/trafficmanager.json @@ -812,7 +812,7 @@ "200": { "description": "The subscription-level Traffic Manager Real User Metrics key.", "schema": { - "$ref": "#/definitions/UserMetricsModel" + "$ref": "#/definitions/UserMetricsModel" } }, "default": { @@ -846,8 +846,8 @@ "201": { "description": "A new subscription-level key has been created for Real User Metrics collection.", "schema": { - "$ref": "#/definitions/UserMetricsModel" - } + "$ref": "#/definitions/UserMetricsModel" + } }, "default": { "description": "Default response. It will be deserialized as per the Error definition.", @@ -1460,7 +1460,7 @@ }, "type": { "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficmanagerProfiles." + "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." } }, "x-ms-azure-resource": true From 08c94adf37f36c090b9bf222b57d1385c63af061 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:34:05 -0500 Subject: [PATCH 423/464] fix: Example storSimple1200Series\resource-manager\Microsoft.StorSimple (#4852) - $top is an integer --- .../stable/2016-10-01/examples/AlertsClear.json | 2 +- .../stable/2016-10-01/examples/AlertsListByManager.json | 2 +- .../stable/2016-10-01/examples/AlertsSendTestEmail.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsClear.json b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsClear.json index b2d3bed4d9ea..cd94f47a01b4 100644 --- a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsClear.json +++ b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsClear.json @@ -4,7 +4,7 @@ "resourceGroupName": "ResourceGroupForSDKTest", "managerName": "hManagerForSDKTest4", "$filter": "status%20eq%20'Active'%20and%20severity%20eq%20'Critical'", - "$top": "1", + "$top": 1, "api-version": "2016-10-01", "Content-Type": [ "application/json; charset=utf-8" diff --git a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsListByManager.json b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsListByManager.json index 6cf642a28f8c..af2dbc9ec04f 100644 --- a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsListByManager.json +++ b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsListByManager.json @@ -4,7 +4,7 @@ "resourceGroupName": "ResourceGroupForSDKTest", "managerName": "hManagerForSDKTest4", "$filter": "status%20eq%20'Active'%20and%20severity%20eq%20'Critical'", - "$top": "1", + "$top": 1, "api-version": "2016-10-01", "x-ms-client-request-id": [ "588d01aa-3cf7-47c5-afcc-cca2d7cf838e" diff --git a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsSendTestEmail.json b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsSendTestEmail.json index 4acda07f6837..e28e38219945 100644 --- a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsSendTestEmail.json +++ b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/examples/AlertsSendTestEmail.json @@ -5,7 +5,7 @@ "managerName": "hManagerForSDKTest4", "deviceName": "is2-hlmdhdgu1et", "$filter": "status%20eq%20'Active'%20and%20severity%20eq%20'Critical'", - "$top": "1", + "$top": 1, "api-version": "2016-10-01", "Content-Type": [ "application/json; charset=utf-8" From 44e0c8a0edeed06f54cb75147c43e95055b3ee08 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:35:09 -0500 Subject: [PATCH 424/464] fix: Example network/resource-manager/Microsoft.Network (#4857) - bytesToCapturePerPacket is an integer - totalBytesPerSession is an integer - timeLimitInSeconds is an integer --- .../examples/NetworkWatcherPacketCaptureCreate.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureGet.json | 6 +++--- .../examples/NetworkWatcherPacketCapturesList.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureCreate.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureGet.json | 6 +++--- .../examples/NetworkWatcherPacketCapturesList.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureCreate.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureGet.json | 6 +++--- .../examples/NetworkWatcherPacketCapturesList.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureCreate.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureGet.json | 6 +++--- .../examples/NetworkWatcherPacketCapturesList.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureCreate.json | 12 ++++++------ .../examples/NetworkWatcherPacketCaptureGet.json | 6 +++--- .../examples/NetworkWatcherPacketCapturesList.json | 12 ++++++------ 15 files changed, 75 insertions(+), 75 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureCreate.json index 9a28aaeacf3d..de8f43638aa5 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -8,9 +8,9 @@ "parameters" : { "properties" : { "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -34,9 +34,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureGet.json index bb6b5a0cbf64..a758618fa20e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCaptureGet.json @@ -15,9 +15,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCapturesList.json index 1d1fa985d309..9ad9f2b4e2c4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCapturesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-06-01/examples/NetworkWatcherPacketCapturesList.json @@ -16,9 +16,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -40,9 +40,9 @@ "properties" : { "provisioningState" : "Succeeded", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureCreate.json index 60e663d1689c..1da788ad2f9d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -8,9 +8,9 @@ "parameters" : { "properties" : { "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -34,9 +34,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureGet.json index 157adfe6eef2..d336ca4d577e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCaptureGet.json @@ -15,9 +15,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCapturesList.json index 640cf68bfc99..744dd344f35c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCapturesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-08-01/examples/NetworkWatcherPacketCapturesList.json @@ -16,9 +16,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -40,9 +40,9 @@ "properties" : { "provisioningState" : "Succeeded", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureCreate.json index 5df4d34b33ee..9f88d84d4e60 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -8,9 +8,9 @@ "parameters" : { "properties" : { "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -34,9 +34,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureGet.json index 6be731665430..54ca9a35a2be 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCaptureGet.json @@ -15,9 +15,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCapturesList.json index dfb8f489c103..259e37e7d81e 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCapturesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-09-01/examples/NetworkWatcherPacketCapturesList.json @@ -16,9 +16,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -40,9 +40,9 @@ "properties" : { "provisioningState" : "Succeeded", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureCreate.json index ff6ac93dcbc8..b6963712bf67 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -8,9 +8,9 @@ "parameters" : { "properties" : { "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -34,9 +34,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureGet.json index f811d56403fd..5104be9790cb 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCaptureGet.json @@ -15,9 +15,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCapturesList.json index 8ffce8cbf92a..2af98d700e0f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCapturesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2017-10-01/examples/NetworkWatcherPacketCapturesList.json @@ -16,9 +16,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -40,9 +40,9 @@ "properties" : { "provisioningState" : "Succeeded", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureCreate.json index 013ffbcfffea..e296d17928ed 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureCreate.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -8,9 +8,9 @@ "parameters" : { "properties" : { "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -34,9 +34,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureGet.json index 3d775795fc6d..9179229d9f95 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureGet.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCaptureGet.json @@ -15,9 +15,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCapturesList.json index 4fc265d1f307..78244ea322dd 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCapturesList.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2018-02-01/examples/NetworkWatcherPacketCapturesList.json @@ -16,9 +16,9 @@ "properties" : { "provisioningState" : "Updating", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", @@ -40,9 +40,9 @@ "properties" : { "provisioningState" : "Succeeded", "target" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", - "bytesToCapturePerPacket" : "10000", - "totalBytesPerSession" : "100000", - "timeLimitInSeconds" : "100", + "bytesToCapturePerPacket" : 10000, + "totalBytesPerSession" : 100000, + "timeLimitInSeconds" : 100, "storageLocation" : { "storageId" : "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", "storagePath" : "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", From a05c22da7885824563e802a08bf1d3a23d8cba15 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:42:18 -0500 Subject: [PATCH 425/464] typo: storSimple1200Series/resource-manager/Microsoft.StorSimple (#4806) - defintion -> definition - iscsi -> iSCSI - udpates -> updates - devie -> device - Errordetails -> Error details - occurences -> occurrences - Alertsettings -> AlertSettings - coadmin -> co-admin - Authentical -> Authentication - Accesspoint -> Access point - ipaddress -> IP address - StorSimple capitalization --- .../stable/2016-10-01/StorSimple.json | 320 +++++++++--------- 1 file changed, 160 insertions(+), 160 deletions(-) diff --git a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/StorSimple.json b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/StorSimple.json index 5567b907c86d..206bde7a5430 100644 --- a/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/StorSimple.json +++ b/specification/storSimple1200Series/resource-manager/Microsoft.StorSimple/stable/2016-10-01/StorSimple.json @@ -44,7 +44,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -87,7 +87,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -136,7 +136,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -188,7 +188,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -250,7 +250,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -297,7 +297,7 @@ "description": "The StorSimple manager is already in a deleted state" }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -353,7 +353,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -402,7 +402,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -461,7 +461,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -527,7 +527,7 @@ "description": "Accepted the request to create or update the access control record." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -582,7 +582,7 @@ "description": "Successfully deleted the access control record." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -639,7 +639,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -699,7 +699,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -768,7 +768,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -823,7 +823,7 @@ "description": "Successfully cleared the alerts." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -879,7 +879,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -945,7 +945,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -999,7 +999,7 @@ "description": "Successfully deleted the device." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1066,7 +1066,7 @@ "description": "Accepted the request to patch the device." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1123,7 +1123,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1189,7 +1189,7 @@ "description": "Accepted the request to create or update the network settings." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1260,7 +1260,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1327,7 +1327,7 @@ "description": "Successfully deleted the backup." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1407,7 +1407,7 @@ "description": "Accepted the request to clone." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1464,7 +1464,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1530,7 +1530,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1603,7 +1603,7 @@ "description": "Accepted the request to create or update the backup schedule group." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1665,7 +1665,7 @@ "description": "Successfully deleted the backup schedule group." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1722,7 +1722,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1788,7 +1788,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1861,7 +1861,7 @@ "description": "Accepted the request to create or update the chap setting." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1923,7 +1923,7 @@ "description": "Successfully deleted the chap setting." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -1980,7 +1980,7 @@ "description": "Successfully deactivated the device." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2000,7 +2000,7 @@ "tags": [ "IscsiDisks" ], - "description": "Retrieves all the iscsi disks in a device.", + "description": "Retrieves all the iSCSI disks in a device.", "operationId": "IscsiDisks_ListByDevice", "consumes": [ "application/json" @@ -2031,13 +2031,13 @@ ], "responses": { "200": { - "description": "The collection of iscsi disks.", + "description": "The collection of iSCSI disks.", "schema": { "$ref": "#/definitions/ISCSIDiskList" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2059,7 +2059,7 @@ "tags": [ "Devices" ], - "description": "Downloads udpates on the device.", + "description": "Downloads updates on the device.", "operationId": "Devices_DownloadUpdates", "consumes": [ "application/json" @@ -2096,7 +2096,7 @@ "description": "Successfully downloaded updates." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2162,7 +2162,7 @@ "description": "Successfully completed failover of the device." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2226,7 +2226,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2285,7 +2285,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2351,7 +2351,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2424,7 +2424,7 @@ "description": "Accepted the request to create or update the file server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2486,7 +2486,7 @@ "description": "Successfully deleted the file server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2550,7 +2550,7 @@ "description": "Successfully completed backup of the file server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2621,7 +2621,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2688,7 +2688,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2754,7 +2754,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2827,7 +2827,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2907,7 +2907,7 @@ "description": "Accepted the request to create or update the file share." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -2976,7 +2976,7 @@ "description": "Successfully deleted the file share." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3054,7 +3054,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3128,7 +3128,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3187,7 +3187,7 @@ "description": "Successfully installed updates." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3207,7 +3207,7 @@ "tags": [ "IscsiServers" ], - "description": "Retrieves all the iscsi in a device.", + "description": "Retrieves all the iSCSI in a device.", "operationId": "IscsiServers_ListByDevice", "consumes": [ "application/json" @@ -3238,13 +3238,13 @@ ], "responses": { "200": { - "description": "The collection of iscsi servers.", + "description": "The collection of iSCSI servers.", "schema": { "$ref": "#/definitions/ISCSIServerList" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3266,7 +3266,7 @@ "tags": [ "IscsiServers" ], - "description": "Returns the properties of the specified iscsi server name.", + "description": "Returns the properties of the specified iSCSI server name.", "operationId": "IscsiServers_Get", "consumes": [ "application/json" @@ -3285,7 +3285,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3304,13 +3304,13 @@ ], "responses": { "200": { - "description": "The iscsi server.", + "description": "The iSCSI server.", "schema": { "$ref": "#/definitions/ISCSIServer" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3327,7 +3327,7 @@ "tags": [ "IscsiServers" ], - "description": "Creates or updates the iscsi server.", + "description": "Creates or updates the iSCSI server.", "operationId": "IscsiServers_CreateOrUpdate", "consumes": [ "application/json" @@ -3346,14 +3346,14 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, { "name": "iscsiServer", "in": "body", - "description": "The iscsi server.", + "description": "The iSCSI server.", "required": true, "schema": { "$ref": "#/definitions/ISCSIServer" @@ -3374,16 +3374,16 @@ ], "responses": { "200": { - "description": "Successfully created or updated the iscsi server.", + "description": "Successfully created or updated the iSCSI server.", "schema": { "$ref": "#/definitions/ISCSIServer" } }, "202": { - "description": "Accepted the request to create or update the iscsi server." + "description": "Accepted the request to create or update the iSCSI server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3401,7 +3401,7 @@ "tags": [ "IscsiServers" ], - "description": "Deletes the iscsi server.", + "description": "Deletes the iSCSI server.", "operationId": "IscsiServers_Delete", "consumes": [ "application/json" @@ -3420,7 +3420,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3439,13 +3439,13 @@ ], "responses": { "202": { - "description": "Accepted the request to delete the iscsi server." + "description": "Accepted the request to delete the iSCSI server." }, "204": { - "description": "Successfully deleted the iscsi server." + "description": "Successfully deleted the iSCSI server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3465,7 +3465,7 @@ "tags": [ "IscsiServers" ], - "description": "Backup the iscsi server now.", + "description": "Backup the iSCSI server now.", "operationId": "IscsiServers_BackupNow", "consumes": [ "application/json" @@ -3484,7 +3484,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3503,13 +3503,13 @@ ], "responses": { "202": { - "description": "Accepted the request to backup the iscsi server." + "description": "Accepted the request to backup the iSCSI server." }, "204": { - "description": "Successfully completed backup of the iscsi server." + "description": "Successfully completed backup of the iSCSI server." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3529,7 +3529,7 @@ "tags": [ "IscsiDisks" ], - "description": "Retrieves all the disks in a iscsi server.", + "description": "Retrieves all the disks in a iSCSI server.", "operationId": "IscsiDisks_ListByIscsiServer", "consumes": [ "application/json" @@ -3548,7 +3548,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3567,13 +3567,13 @@ ], "responses": { "200": { - "description": "The collection of iscsi disks.", + "description": "The collection of iSCSI disks.", "schema": { "$ref": "#/definitions/ISCSIDiskList" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3595,7 +3595,7 @@ "tags": [ "IscsiDisks" ], - "description": "Returns the properties of the specified iscsi disk name.", + "description": "Returns the properties of the specified iSCSI disk name.", "operationId": "IscsiDisks_Get", "consumes": [ "application/json" @@ -3614,7 +3614,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3640,13 +3640,13 @@ ], "responses": { "200": { - "description": "The iscsi disk.", + "description": "The iSCSI disk.", "schema": { "$ref": "#/definitions/ISCSIDisk" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3663,7 +3663,7 @@ "tags": [ "IscsiDisks" ], - "description": "Creates or updates the iscsi disk.", + "description": "Creates or updates the iSCSI disk.", "operationId": "IscsiDisks_CreateOrUpdate", "consumes": [ "application/json" @@ -3682,7 +3682,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3696,7 +3696,7 @@ { "name": "iscsiDisk", "in": "body", - "description": "The iscsi disk.", + "description": "The iSCSI disk.", "required": true, "schema": { "$ref": "#/definitions/ISCSIDisk" @@ -3717,16 +3717,16 @@ ], "responses": { "200": { - "description": "Successfully created or updated the iscsi disk.", + "description": "Successfully created or updated the iSCSI disk.", "schema": { "$ref": "#/definitions/ISCSIDisk" } }, "202": { - "description": "Accepted the request to create or update the iscsi disk." + "description": "Accepted the request to create or update the iSCSI disk." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3744,7 +3744,7 @@ "tags": [ "IscsiDisks" ], - "description": "Deletes the iscsi disk.", + "description": "Deletes the iSCSI disk.", "operationId": "IscsiDisks_Delete", "consumes": [ "application/json" @@ -3763,7 +3763,7 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -3789,13 +3789,13 @@ ], "responses": { "202": { - "description": "Accepted the request to delete the iscsi disk." + "description": "Accepted the request to delete the iSCSI disk." }, "204": { - "description": "Successfully deleted the iscsi disk." + "description": "Successfully deleted the iSCSI disk." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3815,7 +3815,7 @@ "tags": [ "IscsiDisks" ], - "description": "Gets the iscsi disk metrics", + "description": "Gets the iSCSI disk metrics", "operationId": "IscsiDisks_ListMetrics", "consumes": [ "application/json" @@ -3834,14 +3834,14 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, { "name": "diskName", "in": "path", - "description": "The iscsi disk name.", + "description": "The iSCSI disk name.", "required": true, "type": "string" }, @@ -3873,7 +3873,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3896,7 +3896,7 @@ "tags": [ "IscsiDisks" ], - "description": "Retrieves metric definitions for all metric aggregated at the iscsi disk.", + "description": "Retrieves metric definitions for all metric aggregated at the iSCSI disk.", "operationId": "IscsiDisks_ListMetricDefinition", "consumes": [ "application/json" @@ -3915,14 +3915,14 @@ { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, { "name": "diskName", "in": "path", - "description": "The iscsi disk name.", + "description": "The iSCSI disk name.", "required": true, "type": "string" }, @@ -3947,7 +3947,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -3969,7 +3969,7 @@ "tags": [ "IscsiServers" ], - "description": "Gets the iscsi server metrics", + "description": "Gets the iSCSI server metrics", "operationId": "IscsiServers_ListMetrics", "consumes": [ "application/json" @@ -3981,14 +3981,14 @@ { "name": "deviceName", "in": "path", - "description": "The devie name.", + "description": "The device name.", "required": true, "type": "string" }, { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -4020,7 +4020,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4043,7 +4043,7 @@ "tags": [ "IscsiServers" ], - "description": "Retrieves metric definitions for all metrics aggregated at iscsi server.", + "description": "Retrieves metric definitions for all metrics aggregated at iSCSI server.", "operationId": "IscsiServers_ListMetricDefinition", "consumes": [ "application/json" @@ -4055,14 +4055,14 @@ { "name": "deviceName", "in": "path", - "description": "The devie name.", + "description": "The device name.", "required": true, "type": "string" }, { "name": "iscsiServerName", "in": "path", - "description": "The iscsi server name.", + "description": "The iSCSI server name.", "required": true, "type": "string" }, @@ -4087,7 +4087,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4153,7 +4153,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4220,7 +4220,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4283,7 +4283,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4343,7 +4343,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4402,7 +4402,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4458,7 +4458,7 @@ "description": "Successfully scanned for updates." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4524,7 +4524,7 @@ "description": "Successfully updated security settings." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4587,7 +4587,7 @@ "description": "Successfully sent the test email." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4643,7 +4643,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4702,7 +4702,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4758,7 +4758,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4807,7 +4807,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4856,7 +4856,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4912,7 +4912,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -4956,7 +4956,7 @@ "description": "The extended information on the manager has been successfully deleted" }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5019,7 +5019,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5068,7 +5068,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5120,7 +5120,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5139,7 +5139,7 @@ "tags": [ "IscsiServers" ], - "description": "Retrieves all the iscsi servers in a manager.", + "description": "Retrieves all the iSCSI servers in a manager.", "operationId": "IscsiServers_ListByManager", "consumes": [ "application/json" @@ -5163,13 +5163,13 @@ ], "responses": { "200": { - "description": "The collection of iscsi servers.", + "description": "The collection of iSCSI servers.", "schema": { "$ref": "#/definitions/ISCSIServerList" } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5228,7 +5228,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5288,7 +5288,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5341,7 +5341,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5393,7 +5393,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5452,7 +5452,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5518,7 +5518,7 @@ "description": "Accepted the request to create or update the storage account credential." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5573,7 +5573,7 @@ "description": "Successfully deleted the storage account credential." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5623,7 +5623,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5682,7 +5682,7 @@ } }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5748,7 +5748,7 @@ "description": "Accepted the request to create or update the storage domain." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5803,7 +5803,7 @@ "description": "Successfully deleted the storage domain." }, "default": { - "description": "Default Response. It will be deserialized as per the Error defintion specified in the schema. Exception will be thrown.", + "description": "Default Response. It will be deserialized as per the Error definition specified in the schema. Exception will be thrown.", "schema": { "$ref": "#/definitions/Error" } @@ -5888,7 +5888,7 @@ } }, "AlertErrorDetails": { - "description": "Errordetails for the alert", + "description": "Error details for the alert", "type": "object", "properties": { "errorCode": { @@ -5901,7 +5901,7 @@ }, "occurences": { "format": "int32", - "description": "Number of occurences.", + "description": "Number of occurrences.", "type": "integer" } } @@ -6102,7 +6102,7 @@ } }, "AlertSettingsProperties": { - "description": "Class containing the properties of Alertsettings", + "description": "Class containing the properties of AlertSettings", "required": [ "emailNotification", "notificationToServiceOwners", @@ -6139,7 +6139,7 @@ "type": "string" }, "additionalRecipientEmailList": { - "description": "List of email addresses (apart from admin/coadmin of subscription) to whom the alert emails need to be sent", + "description": "List of email addresses (apart from admin/co-admin of subscription) to whom the alert emails need to be sent", "type": "array", "items": { "type": "string" @@ -6530,7 +6530,7 @@ } }, "ChapSettings": { - "description": "Challenge-Handshake Authentical Protocol (CHAP) setting", + "description": "Challenge-Handshake Authentication Protocol (CHAP) setting", "required": [ "properties" ], @@ -6612,7 +6612,7 @@ "type": "string" }, "targetAccessPointId": { - "description": "Accesspoint Id on which clone job will performed.", + "description": "Access point Id on which clone job will performed.", "type": "string" }, "newEndpointName": { @@ -7129,7 +7129,7 @@ "type": "object", "properties": { "ipAddress": { - "description": "The ipaddress of the network adapter, either ipv4 or ipv6.", + "description": "The IP address of the network adapter, either ipv4 or ipv6.", "type": "string" }, "prefixLength": { @@ -7144,7 +7144,7 @@ } }, "ISCSIDisk": { - "description": "The iscsi disk.", + "description": "The iSCSI disk.", "required": [ "properties" ], @@ -7179,7 +7179,7 @@ } }, "ISCSIDiskProperties": { - "description": "The iscsi disk properties.", + "description": "The iSCSI disk properties.", "required": [ "diskStatus", "accessControlRecords", @@ -7258,7 +7258,7 @@ } }, "ISCSIServer": { - "description": "The iscsi server.", + "description": "The iSCSI server.", "required": [ "properties" ], @@ -7293,7 +7293,7 @@ } }, "ISCSIServerProperties": { - "description": "The iscsi server properties.", + "description": "The iSCSI server properties.", "required": [ "storageDomainId", "backupScheduleGroupId" @@ -7731,7 +7731,7 @@ } }, "ManagerIntrinsicSettings": { - "description": "Intrinsic settings which refers to the type of the Storsimple manager", + "description": "Intrinsic settings which refers to the type of the StorSimple manager", "required": [ "type" ], @@ -7752,7 +7752,7 @@ } }, "ManagerList": { - "description": "List of storsimple Managers under a particular resourceGroup", + "description": "List of StorSimple Managers under a particular resourceGroup", "required": [ "value" ], @@ -8394,11 +8394,11 @@ "type": "string" }, "thumbprint": { - "description": "Certificate thumbrprint", + "description": "Certificate thumbprint", "type": "string" }, "friendlyName": { - "description": "Certificate friendlyname", + "description": "Certificate friendly name", "type": "string" }, "issuer": { @@ -8809,7 +8809,7 @@ "type": "boolean" }, "rebootRequiredForInstall": { - "description": "Set to true if RegularUpdatesAvailable is true and if atleast one of the updateItems detected has needs a reboot to install.", + "description": "Set to true if RegularUpdatesAvailable is true and if at least one of the updateItems detected has needs a reboot to install.", "type": "boolean" }, "totalItemsPendingForDownload": { From 80aab1bc87221441ee8257277055525ef06fe759 Mon Sep 17 00:00:00 2001 From: Leonard Francis Date: Thu, 13 Dec 2018 23:52:07 +0000 Subject: [PATCH 426/464] Remove mount target get and add pool and volume put status (#4891) * NFSAAS-1505 minor update and validation fixes * NFSAAS-1505 bring in line with RP Put (and patch) for snapshots. Service level definition changes. * NFSAAS-1505 correct resource reference and limits * NFSAAS-1505 resource and property changes Incorrect pool resource reference Name elements of property not required Correction to return status code * NFSAAS-1505 status codes * NFSAAS-1505 tidy up examples * NFSAAS-1505 tidy up examples * NFSAAS-1644 remove mt get and add put status code * NFSAAS-1644 remove mt get and add put status code --- .../2017-08-15/examples/MountTargets_Get.json | 29 -------- .../examples/Pools_CreateOrUpdate.json | 11 +++ .../examples/Volumes_CreateOrUpdate.json | 13 ++++ .../preview/2017-08-15/netapp.json | 67 ++++--------------- 4 files changed, 38 insertions(+), 82 deletions(-) delete mode 100644 specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json deleted file mode 100644 index 1571403b994d..000000000000 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/MountTargets_Get.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "subscriptionId", - "resourceGroup": "resourceGroup", - "accountName": "accountName", - "poolName": "poolName", - "volumeName": "volumeName", - "mountTargetName": "mountTargetName", - "api-version": "2017-08-15" - }, - "responses": { - "200": { - "body": { - "location": "eastus", - "properties": { - "endIp": "1.2.3.4", - "mountTargetId": "9760acf5-4638-11e7-9bdb-020073ca3333", - "startIp": "1.2.3.4", - "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca3333", - "vlanId": 1337, - "netmask": "255.255.255.0", - "ipAddress": "1.2.3.4", - "gateway": "1.2.3.4", - "provisioningState": "Created" - } - } - } - } -} diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json index 10e856ed8e0a..963096c1c441 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Pools_CreateOrUpdate.json @@ -8,6 +8,17 @@ "body": {} }, "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "provisioningState": "Created", + "poolId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "serviceLevel": "Premium", + "size": 4398046511104 + } + } + }, "201": { "body": { "location": "eastus", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json index a33791786874..9caac72ce596 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/examples/Volumes_CreateOrUpdate.json @@ -9,6 +9,19 @@ "body": {} }, "responses": { + "200": { + "body": { + "location": "eastus", + "properties": { + "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778", + "creationToken": "some-amazing-filepath", + "usageThreshold": 107374182400, + "serviceLevel": "Premium", + "provisioningState": "Created", + "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3" + } + } + }, "201": { "body": { "location": "eastus", diff --git a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json index 1bd7af70c77d..a717585a5e32 100644 --- a/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json +++ b/specification/netapp/resource-manager/Microsoft.NetApp/preview/2017-08-15/netapp.json @@ -364,8 +364,14 @@ } ], "responses": { + "200": { + "description": "OK - pool updated", + "schema": { + "$ref": "#/definitions/capacityPool" + } + }, "201": { - "description": "Pool created or updated", + "description": "Pool created", "schema": { "$ref": "#/definitions/capacityPool" } @@ -565,8 +571,14 @@ } ], "responses": { + "200": { + "description": "Ok - volume updated", + "schema": { + "$ref": "#/definitions/volume" + } + }, "201": { - "description": "Volume created or updated", + "description": "Volume created", "schema": { "$ref": "#/definitions/volume" } @@ -704,57 +716,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/mountTargets/{mountTargetName}": { - "parameters": [ - { - "$ref": "#/parameters/SubscriptionId" - }, - { - "$ref": "#/parameters/ResourceGroup" - }, - { - "$ref": "#/parameters/AccountName" - }, - { - "$ref": "#/parameters/PoolName" - }, - { - "$ref": "#/parameters/VolumeName" - }, - { - "$ref": "#/parameters/MountTargetName" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "get": { - "tags": [ - "MountTargets" - ], - "operationId": "MountTargets_Get", - "description": "Get a mount target", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/mountTarget" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/error" - } - } - }, - "x-ms-examples": { - "MountTargets_Get": { - "$ref": "examples/MountTargets_Get.json" - } - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots": { "parameters": [ { From 0f12b0cb57d344fa86c9c161d202c555c703ef44 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Thu, 13 Dec 2018 18:58:00 -0500 Subject: [PATCH 427/464] typo: resources/resource-manager/Microsoft.Solutions (#4760) - reponse -> response --- .../preview/2016-09-01-preview/managedapplications.json | 2 +- .../stable/2017-09-01/managedapplications.json | 2 +- .../stable/2018-06-01/managedapplications.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json index e59e7750943a..e798146ac944 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/preview/2016-09-01-preview/managedapplications.json @@ -1351,7 +1351,7 @@ "description": "The appliance provider authorization." }, "ErrorResponse": { - "description": "Error reponse indicates ARM appliance is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates ARM appliance is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json index 1f8351a2d4ba..2a2c87730222 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json @@ -1341,7 +1341,7 @@ "description": "The managed application provider authorization." }, "ErrorResponse": { - "description": "Error reponse indicates managed application is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates managed application is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { diff --git a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json index 40504228b018..2702391b5df7 100644 --- a/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json +++ b/specification/resources/resource-manager/Microsoft.Solutions/stable/2018-06-01/managedapplications.json @@ -1335,7 +1335,7 @@ "description": "The managed application provider authorization." }, "ErrorResponse": { - "description": "Error reponse indicates managed application is not able to process the incoming request. The reason is provided in the error message.", + "description": "Error response indicates managed application is not able to process the incoming request. The reason is provided in the error message.", "type": "object", "properties": { "httpStatus": { From d9949f332043f32fc9cf8cce8155c79a8a581837 Mon Sep 17 00:00:00 2001 From: Jeanine Burke <41650461+jaysterp@users.noreply.github.com> Date: Thu, 13 Dec 2018 19:32:26 -0500 Subject: [PATCH 428/464] update ACR webhook with Helm actions (#4820) --- .../stable/2017-10-01/containerregistry.json | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json index 6fc6063e3741..7052e5113ebb 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/stable/2017-10-01/containerregistry.json @@ -1970,7 +1970,9 @@ "enum": [ "push", "delete", - "quarantine" + "quarantine", + "chart_push", + "chart_delete" ], "type": "string", "x-ms-enum": { @@ -2065,7 +2067,9 @@ "enum": [ "push", "delete", - "quarantine" + "quarantine", + "chart_push", + "chart_delete" ], "type": "string", "x-ms-enum": { @@ -2132,7 +2136,9 @@ "enum": [ "push", "delete", - "quarantine" + "quarantine", + "chart_push", + "chart_delete" ], "type": "string", "x-ms-enum": { From a5fd13fd813e416fc4500310537491482ad401b3 Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Thu, 13 Dec 2018 17:12:12 -0800 Subject: [PATCH 429/464] Change Kind and SKU name to string (from enum). (#4913) --- .../stable/2017-04-18/cognitiveservices.json | 46 +------------------ 1 file changed, 2 insertions(+), 44 deletions(-) diff --git a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json index b2d89bb0da59..8f91f7a44b9e 100644 --- a/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json +++ b/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2017-04-18/cognitiveservices.json @@ -714,32 +714,7 @@ }, "CognitiveServicesAccountKind": { "type": "string", - "description": "Required. Indicates the type of cognitive service account.", - "enum": [ - "Bing.Autosuggest.v7", - "Bing.CustomSearch", - "Bing.Search.v7", - "Bing.Speech", - "Bing.SpellCheck.v7", - "ComputerVision", - "ContentModerator", - "CustomSpeech", - "CustomVision.Prediction", - "CustomVision.Training", - "Emotion", - "Face", - "LUIS", - "QnAMaker", - "SpeakerRecognition", - "SpeechTranslation", - "TextAnalytics", - "TextTranslation", - "WebLM" - ], - "x-ms-enum": { - "name": "Kind", - "modelAsString": true - } + "description": "Required. Indicates the type of cognitive service account." }, "CognitiveServicesAccountUpdateParameters": { "properties": { @@ -785,24 +760,7 @@ }, "SkuName": { "type": "string", - "description": "The name of SKU.", - "enum": [ - "F0", - "P0", - "P1", - "P2", - "S0", - "S1", - "S2", - "S3", - "S4", - "S5", - "S6" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } + "description": "The name of SKU." }, "CognitiveServicesAccount": { "description": "Cognitive Services Account is an Azure resource representing the provisioned account, its type, location and SKU.", From c13ba0f8f0a69e3331cb953bbb9a4a0ce1cfdb6a Mon Sep 17 00:00:00 2001 From: Yang Yuan Date: Fri, 14 Dec 2018 09:29:14 -0800 Subject: [PATCH 430/464] Fix incorrect namespace of ContentModerator (#4912) --- .../cognitiveservices/data-plane/ContentModerator/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/ContentModerator/readme.md b/specification/cognitiveservices/data-plane/ContentModerator/readme.md index da130b7701fe..738da2295573 100644 --- a/specification/cognitiveservices/data-plane/ContentModerator/readme.md +++ b/specification/cognitiveservices/data-plane/ContentModerator/readme.md @@ -49,7 +49,7 @@ swagger-to-sdk: These settings apply only when `--csharp` is specified on the command line. ``` yaml $(csharp) csharp: - namespace: Microsoft.CognitiveServices.ContentModerator + namespace: Microsoft.Azure.CognitiveServices.ContentModerator output-folder: $(csharp-sdks-folder)/CognitiveServices/dataPlane/Vision/ContentModerator/ContentModerator/Generated ``` From 6d8b20230fa57a3dfb2f1fd70f7f4fa5b67354b8 Mon Sep 17 00:00:00 2001 From: binilkk <45779126+binilkk@users.noreply.github.com> Date: Fri, 14 Dec 2018 09:59:05 -0800 Subject: [PATCH 431/464] Fixes for: (#4880) Issue #1 : https://github.com/Azure/azure-rest-api-specs/issues/4576#issuecomment-445427819 Typo in the DeltaOperationType Enum. Issue #2 : https://github.com/Azure/azure-rest-api-specs/issues/4844#event-2014233693 GlobalAdmins list is marked as an object, while it's an array. --- .../stable/2014-01-01/ADHybridHealthService.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json index def539e54f12..56af5a164574 100644 --- a/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json +++ b/specification/adhybridhealthservice/resource-manager/Microsoft.ADHybridHealthService/stable/2014-01-01/ADHybridHealthService.json @@ -3964,7 +3964,7 @@ "Update", "Delete", "Obsolete", - "DeletAdd" + "DeleteAdd" ], "x-ms-enum": { "name": "DeltaOperationType", @@ -6245,7 +6245,7 @@ "description": "The reason due to which the tenant was disabled in Azure Active Directory Connect Health." }, "globalAdminsEmail": { - "type": "object", + "type": "array", "items": { "type": "string" }, From b2b7f8251b60fd05175115bc294037c18eb44519 Mon Sep 17 00:00:00 2001 From: Ashish Shinde Date: Fri, 14 Dec 2018 23:31:45 +0530 Subject: [PATCH 432/464] Adding sync scenarios to public preview swagger (#4627) * Adding sync scenarios to public preview swagger * Fix comments on pull request * Add files to GA folder * Add missing file to swagger in GA folder * remove mongoDB chnages from stable folder * add orphaned user changes to the repo * minor string fix * Change orphanedUsers to orphanedUsersInfo * Change orphanedUsers to orphanedUsersInfo --- .../definitions/Commands.json | 53 ++ .../definitions/Common.json | 174 ++++- .../ConnectToSourcePostgreSqlSyncTask.json | 71 +++ ...tToTargetAzureDbForPostgreSqlSyncTask.json | 76 +++ .../ConnectToTargetSqlMiSyncTask.json | 63 ++ .../MigrateMySqlAzureDbForMySqlSyncTask.json | 21 + ...ostgreSqlAzureDbForPostgreSqlSyncTask.json | 21 + .../MigrateSqlServerSqlMITask.json | 10 +- .../MigrateSqlServerSqlMiSyncTask.json | 212 +++++++ .../definitions/MongoDbTasks.json | 2 +- .../2018-07-15-preview/definitions/Tasks.json | 120 ++++ .../definitions/TasksCommon.json | 60 ++ ...eMigrationInputSqlServerSqlMiSyncTask.json | 54 ++ .../2018-04-19/definitions/Commands.json | 163 +++++ .../stable/2018-04-19/definitions/Common.json | 258 +++++++- .../definitions/ConnectToSourceMySqlTask.json | 66 ++ .../ConnectToSourcePostgreSqlSyncTask.json | 71 +++ .../ConnectToTargetAzureDbForMySqlTask.json | 76 +++ ...tToTargetAzureDbForPostgreSqlSyncTask.json | 76 +++ .../definitions/ConnectToTargetSqlMITask.json | 79 +++ .../ConnectToTargetSqlMiSyncTask.json | 63 ++ .../ConnectToTargetSqlSqlDbSyncTask.json | 39 ++ .../GetTdeCertificatesSqlTask.json | 90 +++ .../definitions/GetUserTablesSqlSyncTask.json | 102 +++ .../MigrateMySqlAzureDbForMySqlSyncTask.json | 361 +++++++++++ ...ostgreSqlAzureDbForPostgreSqlSyncTask.json | 364 +++++++++++ .../MigrateSqlServerSqlDbSyncTask.json | 333 ++++++++++ .../MigrateSqlServerSqlMITask.json | 374 +++++++++++ .../MigrateSqlServerSqlMiSyncTask.json | 212 +++++++ .../stable/2018-04-19/definitions/Tasks.json | 421 +++++++++++- .../2018-04-19/definitions/TasksCommon.json | 600 +++++++++++++++++- ...idateMigrationInputSqlServerSqlMITask.json | 127 ++++ ...eMigrationInputSqlServerSqlMiSyncTask.json | 54 ++ ...lidateSyncMigrationInputSqlServerTask.json | 71 +++ .../datamigration/resource-manager/readme.md | 23 + 35 files changed, 4935 insertions(+), 25 deletions(-) create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json create mode 100644 specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Commands.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Commands.json index e53d4fade7bc..33d8ccd6428b 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Commands.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Commands.json @@ -96,6 +96,59 @@ "MigrateSyncCompleteCommandOutput": { "type": "object", "description": "Output for command that completes sync migration for a database.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "errors": { + "description": "List of errors that happened during the command execution", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "MigrateMISyncCompleteCommandProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureDbSqlMi.Complete", + "type": "object", + "description": "Properties for the command that completes online migration for an Azure SQL Database Managed Instance.", + "properties": { + "input": { + "description": "Command input", + "$ref": "#/definitions/MigrateMISyncCompleteCommandInput" + }, + "output": { + "description": "Command output. This is ignored if submitted.", + "$ref": "#/definitions/MigrateMISyncCompleteCommandOutput", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/CommandProperties" + } + ] + }, + "MigrateMISyncCompleteCommandInput": { + "type": "object", + "description": "Input for command that completes online migration for an Azure SQL Database Managed Instance.", + "properties": { + "sourceDatabaseName": { + "description": "Name of managed instance database", + "type": "string" + } + }, + "required": [ + "sourceDatabaseName" + ] + }, + "MigrateMISyncCompleteCommandOutput": { + "type": "object", + "description": "Output for command that completes online migration for an Azure SQL Database Managed Instance.", "properties": { "errors": { "description": "List of errors that happened during the command execution", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json index 25a341d55f38..9330c766a5a6 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json @@ -317,7 +317,7 @@ }, "platform": { "$ref": "#/definitions/SqlServerSourcePlatform", - "description": "Server platform type for connection" + "description": "Server platform type for connection" } }, "required": [ @@ -332,7 +332,7 @@ ], "x-ms-enum": { "name": "SqlSourcePlatform", - "modelAsString": true + "modelAsString": true } }, "MySqlConnectionInfo": { @@ -359,8 +359,8 @@ "port" ] }, - "PostgreSqlConnectionInfo": { - "x-ms-discriminator-value": "PostgreSqlConnectionInfo", + "PostgreSqlConnectionInfo": { + "x-ms-discriminator-value": "PostgreSqlConnectionInfo", "type": "object", "description": "Information for connecting to PostgreSQL server", "properties": { @@ -386,11 +386,12 @@ "serverName", "port" ] - }, + }, "MySqlTargetPlatform": { "type": "string", "description": "An enumeration of possible target types when migrating from MySQL", "enum": [ + "SqlServer", "AzureDbForMySQL" ], "x-ms-enum": { @@ -408,9 +409,170 @@ "MigrationFromMySQLToAzureDBForMySQL" ], "x-ms-enum": { - "name": "ServerLevelPermissionsGroup", + "name": "ServerLevelPermissionsGroup" + } + }, + "AzureActiveDirectoryApp": { + "type": "object", + "description": "Azure Active Directory Application", + "properties": { + "applicationId": { + "type": "string", + "description": "Application ID of the Azure Active Directory Application" + }, + "appKey": { + "type": "string", + "description": "Key used to authenticate to the Azure Active Directory Application" + }, + "tenantId": { + "type": "string", + "description": "Tenant id of the customer" + } + }, + "required": [ + "applicationId", + "appKey", + "tenantId" + ] + }, + "MiSqlConnectionInfo": { + "x-ms-discriminator-value": "MiSqlConnectionInfo", + "type": "object", + "description": "Properties required to create a connection to Azure SQL database Managed instance", + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "properties": { + "managedInstanceResourceId": { + "type": "string", + "description": "Resource id for Azure SQL database Managed instance" + } + }, + "required": [ + "managedInstanceResourceId" + ] + }, + "BackupSetInfo": { + "type": "object", + "description": "Information of backup set", + "properties": { + "backupSetId": { + "type": "string", + "description": "Id for the set of backup files" + }, + "firstLsn": { + "type": "string", + "description": "First log sequence number of the backup file" + }, + "lastLsn": { + "type": "string", + "description": "Last log sequence number of the backup file" + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified time of the backup file in share location" + }, + "backupType": { + "$ref": "#/definitions/BackupType", + "description": "Enum of the different backup types" + }, + "listOfBackupFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/BackupFileInfo" + }, + "description": "List of files in the backup set" + }, + "databaseName": { + "type": "string", + "description": "Name of the database to which the backup set belongs" + }, + "backupStartDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the backup operation began" + }, + "backupFinishedDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the backup operation finished" + }, + "isBackupRestored": { + "type": "boolean", + "description": "Whether the backup set is restored or not" + } + }, + "readOnly": true + }, + "BackupType": { + "type": "string", + "description": "Enum of the different backup types.", + "enum": [ + "Database", + "TransactionLog", + "File", + "DifferentialDatabase", + "DifferentialFile", + "Partial", + "DifferentialPartial" + ], + "x-ms-enum": { + "name": "BackupType", + "modelAsString": true + } + }, + "BackupFileInfo": { + "type": "object", + "description": "Information of the backup file", + "properties": { + "fileLocation": { + "type": "string", + "description": "Location of the backup file in shared folder" + }, + "familySequenceNumber": { + "type": "integer", + "description": "Sequence number of the backup file in the backup set" + }, + "status": { + "$ref": "#/definitions/BackupFileStatus", + "description": "Status of the backup file during migration" + } + }, + "readOnly": true + }, + "BackupFileStatus": { + "type": "string", + "description": "An enumeration of Status of the log backup file.", + "enum": [ + "Arrived", + "Queued", + "Uploading", + "Uploaded", + "Restoring", + "Restored", + "Cancelled" + ], + "x-ms-enum": { + "name": "BackupFileStatus", "modelAsString": true } + }, + "OrphanedUserInfo": { + "type": "object", + "description": "Information of orphaned users on the SQL server database.", + "properties": { + "name": { + "type": "string", + "description": "Name of the orphaned user" + }, + "databaseName": { + "type": "string", + "description": "Parent database of the user" + } + } } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json new file mode 100644 index 000000000000..3ca21da2dff4 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json @@ -0,0 +1,71 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToSourcePostgreSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to PostgreSQL and source server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo" + ] + }, + "ConnectToSourcePostgreSqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to PostgreSQL and source server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Version of the source server", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on source server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json new file mode 100644 index 000000000000..4b5d6d290d0f --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json @@ -0,0 +1,76 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetAzureDbForPostgreSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for target Azure Database for PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo" + ] + }, + "ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure Database for PostgreSQL and target server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Version of the target server", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on target server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json new file mode 100644 index 000000000000..8289213fcd21 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json @@ -0,0 +1,63 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetSqlMISyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure SQL Database Managed Instance online scenario.", + "properties": { + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/MiSqlConnectionInfo", + "description": "Connection information for Azure SQL Database Managed Instance" + }, + "azureApp": { + "description" : "Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account", + "$ref": "./Common.json#/definitions/AzureActiveDirectoryApp" + } + }, + "required": [ + "targetConnectionInfo", + "azureApp" + ] + }, + "ConnectToTargetSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure SQL Database Managed Instance.", + "properties": { + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json index 2c588bdc5f45..1b17b6440d70 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json @@ -333,6 +333,27 @@ "targetDatabaseName": { "type": "string", "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "migrationSetting": { + "type": "object", + "description": "Migration settings which tune the migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "sourceSetting": { + "type": "object", + "description": "Source settings to tune source endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "targetSetting": { + "type": "object", + "description": "Target settings to tune target endpoint migration behavior", + "additionalProperties": { + "type": "string" + } } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json index 510011b864ba..ba74ceddaafd 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json @@ -336,6 +336,27 @@ "targetDatabaseName": { "type": "string", "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "migrationSetting": { + "type": "object", + "description": "Migration settings which tune the migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "sourceSetting": { + "type": "object", + "description": "Source settings to tune source endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "targetSetting": { + "type": "object", + "description": "Target settings to tune target endpoint migration behavior", + "additionalProperties": { + "type": "string" + } } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json index f91c175ab0ef..5e213067b488 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json @@ -139,11 +139,11 @@ }, "readOnly": true }, - "orphanedUsers": { - "type": "string", - "description": "Map of users to database name of orphaned users.", - "additionalProperties": { - "type": "string" + "orphanedUsersInfo": { + "type": "array", + "description": "List of orphaned users.", + "items": { + "$ref": "./Common.json#/definitions/OrphanedUserInfo" }, "readOnly": true }, diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json new file mode 100644 index 000000000000..9febcfab16e1 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json @@ -0,0 +1,212 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateSqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "allOf": [ + { + "$ref": "TasksCommon.json#/definitions/SqlServerSqlMISyncTaskInput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for task that migrates SQL Server databases to Azure SQL Database Managed Instance using Log Replay Service.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigrateSqlServerSqlMISyncTaskOutputMigrationLevel": { + "type": "object", + "x-ms-discriminator-value": "MigrationLevelOutput", + "properties": { + "databaseCount": { + "type": "integer", + "description": "Count of databases", + "readOnly": true + }, + "state": { + "$ref": "TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "sourceServerName": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "targetServerName": { + "type": "string", + "description": "Target server name", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "databaseErrorCount": { + "type": "integer", + "description": "Number of database level errors", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "sourceDatabaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "migrationState": { + "$ref": "./TasksCommon.json#/definitions/DatabaseMigrationState", + "description": "Current state of database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Database migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Database migration end time", + "readOnly": true + }, + "fullBackupSetInfo": { + "type": "object", + "description": "Details of full backup set", + "$ref": "Common.json#/definitions/BackupSetInfo", + "readOnly": true + }, + "lastRestoredBackupSetInfo":{ + "type": "object", + "description": "Last applied backup set information", + "$ref": "Common.json#/definitions/BackupSetInfo", + "readOnly": true + }, + "activeBackupSets":{ + "description": "Backup sets that are currently active (Either being uploaded or getting restored)", + "type": "array", + "items": { + "$ref": "Common.json#/definitions/BackupSetInfo" + }, + "readOnly": true + }, + "containerName": { + "description": "Name of container created in the Azure Storage account where backups are copied to", + "type": "string", + "readOnly": true + }, + "errorPrefix": { + "description": "prefix string to use for querying errors for this database", + "type": "string", + "readOnly": true + }, + "isFullBackupRestored": { + "description": "Whether full backup has been applied to the target database or not", + "type": "boolean", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings", + "type": "array", + "items": { + "$ref": "Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the exception", + "readOnly": true + }, + "error": { + "$ref": "Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json index dd4ec856c195..8496860bbae8 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Azure Data Migration Service Resource Provider", + "title": "Azure Database Migration Service Resource Provider", "version": "2018-07-15-preview" }, "securityDefinitions": { diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json index 7ad603981325..194a7e9647f9 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Tasks.json @@ -178,6 +178,30 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ConnectToSourcePostgreSqlSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToSource.PostgreSql.Sync", + "type": "object", + "description": "Properties for the task that validates connection to PostgreSQL server and source server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToSourcePostgreSqlSyncTask.json#/definitions/ConnectToSourcePostgreSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToSourcePostgreSqlSyncTask.json#/definitions/ConnectToSourcePostgreSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "ConnectToTargetSqlDbTaskProperties": { "x-ms-discriminator-value": "ConnectToTarget.SqlDb", @@ -226,6 +250,30 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureDbForPostgreSql.Sync", + "type": "object", + "description": "Properties for the task that validates connection to Azure Database For PostgreSQL server and target server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetAzureDbForPostgreSqlSyncTask.json#/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetAzureDbForPostgreSqlSyncTask.json#/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "GetUserTablesSqlTaskProperties": { "x-ms-discriminator-value": "GetUserTables.Sql", @@ -298,6 +346,30 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ConnectToTargetSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for the task that validates connection to Azure SQL Database Managed Instance", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetSqlMiSyncTask.json#/definitions/ConnectToTargetSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetSqlMiSyncTask.json#/definitions/ConnectToTargetSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "ConnectToTargetAzureDbForMySqlTaskProperties": { "x-ms-discriminator-value": "ConnectToTarget.AzureDbForMySql", @@ -368,6 +440,30 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "MigrateSqlServerSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance sync scenario", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateSqlServerSqlMiSyncTask.json#/definitions/MigrateSqlServerSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateSqlServerSqlMiSyncTask.json#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "MigrateSqlServerSqlDbTaskProperties": { "x-ms-discriminator-value": "Migrate.SqlServer.SqlDb", @@ -512,6 +608,30 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ValidateMigrationInputSqlServerSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance sync scenario", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ValidateMigrationInputSqlServerSqlMiSyncTask.json#/definitions/ValidateMigrationInputSqlServerSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ValidateMigrationInputSqlServerSqlMiSyncTask.json#/definitions/ValidateMigrationInputSqlServerSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "ValidateMongoDbTaskProperties": { "x-ms-discriminator-value": "Validate.MongoDb", diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json index 42e959a5e852..5a49380c1e9c 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json @@ -304,6 +304,46 @@ "projectName", "projectLocation" ] + }, + "SqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "properties": { + "selectedDatabases": { + "description": "Databases to migrate", + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlMIDatabaseInput" + } + }, + "backupFileShare": { + "$ref": "./TasksCommon.json#/definitions/FileShare", + "description": "Backup file share information for all selected databases." + }, + "storageResourceId": { + "type": "string", + "description": "Fully qualified resourceId of storage" + }, + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Connection information for source SQL Server" + }, + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/MiSqlConnectionInfo", + "description": "Connection information for Azure SQL Database Managed Instance" + }, + "azureApp":{ + "$ref": "./Common.json#/definitions/AzureActiveDirectoryApp", + "description" : "Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account" + } + }, + "required": [ + "selectedDatabases", + "azureApp", + "sourceConnectionInfo", + "targetConnectionInfo", + "storageResourceId" + ] }, "MigrationState": { "type": "string", @@ -1122,6 +1162,26 @@ "name": "BackupType", "modelAsString": true } + }, + "DatabaseMigrationState": { + "type": "string", + "description": "Database level migration state.", + "enum": [ + "UNDEFINED", + "INITIAL", + "FULL_BACKUP_UPLOAD_START", + "LOG_SHIPPING_START", + "UPLOAD_LOG_FILES_START", + "CUTOVER_START", + "POST_CUTOVER_COMPLETE", + "COMPLETED", + "CANCELLED", + "FAILED" + ], + "x-ms-enum": { + "name": "DatabaseMigrationState", + "modelAsString": true + } } } } \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json new file mode 100644 index 000000000000..fe872c46c5bf --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json @@ -0,0 +1,54 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ValidateMigrationInputSqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "allOf": [ + { + "$ref": "TasksCommon.json#/definitions/SqlServerSqlMISyncTaskInput" + } + ] + }, + "ValidateMigrationInputSqlServerSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for task that validates migration input for Azure SQL Database Managed Instance online migration", + "properties": { + "id": { + "type": "string", + "description": "Database identifier", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of database", + "readOnly": true + }, + "validationErrors": { + "description": "Errors associated with a selected database object", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json new file mode 100644 index 000000000000..78c25f8767d4 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json @@ -0,0 +1,163 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "CommandProperties": { + "type": "object", + "description": "Base class for all types of DMS command properties. If command is not supported by current client, this object is returned.", + "x-ms-discriminator-value": "Unknown", + "properties": { + "commandType": { + "description": "Command type.", + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ODataError" + }, + "description": "Array of errors. This is ignored if submitted.", + "readOnly": true + }, + "state": { + "type": "string", + "description": "The state of the command. This is ignored if submitted.", + "enum": [ + "Unknown", + "Accepted", + "Running", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "CommandState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ "commandType" ], + "discriminator": "commandType" + }, + "MigrateSyncCompleteCommandProperties": { + "x-ms-discriminator-value": "Migrate.Sync.Complete.Database", + "type": "object", + "description": "Properties for the command that completes sync migration for a database.", + "properties": { + "input": { + "description": "Command input", + "$ref": "#/definitions/MigrateSyncCompleteCommandInput" + }, + "output": { + "description": "Command output. This is ignored if submitted.", + "$ref": "#/definitions/MigrateSyncCompleteCommandOutput", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/CommandProperties" + } + ] + }, + "MigrateSyncCompleteCommandInput": { + "type": "object", + "description": "Input for command that completes sync migration for a database.", + "properties": { + "databaseName": { + "description": "Name of database", + "type": "string" + }, + "commitTimeStamp": { + "type": "string", + "format": "date-time", + "description": "Time stamp to complete" + } + }, + "required": [ + "databaseName" + ] + }, + "MigrateSyncCompleteCommandOutput": { + "type": "object", + "description": "Output for command that completes sync migration for a database.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "errors": { + "description": "List of errors that happened during the command execution", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "MigrateMISyncCompleteCommandProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureDbSqlMi.Complete", + "type": "object", + "description": "Properties for the command that completes online migration for an Azure SQL Database Managed Instance.", + "properties": { + "input": { + "description": "Command input", + "$ref": "#/definitions/MigrateMISyncCompleteCommandInput" + }, + "output": { + "description": "Command output. This is ignored if submitted.", + "$ref": "#/definitions/MigrateMISyncCompleteCommandOutput", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/CommandProperties" + } + ] + }, + "MigrateMISyncCompleteCommandInput": { + "type": "object", + "description": "Input for command that completes online migration for an Azure SQL Database Managed Instance.", + "properties": { + "sourceDatabaseName": { + "description": "Name of managed instance database", + "type": "string" + } + }, + "required": [ + "sourceDatabaseName" + ] + }, + "MigrateMISyncCompleteCommandOutput": { + "type": "object", + "description": "Output for command that completes online migration for an Azure SQL Database Managed Instance.", + "properties": { + "errors": { + "description": "List of errors that happened during the command execution", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + } + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json index 4fa419b122ee..274bb71c32a5 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json @@ -157,6 +157,10 @@ "readOnly": true, "type": "string", "description": "Error message" + }, + "actionableMessage": { + "type": "string", + "description": "Actionable steps for this exception" }, "filePath": { "readOnly": true, @@ -252,7 +256,9 @@ "description": "Password credential." } }, - "required": [ "type" ], + "required": [ + "type" + ], "discriminator": "type" }, "AuthenticationType": { @@ -301,21 +307,265 @@ "type": "boolean", "description": "Whether to trust the server certificate", "default": false + }, + "platform": { + "$ref": "#/definitions/SqlServerSourcePlatform", + "description": "Server platform type for connection" + } + }, + "required": [ + "dataSource" + ] + }, + "SqlServerSourcePlatform": { + "type": "string", + "description": "An enumeration of source platform types", + "enum": [ + "SqlOnPrem" + ], + "x-ms-enum": { + "name": "SqlSourcePlatform", + "modelAsString": true + } + }, + "MySqlConnectionInfo": { + "x-ms-discriminator-value": "MySqlConnectionInfo", + "type": "object", + "description": "Information for connecting to MySQL server", + "properties": { + "serverName": { + "type": "string", + "description": "Name of the server" + }, + "port": { + "type": "integer", + "description": "Port for Server" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "required": [ + "serverName", + "port" + ] + }, + "PostgreSqlConnectionInfo": { + "x-ms-discriminator-value": "PostgreSqlConnectionInfo", + "type": "object", + "description": "Information for connecting to PostgreSQL server", + "properties": { + "serverName": { + "type": "string", + "description": "Name of the server" + }, + "databaseName": { + "type": "string", + "description": "Name of the database" + }, + "port": { + "type": "integer", + "description": "Port for Server" } }, - "required": [ "dataSource" ] + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "required": [ + "serverName", + "port" + ] + }, + "MySqlTargetPlatform": { + "type": "string", + "description": "An enumeration of possible target types when migrating from MySQL", + "enum": [ + "SqlServer", + "AzureDbForMySQL" + ], + "x-ms-enum": { + "name": "MySqlTargetPlatformType", + "modelAsString": true + } }, "ServerLevelPermissionsGroup": { "type": "string", "description": "Permission group for validations. These groups will run a set of permissions for validating user activity. Select the permission group for the activity that you are performing.", "enum": [ "Default", - "MigrationFromSqlServerToAzureDB" + "MigrationFromSqlServerToAzureDB", + "MigrationFromSqlServerToAzureMI", + "MigrationFromMySQLToAzureDBForMySQL" + ], + "x-ms-enum": { + "name": "ServerLevelPermissionsGroup" + } + }, + "AzureActiveDirectoryApp": { + "type": "object", + "description": "Azure Active Directory Application", + "properties": { + "applicationId": { + "type": "string", + "description": "Application ID of the Azure Active Directory Application" + }, + "appKey": { + "type": "string", + "description": "Key used to authenticate to the Azure Active Directory Application" + }, + "tenantId": { + "type": "string", + "description": "Tenant id of the customer" + } + }, + "required": [ + "applicationId", + "appKey", + "tenantId" + ] + }, + "MiSqlConnectionInfo": { + "x-ms-discriminator-value": "MiSqlConnectionInfo", + "type": "object", + "description": "Properties required to create a connection to Azure SQL database Managed instance", + "allOf": [ + { + "$ref": "#/definitions/ConnectionInfo" + } + ], + "properties": { + "managedInstanceResourceId": { + "type": "string", + "description": "Resource id for Azure SQL database Managed instance" + } + }, + "required": [ + "managedInstanceResourceId" + ] + }, + "BackupSetInfo": { + "type": "object", + "description": "Information of backup set", + "properties": { + "backupSetId": { + "type": "string", + "description": "Id for the set of backup files" + }, + "firstLsn": { + "type": "string", + "description": "First log sequence number of the backup file" + }, + "lastLsn": { + "type": "string", + "description": "Last log sequence number of the backup file" + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified time of the backup file in share location" + }, + "backupType": { + "$ref": "#/definitions/BackupType", + "description": "Enum of the different backup types" + }, + "listOfBackupFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/BackupFileInfo" + }, + "description": "List of files in the backup set" + }, + "databaseName": { + "type": "string", + "description": "Name of the database to which the backup set belongs" + }, + "backupStartDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the backup operation began" + }, + "backupFinishedDate": { + "type": "string", + "format": "date-time", + "description": "Date and time that the backup operation finished" + }, + "isBackupRestored": { + "type": "boolean", + "description": "Whether the backup set is restored or not" + } + }, + "readOnly": true + }, + "BackupType": { + "type": "string", + "description": "Enum of the different backup types.", + "enum": [ + "Database", + "TransactionLog", + "File", + "DifferentialDatabase", + "DifferentialFile", + "Partial", + "DifferentialPartial" ], "x-ms-enum": { - "name": "ServerLevelPermissionsGroup", + "name": "BackupType", "modelAsString": true } + }, + "BackupFileInfo": { + "type": "object", + "description": "Information of the backup file", + "properties": { + "fileLocation": { + "type": "string", + "description": "Location of the backup file in shared folder" + }, + "familySequenceNumber": { + "type": "integer", + "description": "Sequence number of the backup file in the backup set" + }, + "status": { + "$ref": "#/definitions/BackupFileStatus", + "description": "Status of the backup file during migration" + } + }, + "readOnly": true + }, + "BackupFileStatus": { + "type": "string", + "description": "An enumeration of Status of the log backup file.", + "enum": [ + "Arrived", + "Queued", + "Uploading", + "Uploaded", + "Restoring", + "Restored", + "Cancelled" + ], + "x-ms-enum": { + "name": "BackupFileStatus", + "modelAsString": true + } + }, + "OrphanedUserInfo": { + "type": "object", + "description": "Information of orphaned users on the SQL server database.", + "properties": { + "name": { + "type": "string", + "description": "Name of the orphaned user" + }, + "databaseName": { + "type": "string", + "description": "Parent database of the user" + } + } } } } diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json new file mode 100644 index 000000000000..3d68cdc1eaa0 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json @@ -0,0 +1,66 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToSourceMySqlTaskProperties": { + "x-ms-discriminator-value": "ConnectToSource.MySql", + "type": "object", + "description": "Properties for the task that validates MySQL database connection", + "properties": { + "input": { + "description": "Task input", + "$ref": "#/definitions/ConnectToSourceMySqlTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/ConnectToSourceNonSqlTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./Tasks.json#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToSourceMySqlTaskInput": { + "type": "object", + "description": "Input for the task that validates MySQL database connection", + "properties": { + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/MySqlConnectionInfo", + "description": "Information for connecting to MySQL source" + }, + "targetPlatform": { + "$ref": "./Common.json#/definitions/MySqlTargetPlatform", + "description": "Target Platform for the migration" + }, + "checkPermissionsGroup": { + "$ref": "./Common.json#/definitions/ServerLevelPermissionsGroup", + "description": "Permission group for validations" + } + }, + "required": [ + "sourceConnectionInfo" + ] + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json new file mode 100644 index 000000000000..7ebfe6572720 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json @@ -0,0 +1,71 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToSourcePostgreSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to PostgreSQL and source server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo" + ] + }, + "ConnectToSourcePostgreSqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to PostgreSQL and source server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Version of the source server", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on source server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json new file mode 100644 index 000000000000..165665988fd2 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json @@ -0,0 +1,76 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetAzureDbForMySqlTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure Database for MySQL and target server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source MySQL server", + "$ref": "./Common.json#/definitions/MySqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for target Azure Database for MySQL server", + "$ref": "./Common.json#/definitions/MySqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo" + ] + }, + "ConnectToTargetAzureDbForMySqlTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure Database for MySQL and target server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "serverVersion": { + "type": "string", + "description": "Version of the target server", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on target server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json new file mode 100644 index 000000000000..125af8cb47aa --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json @@ -0,0 +1,76 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetAzureDbForPostgreSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for target Azure Database for PostgreSQL server", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo" + ] + }, + "ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure Database for PostgreSQL and target server requirements", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Version of the target server", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on target server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json new file mode 100644 index 000000000000..b2c859e754dc --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json @@ -0,0 +1,79 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetSqlMITaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure SQL Database Managed Instance.", + "properties": { + "targetConnectionInfo": { + "description": "Connection information for target SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + } + }, + "required": [ + "targetConnectionInfo" + ] + }, + "ConnectToTargetSqlMITaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure SQL Database Managed Instance.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "logins": { + "type": "array", + "description": "List of logins on the target server.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "agentJobs": { + "type": "array", + "description": "List of agent jobs on the target server.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json new file mode 100644 index 000000000000..fef71c4b3fff --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json @@ -0,0 +1,63 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetSqlMISyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure SQL Database Managed Instance online scenario.", + "properties": { + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/MiSqlConnectionInfo", + "description": "Connection information for Azure SQL Database Managed Instance" + }, + "azureApp": { + "description" : "Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account", + "$ref": "./Common.json#/definitions/AzureActiveDirectoryApp" + } + }, + "required": [ + "targetConnectionInfo", + "azureApp" + ] + }, + "ConnectToTargetSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for the task that validates connection to Azure SQL Database Managed Instance.", + "properties": { + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json new file mode 100644 index 000000000000..e2d2aa742694 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json @@ -0,0 +1,39 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-07-15-preview" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ConnectToTargetSqlSqlDbSyncTaskInput": { + "type": "object", + "description": "Input for the task that validates connection to Azure SQL DB and target server requirements", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for target SQL DB", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo" + ] + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json new file mode 100644 index 000000000000..4ea9e72610b0 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json @@ -0,0 +1,90 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "GetTdeCertificatesSqlTaskInput": { + "type": "object", + "description": "Input for the task that gets TDE certificates in Base64 encoded format.", + "properties": { + "connectionInfo": { + "description": "Connection information for SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "backupFileShare": { + "$ref": "./TasksCommon.json#/definitions/FileShare", + "description": "Backup file share information for file share to be used for temporarily storing files." + }, + "selectedCertificates": { + "description": "List containing certificate names and corresponding password to use for encrypting the exported certificate.", + "type": "array", + "items": { + "$ref": "#/definitions/SelectedCertificateInput" + } + } + }, + "required": [ + "connectionInfo", + "backupFileShare", + "selectedCertificates" + ] + }, + "GetTdeCertificatesSqlTaskOutput": { + "type": "object", + "description": "Output of the task that gets TDE certificates in Base64 encoded format.", + "properties": { + "base64EncodedCertificates": { + "type": "string", + "description": "Mapping from certificate name to base 64 encoded format.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "SelectedCertificateInput": { + "type": "object", + "description": "Info for ertificate to be exported for TDE enabled databases.", + "properties": { + "certificateName": { + "type": "string", + "description": "Name of certificate to be exported." + }, + "password": { + "type": "string", + "description": "Password to use for encrypting the exported certificate." + } + }, + "required": [ + "certificateName", + "password" + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json new file mode 100644 index 000000000000..ef028f0aecde --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json @@ -0,0 +1,102 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "GetUserTablesSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that collects user tables for the given list of databases", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for SQL Server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for SQL DB", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "selectedSourceDatabases": { + "type": "array", + "description": "List of source database names to collect tables for", + "items": { + "type": "string" + } + }, + "selectedTargetDatabases": { + "type": "array", + "description": "List of target database names to collect tables for", + "items": { + "type": "string" + } + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo", + "selectedSourceDatabases", + "selectedTargetDatabases" + ] + }, + "GetUserTablesSqlSyncTaskOutput": { + "type": "object", + "description": "Output of the task that collects user tables for the given list of databases", + "properties": { + "databasesToSourceTables": { + "type": "string", + "description": "Mapping from database name to list of source tables", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/DatabaseTable" + } + }, + "readOnly": true + }, + "databasesToTargetTables": { + "type": "string", + "description": "Mapping from database name to list of target tables", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/DatabaseTable" + } + }, + "readOnly": true + }, + "tableValidationErrors": { + "type": "string", + "description": "Mapping from database name to list of validation errors", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json new file mode 100644 index 000000000000..2ff54f18f5ae --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json @@ -0,0 +1,361 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateMySqlAzureDbForMySqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations", + "properties": { + "sourceConnectionInfo": { + "description": "Connection information for source MySQL", + "$ref": "./Common.json#/definitions/MySqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Connection information for target Azure Database for MySQL", + "$ref": "./Common.json#/definitions/MySqlConnectionInfo" + }, + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncDatabaseInput" + } + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo", + "selectedDatabases" + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that migrates MySQL databases to Azure Database for MySQL for online migrations", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevel": { + "x-ms-discriminator-value": "MigrationLevelOutput", + "type": "object", + "properties": { + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServer": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServer": { + "type": "string", + "description": "Target server name", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "migrationState": { + "$ref": "./TasksCommon.json#/definitions/SyncDatabaseMigrationReportingState", + "description": "Migration state that this database is in", + "readOnly": true + }, + "incomingChanges": { + "type": "integer", + "format": "int64", + "description": "Number of incoming changes", + "readOnly": true + }, + "appliedChanges": { + "type": "integer", + "format": "int64", + "description": "Number of applied changes", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc inserts", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc deletes", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc updates", + "readOnly": true + }, + "fullLoadCompletedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables completed in full load", + "readOnly": true + }, + "fullLoadLoadingTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables loading in full load", + "readOnly": true + }, + "fullLoadQueuedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables queued in full load", + "readOnly": true + }, + "fullLoadErroredTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables errored in full load", + "readOnly": true + }, + "initializationCompleted": { + "type": "boolean", + "description": "Indicates if initial load (full load) has been completed", + "readOnly": true + }, + "latency": { + "type": "integer", + "format": "int64", + "description": "CDC apply latency", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevel": { + "type": "object", + "x-ms-discriminator-value": "TableLevelOutput", + "properties": { + "tableName": { + "type": "string", + "description": "Name of the table", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "string", + "description": "Number of applied inserts", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "string", + "description": "Number of applied updates", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "string", + "description": "Number of applied deletes", + "readOnly": true + }, + "fullLoadEstFinishTime": { + "type": "string", + "format": "date-time", + "description": "Estimate to finish full load", + "readOnly": true + }, + "fullLoadStartedOn": { + "type": "string", + "format": "date-time", + "description": "Full load start time", + "readOnly": true + }, + "fullLoadEndedOn": { + "type": "string", + "format": "date-time", + "description": "Full load end time", + "readOnly": true + }, + "fullLoadTotalRows": { + "type": "integer", + "format": "int64", + "description": "Number of rows applied in full load", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/SyncTableMigrationState", + "description": "Current state of the table migration", + "readOnly": true + }, + "totalChangesApplied": { + "type": "integer", + "format": "int64", + "description": "Total number of applied changes", + "readOnly": true + }, + "dataErrorsCounter": { + "type": "integer", + "format": "int64", + "description": "Number of data errors occurred", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified time on target", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "error": { + "$ref": "./Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseError": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelErrorOutput", + "properties": { + "errorMessage": { + "type": "string", + "description": "Error message" + }, + "events": { + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/SyncMigrationDatabaseErrorEvent" + }, + "description": "List of error events." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncDatabaseInput": { + "type": "object", + "description": "Database specific information for MySQL to Azure Database for MySQL migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "migrationSetting": { + "type": "object", + "description": "Migration settings which tune the migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "sourceSetting": { + "type": "object", + "description": "Source settings to tune source endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "targetSetting": { + "type": "object", + "description": "Target settings to tune target endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json new file mode 100644 index 000000000000..252bc334a032 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json @@ -0,0 +1,364 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput": { + "type": "object", + "description": "Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations", + "properties": { + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput" + } + }, + "targetConnectionInfo": { + "description": "Connection information for target Azure Database for PostgreSQL", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + }, + "sourceConnectionInfo": { + "description": "Connection information for source PostgreSQL", + "$ref": "./Common.json#/definitions/PostgreSqlConnectionInfo" + } + }, + "required": [ + "targetConnectionInfo", + "sourceConnectionInfo", + "selectedDatabases" + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput": { + "type": "object", + "description": "Output for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevel": { + "x-ms-discriminator-value": "MigrationLevelOutput", + "type": "object", + "properties": { + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServer": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServer": { + "type": "string", + "description": "Target server name", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "migrationState": { + "$ref": "./TasksCommon.json#/definitions/SyncDatabaseMigrationReportingState", + "description": "Migration state that this database is in", + "readOnly": true + }, + "incomingChanges": { + "type": "integer", + "format": "int64", + "description": "Number of incoming changes", + "readOnly": true + }, + "appliedChanges": { + "type": "integer", + "format": "int64", + "description": "Number of applied changes", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc inserts", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc deletes", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc updates", + "readOnly": true + }, + "fullLoadCompletedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables completed in full load", + "readOnly": true + }, + "fullLoadLoadingTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables loading in full load", + "readOnly": true + }, + "fullLoadQueuedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables queued in full load", + "readOnly": true + }, + "fullLoadErroredTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables errored in full load", + "readOnly": true + }, + "initializationCompleted": { + "type": "boolean", + "description": "Indicates if initial load (full load) has been completed", + "readOnly": true + }, + "latency": { + "type": "integer", + "format": "int64", + "description": "CDC apply latency", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevel": { + "type": "object", + "x-ms-discriminator-value": "TableLevelOutput", + "properties": { + "tableName": { + "type": "string", + "description": "Name of the table", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied inserts", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied updates", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied deletes", + "readOnly": true + }, + "fullLoadEstFinishTime": { + "type": "string", + "format": "date-time", + "description": "Estimate to finish full load", + "readOnly": true + }, + "fullLoadStartedOn": { + "type": "string", + "format": "date-time", + "description": "Full load start time", + "readOnly": true + }, + "fullLoadEndedOn": { + "type": "string", + "format": "date-time", + "description": "Full load end time", + "readOnly": true + }, + "fullLoadTotalRows": { + "type": "integer", + "format": "int64", + "description": "Number of rows applied in full load", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/SyncTableMigrationState", + "description": "Current state of the table migration", + "readOnly": true + }, + "totalChangesApplied": { + "type": "integer", + "format": "int64", + "description": "Total number of applied changes", + "readOnly": true + }, + "dataErrorsCounter": { + "type": "integer", + "format": "int64", + "description": "Number of data errors occurred", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified time on target", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "error": { + "$ref": "./Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseError": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelErrorOutput", + "properties": { + "errorMessage": { + "type": "string", + "description": "Error message" + }, + "events": { + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/SyncMigrationDatabaseErrorEvent" + }, + "description": "List of error events." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInput": { + "type": "object", + "description": "Database specific information for PostgreSQL to Azure Database for PostgreSQL migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "migrationSetting": { + "type": "object", + "description": "Migration settings which tune the migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "sourceSetting": { + "type": "object", + "description": "Source settings to tune source endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "targetSetting": { + "type": "object", + "description": "Target settings to tune target endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json new file mode 100644 index 000000000000..6556a88fd5c3 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json @@ -0,0 +1,333 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateSqlServerSqlDbSyncTaskInput": { + "type": "object", + "description": "Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations", + "properties": { + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlDbSyncDatabaseInput" + } + }, + "validationOptions": { + "description": "Validation options", + "$ref": "./MigrationValidation.json#/definitions/MigrationValidationOptions" + } + }, + "required": [ + "selectedDatabases" + ], + "allOf": [ + { + "$ref": "./TasksCommon.json#/definitions/SqlMigrationTaskInput" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskOutput": { + "type": "object", + "description": "Output for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigrateSqlServerSqlDbSyncTaskOutputMigrationLevel": { + "x-ms-discriminator-value": "MigrationLevelOutput", + "type": "object", + "properties": { + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServer": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServer": { + "type": "string", + "description": "Target server name", + "readOnly": true + }, + "databaseCount": { + "type": "integer", + "description": "Count of databases", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "migrationState": { + "$ref": "./TasksCommon.json#/definitions/SyncDatabaseMigrationReportingState", + "description": "Migration state that this database is in", + "readOnly": true + }, + "incomingChanges": { + "type": "integer", + "format": "int64", + "description": "Number of incoming changes", + "readOnly": true + }, + "appliedChanges": { + "type": "integer", + "format": "int64", + "description": "Number of applied changes", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc inserts", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc deletes", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "integer", + "format": "int64", + "description": "Number of cdc updates", + "readOnly": true + }, + "fullLoadCompletedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables completed in full load", + "readOnly": true + }, + "fullLoadLoadingTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables loading in full load", + "readOnly": true + }, + "fullLoadQueuedTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables queued in full load", + "readOnly": true + }, + "fullLoadErroredTables": { + "type": "integer", + "format": "int64", + "description": "Number of tables errored in full load", + "readOnly": true + }, + "initializationCompleted": { + "type": "boolean", + "description": "Indicates if initial load (full load) has been completed", + "readOnly": true + }, + "latency": { + "type": "integer", + "format": "int64", + "description": "CDC apply latency", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskOutputTableLevel": { + "type": "object", + "x-ms-discriminator-value": "TableLevelOutput", + "properties": { + "tableName": { + "type": "string", + "description": "Name of the table", + "readOnly": true + }, + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "cdcInsertCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied inserts", + "readOnly": true + }, + "cdcUpdateCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied updates", + "readOnly": true + }, + "cdcDeleteCounter": { + "type": "integer", + "format": "int64", + "description": "Number of applied deletes", + "readOnly": true + }, + "fullLoadEstFinishTime": { + "type": "string", + "format": "date-time", + "description": "Estimate to finish full load", + "readOnly": true + }, + "fullLoadStartedOn": { + "type": "string", + "format": "date-time", + "description": "Full load start time", + "readOnly": true + }, + "fullLoadEndedOn": { + "type": "string", + "format": "date-time", + "description": "Full load end time", + "readOnly": true + }, + "fullLoadTotalRows": { + "type": "integer", + "format": "int64", + "description": "Number of rows applied in full load", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/SyncTableMigrationState", + "description": "Current state of the table migration", + "readOnly": true + }, + "totalChangesApplied": { + "type": "integer", + "format": "int64", + "description": "Total number of applied changes", + "readOnly": true + }, + "dataErrorsCounter": { + "type": "integer", + "format": "int64", + "description": "Number of data errors occurred", + "readOnly": true + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Last modified time on target", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "error": { + "$ref": "./Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskOutputDatabaseError": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelErrorOutput", + "properties": { + "errorMessage": { + "type": "string", + "description": "Error message" + }, + "events": { + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/SyncMigrationDatabaseErrorEvent" + }, + "description": "List of error events." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + } + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json new file mode 100644 index 000000000000..ca1bec7d4ea3 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateSqlServerSqlMITaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance.", + "allOf": [ + { + "$ref": "./TasksCommon.json#/definitions/SqlMigrationTaskInput" + } + ], + "properties": { + "selectedDatabases": { + "description": "Databases to migrate", + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlMIDatabaseInput" + } + }, + "selectedLogins": { + "type": "array", + "description": "Logins to migrate.", + "items": { + "type": "string" + } + }, + "selectedAgentJobs": { + "description": "Agent Jobs to migrate.", + "type": "array", + "items": { + "type": "string" + } + }, + "backupFileShare": { + "$ref": "./TasksCommon.json#/definitions/FileShare", + "description": "Backup file share information for all selected databases." + }, + "backupBlobShare": { + "$ref": "./TasksCommon.json#/definitions/BlobShare", + "description": "SAS URI of Azure Storage Account Container to be used for storing backup files." + }, + "backupMode": { + "$ref": "./TasksCommon.json#/definitions/BackupMode", + "description": "Backup Mode to specify whether to use existing backup or create new backup. If using existing backups, backup file paths are required to be provided in selectedDatabases." + } + }, + "required": [ + "selectedDatabases", + "backupBlobShare" + ] + }, + "MigrateSqlServerSqlMITaskOutput": { + "type": "object", + "description": "Output for task that migrates SQL Server databases to Azure SQL Database Managed Instance.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigrateSqlServerSqlMITaskOutputMigrationLevel": { + "type": "object", + "x-ms-discriminator-value": "MigrationLevelOutput", + "properties": { + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "status": { + "$ref": "TasksCommon.json#/definitions/MigrationStatus", + "description": "Current status of migration", + "readOnly": true + }, + "state": { + "$ref": "TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "agentJobs": { + "type": "string", + "description": "Selected agent jobs as a map from name to id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "logins": { + "type": "string", + "description": "Selected logins as a map from name to id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration progress message", + "readOnly": true + }, + "serverRoleResults": { + "type": "string", + "description": "Map of server role migration results.", + "additionalProperties": { + "type": "object", + "description": "Server role migration result object.", + "$ref": "TasksCommon.json#/definitions/StartMigrationScenarioServerRoleResult" + }, + "readOnly": true + }, + "orphanedUsersInfo": { + "type": "array", + "description": "List of orphaned users.", + "items": { + "$ref": "./Common.json#/definitions/OrphanedUserInfo" + }, + "readOnly": true + }, + "databases": { + "type": "string", + "description": "Selected databases as a map from database name to database id", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMITaskOutput" + } + ] + }, + "MigrateSqlServerSqlMITaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "databaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "sizeMB": { + "type": "number", + "format": "double", + "description": "Size of the database in megabytes", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "stage": { + "$ref": "./TasksCommon.json#/definitions/DatabaseMigrationStage", + "description": "Current stage of migration", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration progress message", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings", + "type": "array", + "items": { + "$ref": "Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMITaskOutput" + } + ] + }, + "MigrateSqlServerSqlMITaskOutputAgentJobLevel": { + "type": "object", + "x-ms-discriminator-value": "AgentJobLevelOutput", + "properties": { + "name": { + "type": "string", + "description": "Agent Job name.", + "readOnly": true + }, + "isEnabled" : { + "type": "boolean", + "description": "The state of the original Agent Job.", + "readOnly": true + }, + "state": { + "$ref": "./TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Migration progress message", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration errors and warnings per job", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMITaskOutput" + } + ] + }, + "MigrateSqlServerSqlMITaskOutputLoginLevel": { + "type": "object", + "x-ms-discriminator-value": "LoginLevelOutput", + "properties": { + "loginName": { + "type": "string", + "description": "Login name.", + "readOnly": true + }, + "state" : { + "$ref": "TasksCommon.json#/definitions/MigrationState", + "description": "Current state of login", + "readOnly": true + }, + "stage": { + "$ref": "./TasksCommon.json#/definitions/LoginMigrationStage", + "description": "Current stage of login", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Login migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Login migration end time", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Login migration progress message", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Login migration errors and warnings per login", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMITaskOutput" + } + ] + }, + "MigrateSqlServerSqlMITaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the exception", + "readOnly": true + }, + "error": { + "$ref": "Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMITaskOutput" + } + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json new file mode 100644 index 000000000000..a377c6b0a32e --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json @@ -0,0 +1,212 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "MigrateSqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "allOf": [ + { + "$ref": "TasksCommon.json#/definitions/SqlServerSqlMISyncTaskInput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for task that migrates SQL Server databases to Azure SQL Database Managed Instance using Log Replay Service.", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "resultType": { + "description": "Result type", + "type": "string", + "readOnly": true + } + }, + "discriminator": "resultType" + }, + "MigrateSqlServerSqlMISyncTaskOutputMigrationLevel": { + "type": "object", + "x-ms-discriminator-value": "MigrationLevelOutput", + "properties": { + "databaseCount": { + "type": "integer", + "description": "Count of databases", + "readOnly": true + }, + "state": { + "$ref": "TasksCommon.json#/definitions/MigrationState", + "description": "Current state of migration", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "sourceServerName": { + "type": "string", + "description": "Source server name", + "readOnly": true + }, + "sourceServerVersion": { + "type": "string", + "description": "Source server version", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Source server brand version", + "readOnly": true + }, + "targetServerName": { + "type": "string", + "description": "Target server name", + "readOnly": true + }, + "targetServerVersion": { + "type": "string", + "description": "Target server version", + "readOnly": true + }, + "targetServerBrandVersion": { + "type": "string", + "description": "Target server brand version", + "readOnly": true + }, + "databaseErrorCount": { + "type": "integer", + "description": "Number of database level errors", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutputDatabaseLevel": { + "type": "object", + "x-ms-discriminator-value": "DatabaseLevelOutput", + "properties": { + "sourceDatabaseName": { + "type": "string", + "description": "Name of the database", + "readOnly": true + }, + "migrationState": { + "$ref": "./TasksCommon.json#/definitions/DatabaseMigrationState", + "description": "Current state of database", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Database migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Database migration end time", + "readOnly": true + }, + "fullBackupSetInfo": { + "type": "object", + "description": "Details of full backup set", + "$ref": "Common.json#/definitions/BackupSetInfo", + "readOnly": true + }, + "lastRestoredBackupSetInfo":{ + "type": "object", + "description": "Last applied backup set information", + "$ref": "Common.json#/definitions/BackupSetInfo", + "readOnly": true + }, + "activeBackupSets":{ + "description": "Backup sets that are currently active (Either being uploaded or getting restored)", + "type": "array", + "items": { + "$ref": "Common.json#/definitions/BackupSetInfo" + }, + "readOnly": true + }, + "containerName": { + "description": "Name of container created in the Azure Storage account where backups are copied to", + "type": "string", + "readOnly": true + }, + "errorPrefix": { + "description": "prefix string to use for querying errors for this database", + "type": "string", + "readOnly": true + }, + "isFullBackupRestored": { + "description": "Whether full backup has been applied to the target database or not", + "type": "boolean", + "readOnly": true + }, + "exceptionsAndWarnings": { + "description": "Migration exceptions and warnings", + "type": "array", + "items": { + "$ref": "Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskOutputError": { + "type": "object", + "x-ms-discriminator-value": "ErrorOutput", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the exception", + "readOnly": true + }, + "error": { + "$ref": "Common.json#/definitions/ReportableException", + "description": "Migration error", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + } + ] + } + } +} diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json index 7110a241237d..7e5fae465868 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json @@ -31,7 +31,8 @@ "items": { "$ref": "./Common.json#/definitions/ODataError" }, - "description": "Array of errors. This is ignored if submitted." + "description": "Array of errors. This is ignored if submitted.", + "readOnly": true }, "state": { "type": "string", @@ -51,7 +52,15 @@ "modelAsString": true }, "readOnly": true - } + }, + "commands": { + "description": "Array of command properties.", + "type": "array", + "items": { + "$ref": "./Commands.json#/definitions/CommandProperties" + }, + "readOnly": true + } }, "required": [ "taskType" ], "discriminator": "taskType" @@ -115,6 +124,54 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ConnectToSourceSqlServerSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToSource.SqlServer.Sync", + "type": "object", + "description": "Properties for the task that validates connection to SQL Server and source server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToSourceSqlServerTask.json#/definitions/ConnectToSourceSqlServerTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToSourceSqlServerTask.json#/definitions/ConnectToSourceSqlServerTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToSourcePostgreSqlSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToSource.PostgreSql.Sync", + "type": "object", + "description": "Properties for the task that validates connection to PostgreSQL server and source server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToSourcePostgreSqlSyncTask.json#/definitions/ConnectToSourcePostgreSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToSourcePostgreSqlSyncTask.json#/definitions/ConnectToSourcePostgreSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "ConnectToTargetSqlDbTaskProperties": { "x-ms-discriminator-value": "ConnectToTarget.SqlDb", @@ -139,6 +196,54 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "ConnectToTargetSqlSqlDbSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.SqlDb.Sync", + "type": "object", + "description": "Properties for the task that validates connection to SQL DB and target server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetSqlSqlDbSyncTask.json#/definitions/ConnectToTargetSqlSqlDbSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetSqlDbTask.json#/definitions/ConnectToTargetSqlDbTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToTargetAzureDbForPostgreSqlSyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureDbForPostgreSql.Sync", + "type": "object", + "description": "Properties for the task that validates connection to Azure Database For PostgreSQL server and target server requirements for online migration", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetAzureDbForPostgreSqlSyncTask.json#/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetAzureDbForPostgreSqlSyncTask.json#/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "GetUserTablesSqlTaskProperties": { "x-ms-discriminator-value": "GetUserTables.Sql", @@ -163,6 +268,150 @@ "$ref": "#/definitions/ProjectTaskProperties" } ] + }, + "GetUserTablesSqlSyncTaskProperties": { + "x-ms-discriminator-value": "GetUserTables.AzureSqlDb.Sync", + "type": "object", + "description": "Properties for the task that collects user tables for the given list of databases", + "properties": { + "input": { + "description": "Task input", + "$ref": "./GetUserTablesSqlSyncTask.json#/definitions/GetUserTablesSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./GetUserTablesSqlSyncTask.json#/definitions/GetUserTablesSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToTargetSqlMITaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureSqlDbMI", + "type": "object", + "description": "Properties for the task that validates connection to Azure SQL Database Managed Instance", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetSqlMITask.json#/definitions/ConnectToTargetSqlMITaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetSqlMITask.json#/definitions/ConnectToTargetSqlMITaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToTargetSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for the task that validates connection to Azure SQL Database Managed Instance", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetSqlMiSyncTask.json#/definitions/ConnectToTargetSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetSqlMiSyncTask.json#/definitions/ConnectToTargetSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ConnectToTargetAzureDbForMySqlTaskProperties": { + "x-ms-discriminator-value": "ConnectToTarget.AzureDbForMySql", + "type": "object", + "description": "Properties for the task that validates connection to Azure Database for MySQL and target server requirements", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ConnectToTargetAzureDbForMySqlTask.json#/definitions/ConnectToTargetAzureDbForMySqlTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ConnectToTargetAzureDbForMySqlTask.json#/definitions/ConnectToTargetAzureDbForMySqlTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigrateSqlServerSqlMITaskProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureSqlDbMI", + "type": "object", + "description": "Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateSqlServerSqlMITask.json#/definitions/MigrateSqlServerSqlMITaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateSqlServerSqlMITask.json#/definitions/MigrateSqlServerSqlMITaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigrateSqlServerSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance sync scenario", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateSqlServerSqlMiSyncTask.json#/definitions/MigrateSqlServerSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateSqlServerSqlMiSyncTask.json#/definitions/MigrateSqlServerSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] }, "MigrateSqlServerSqlDbTaskProperties": { "x-ms-discriminator-value": "Migrate.SqlServer.SqlDb", @@ -182,6 +431,174 @@ "readOnly": true } }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigrateSqlServerSqlDbSyncTaskProperties": { + "x-ms-discriminator-value": "Migrate.SqlServer.AzureSqlDb.Sync", + "type": "object", + "description": "Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateSqlServerSqlDbSyncTask.json#/definitions/MigrateSqlServerSqlDbSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateSqlServerSqlDbSyncTask.json#/definitions/MigrateSqlServerSqlDbSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigrateMySqlAzureDbForMySqlSyncTaskProperties": { + "x-ms-discriminator-value": "Migrate.MySql.AzureDbForMySql.Sync", + "type": "object", + "description": "Properties for the task that migrates MySQL databases to Azure Database for MySQL for online migrations", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigrateMySqlAzureDbForMySqlSyncTask.json#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigrateMySqlAzureDbForMySqlSyncTask.json#/definitions/MigrateMySqlAzureDbForMySqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "MigratePostgreSqlAzureDbForPostgreSqlSyncTaskProperties": { + "x-ms-discriminator-value": "Migrate.PostgreSql.AzureDbForPostgreSql.Sync", + "type": "object", + "description": "Properties for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations", + "properties": { + "input": { + "description": "Task input", + "$ref": "./MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json#/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ValidateMigrationInputSqlServerSqlDbSyncTaskProperties": { + "x-ms-discriminator-value": "ValidateMigrationInput.SqlServer.SqlDb.Sync", + "type": "object", + "description": "Properties for task that validates migration input for SQL to Azure SQL DB sync migrations", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ValidateSyncMigrationInputSqlServerTask.json#/definitions/ValidateSyncMigrationInputSqlServerTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ValidateSyncMigrationInputSqlServerTask.json#/definitions/ValidateSyncMigrationInputSqlServerTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ValidateMigrationInputSqlServerSqlMITaskProperties": { + "x-ms-discriminator-value": "ValidateMigrationInput.SqlServer.AzureSqlDbMI", + "type": "object", + "description": "Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ValidateMigrationInputSqlServerSqlMITask.json#/definitions/ValidateMigrationInputSqlServerSqlMITaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ValidateMigrationInputSqlServerSqlMITask.json#/definitions/ValidateMigrationInputSqlServerSqlMITaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "ValidateMigrationInputSqlServerSqlMISyncTaskProperties": { + "x-ms-discriminator-value": "ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS", + "type": "object", + "description": "Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance sync scenario", + "properties": { + "input": { + "description": "Task input", + "$ref": "./ValidateMigrationInputSqlServerSqlMiSyncTask.json#/definitions/ValidateMigrationInputSqlServerSqlMISyncTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./ValidateMigrationInputSqlServerSqlMiSyncTask.json#/definitions/ValidateMigrationInputSqlServerSqlMISyncTaskOutput" + }, + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProjectTaskProperties" + } + ] + }, + "GetTdeCertificatesSqlTaskProperties": { + "x-ms-discriminator-value": "GetTDECertificates.Sql", + "type": "object", + "description": "Properties for the task that gets TDE certificates in Base64 encoded format.", + "properties": { + "input": { + "description": "Task input", + "$ref": "./GetTdeCertificatesSqlTask.json#/definitions/GetTdeCertificatesSqlTaskInput" + }, + "output": { + "description": "Task output. This is ignored if submitted.", + "type": "array", + "items": { + "$ref": "./GetTdeCertificatesSqlTask.json#/definitions/GetTdeCertificatesSqlTaskOutput" + }, + "readOnly": true + } + }, "allOf": [ { "$ref": "#/definitions/ProjectTaskProperties" diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json index 72e5f0b4b33e..1be5627d0562 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json @@ -287,6 +287,80 @@ } } } + }, + "DatabaseTable": { + "type": "object", + "description": "Table properties", + "properties": { + "hasRows": { + "type": "boolean", + "description": "Indicates whether table is empty or not", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Schema-qualified name of the table", + "readOnly": true + } + } + }, + "GetProjectDetailsNonSqlTaskInput": { + "type": "object", + "description": "Input for the task that reads configuration from project artifacts", + "properties": { + "projectName": { + "type": "string", + "description": "Name of the migration project" + }, + "projectLocation": { + "type": "string", + "description": "A URL that points to the location to access project artifacts" + } + }, + "required": [ + "projectName", + "projectLocation" + ] + }, + "SqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "properties": { + "selectedDatabases": { + "description": "Databases to migrate", + "type": "array", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlMIDatabaseInput" + } + }, + "backupFileShare": { + "$ref": "./TasksCommon.json#/definitions/FileShare", + "description": "Backup file share information for all selected databases." + }, + "storageResourceId": { + "type": "string", + "description": "Fully qualified resourceId of storage" + }, + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Connection information for source SQL Server" + }, + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/MiSqlConnectionInfo", + "description": "Connection information for Azure SQL Database Managed Instance" + }, + "azureApp":{ + "$ref": "./Common.json#/definitions/AzureActiveDirectoryApp", + "description" : "Azure Active Directory Application the DMS instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account" + } + }, + "required": [ + "selectedDatabases", + "azureApp", + "sourceConnectionInfo", + "targetConnectionInfo", + "storageResourceId" + ] }, "MigrationState": { "type": "string", @@ -342,6 +416,81 @@ "sourceConnectionInfo", "targetConnectionInfo" ] + }, + "MigrateSqlServerSqlDbDatabaseInput": { + "type": "object", + "description": "Database specific information for SQL to Azure SQL DB migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "targetDatabaseName": { + "type": "string", + "description": "Name of target database. Note: Target database will be truncated before starting migration." + }, + "makeSourceDbReadOnly": { + "type": "boolean", + "description": "Whether to set database read only before migration" + }, + "tableMap": { + "type": "object", + "description": "Mapping of source to target tables", + "additionalProperties": { + "type": "string" + } + } + } + }, + "MigrateSqlServerSqlDbSyncDatabaseInput": { + "type": "object", + "description": "Database specific information for SQL to Azure SQL DB sync migration task inputs", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for database" + }, + "name": { + "type": "string", + "description": "Name of database" + }, + "targetDatabaseName": { + "type": "string", + "description": "Target database name" + }, + "schemaName": { + "type": "string", + "description": "Schema name to be migrated" + }, + "tableMap": { + "type": "object", + "description": "Mapping of source to target tables", + "additionalProperties": { + "type": "string" + } + }, + "migrationSetting": { + "type": "object", + "description": "Migration settings which tune the migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "sourceSetting": { + "type": "object", + "description": "Source settings to tune source endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + }, + "targetSetting": { + "type": "object", + "description": "Target settings to tune target endpoint migration behavior", + "additionalProperties": { + "type": "string" + } + } + } }, "MigrationTableMetadata": { "type": "object", @@ -358,6 +507,162 @@ "readOnly": true } } + }, + "NonSqlMigrationTaskInput": { + "type": "object", + "description": "Base class for non sql migration task input", + "properties": { + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Information for connecting to target" + }, + "targetDatabaseName": { + "type": "string", + "description": "Target database name" + }, + "projectName": { + "type": "string", + "description": "Name of the migration project" + }, + "projectLocation": { + "type": "string", + "description": "A URL that points to the drop location to access project artifacts" + }, + "selectedTables": { + "type": "array", + "description": "Metadata of the tables selected for migration", + "items": { + "$ref": "#/definitions/NonSqlDataMigrationTable" + } + } + }, + "required": [ + "targetConnectionInfo", + "targetDatabaseName", + "projectName", + "projectLocation", + "selectedTables" + ] + }, + "NonSqlDataMigrationTable": { + "type": "object", + "description": "Defines metadata for table to be migrated", + "properties": { + "sourceName": { + "type": "string", + "description": "Source table name" + } + } + }, + "NonSqlMigrationTaskOutput": { + "type": "object", + "description": "Base class for non sql migration task output", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "startedOn": { + "type": "string", + "format": "date-time", + "description": "Migration start time", + "readOnly": true + }, + "endedOn": { + "type": "string", + "format": "date-time", + "description": "Migration end time", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/MigrationStatus", + "description": "Current state of migration", + "readOnly": true + }, + "dataMigrationTableResults": { + "type": "string", + "description": "Results of the migration. The key contains the table name and the value the table result object", + "additionalProperties": { + "$ref": "#/definitions/NonSqlDataMigrationTableResult" + }, + "readOnly": true + }, + "progressMessage": { + "type": "string", + "description": "Message about the progress of the migration", + "readOnly": true + }, + "sourceServerName": { + "type": "string", + "description": "Name of source server", + "readOnly": true + }, + "targetServerName": { + "type": "string", + "description": "Name of target server", + "readOnly": true + } + } + }, + "NonSqlDataMigrationTableResult": { + "type": "object", + "description": "Object used to report the data migration results of a table", + "properties": { + "resultCode": { + "type": "string", + "description": "Result code of the data migration", + "enum": [ + "Initial", + "Completed", + "ObjectNotExistsInSource", + "ObjectNotExistsInTarget", + "TargetObjectIsInaccessible", + "FatalError" + ], + "x-ms-enum": { + "name": "DataMigrationResultCode", + "modelAsString": true + }, + "readOnly": true + }, + "sourceName": { + "type": "string", + "description": "Name of the source table", + "readOnly": true + }, + "targetName": { + "type": "string", + "description": "Name of the target table", + "readOnly": true + }, + "sourceRowCount": { + "type": "integer", + "format": "int64", + "description": "Number of rows in the source table", + "readOnly": true + }, + "targetRowCount": { + "type": "integer", + "format": "int64", + "description": "Number of rows in the target table", + "readOnly": true + }, + "elapsedTimeInMiliseconds": { + "type": "number", + "format": "double", + "description": "Time taken to migrate the data", + "readOnly": true + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/DataMigrationError" + }, + "description": "List of errors, if any, during migration", + "readOnly": true + } + } }, "DataMigrationError": { "type": "object", @@ -387,9 +692,9 @@ "modelAsString": true } }, - "MigrateSqlServerSqlServerDatabaseInput": { + "MigrateSqlServerSqlMIDatabaseInput": { "type": "object", - "description": "Database specific information for SQL to SQL migration task inputs", + "description": "Database specific information for SQL to Azure SQL DB Managed Instance migration task inputs", "properties": { "name": { "type": "string", @@ -401,7 +706,36 @@ }, "backupFileShare": { "$ref": "#/definitions/FileShare", - "description": "Backup file share information for this database." + "description": "Backup file share information for backing up this database." + }, + "backupFilePaths": { + "type": "array", + "description": "The list of backup files to be used in case of existing backups.", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "restoreDatabaseName" + ] + }, + "MigrateSqlServerSqlServerDatabaseInput": { + "type": "object", + "description": "Database specific information for SQL to SQL migration task inputs", + "properties": { + "name": { + "type": "string", + "description": "Name of the database" + }, + "restoreDatabaseName": { + "type": "string", + "description": "Name of the database at destination" + }, + "backupAndRestoreFolder": { + "type": "string", + "description": "The backup and restore folder" }, "databaseFiles": { "type": "array", @@ -487,6 +821,79 @@ "name": "DatabaseFileType", "modelAsString": true } + }, + "ConnectToSourceNonSqlTaskOutput": { + "type": "object", + "description": "Output for connect to Oracle, MySQL type source", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "sourceServerBrandVersion": { + "type": "string", + "description": "Server brand version", + "readOnly": true + }, + "serverProperties": { + "$ref": "#/definitions/ServerProperties", + "description": "Server properties", + "readOnly": true + }, + "databases": { + "type": "array", + "description": "List of databases on the server", + "items": { + "type": "string" + }, + "readOnly": true + }, + "validationErrors": { + "description": "Validation errors associated with the task", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + }, + "ServerProperties": { + "type": "object", + "description": "Server properties for Oracle, MySQL type source", + "properties": { + "serverPlatform": { + "type": "string", + "description": "Name of the server platform", + "readOnly": true + }, + "serverName": { + "type": "string", + "description": "Name of the server", + "readOnly": true + }, + "serverVersion": { + "type": "string", + "description": "Version of the database server", + "readOnly": true + }, + "serverEdition": { + "type": "string", + "description": "Edition of the database server", + "readOnly": true + }, + "serverOperatingSystemVersion": { + "type": "string", + "description": "Version of the operating system", + "readOnly": true + }, + "serverDatabaseCount": { + "type": "integer", + "description": "Number of databases in the server", + "readOnly": true + } + } }, "DatabaseMigrationStage": { "type": "string", @@ -503,6 +910,26 @@ "name": "DatabaseMigrationStage", "modelAsString": true } + }, + "SchemaMigrationStage": { + "type": "string", + "description": "Current stage of schema migration", + "enum": [ + "NotStarted", + "ValidatingInputs", + "CollectingObjects", + "DownloadingScript", + "GeneratingScript", + "UploadingScript", + "DeployingSchema", + "Completed", + "CompletedWithWarnings", + "Failed" + ], + "x-ms-enum": { + "name": "SchemaMigrationStage", + "modelAsString": true + } }, "BlobShare": { "type": "object", @@ -540,7 +967,7 @@ }, "StartMigrationScenarioServerRoleResult": { "type": "object", - "description": "Migration results from a server role.", + "description": "Server role migration result", "properties": { "name": { "type": "string", @@ -575,7 +1002,8 @@ "ExternalGroup" ], "x-ms-enum": { - "name": "LoginType" + "name": "LoginType", + "modelAsString": true } }, "LoginMigrationStage": { @@ -593,7 +1021,8 @@ "Completed" ], "x-ms-enum": { - "name": "LoginMigrationStage" + "name": "LoginMigrationStage", + "modelAsString": true } }, "MigrationEligibilityInfo": { @@ -614,6 +1043,163 @@ "readOnly": true } } + }, + "SyncDatabaseMigrationReportingState": { + "type": "string", + "description": "Enum of the different state of database level online migration.", + "enum": [ + "UNDEFINED", + "CONFIGURING", + "INITIALIAZING", + "STARTING", + "RUNNING", + "READY_TO_COMPLETE", + "COMPLETING", + "COMPLETE", + "CANCELLING", + "CANCELLED", + "FAILED" + ], + "x-ms-enum": { + "name": "SyncDatabaseMigrationReportingState", + "modelAsString": true + } + }, + "SyncTableMigrationState": { + "type": "string", + "description": "Enum of the different state of table level online migration.", + "enum": [ + "BEFORE_LOAD", + "FULL_LOAD", + "COMPLETED", + "CANCELED", + "ERROR", + "FAILED" + ], + "x-ms-enum": { + "name": "SyncTableMigrationState", + "modelAsString": true + } + }, + "SyncMigrationDatabaseErrorEvent": { + "type": "object", + "description": "Database migration errors for online migration", + "properties": { + "timestampString": { + "type": "string", + "description": "String value of timestamp.", + "readOnly": true + }, + "eventTypeString": { + "description": "Event type.", + "type": "string", + "readOnly": true + }, + "eventText": { + "description": "Event text.", + "type": "string", + "readOnly": true + } + } + }, + "BackupMode": { + "type": "string", + "description": "An enumeration of backup modes", + "enum": [ + "CreateBackup", + "ExistingBackup" + ], + "x-ms-enum": { + "name": "BackupMode", + "modelAsString": true + } + }, + "DatabaseBackupInfo": { + "type": "object", + "description": "Information about backup files when existing backup mode is used.", + "properties": { + "databaseName": { + "type": "string", + "description": "Database name.", + "readOnly": true + }, + "backupType": { + "description": "Backup Type.", + "$ref": "#/definitions/BackupType", + "readOnly": true + }, + "backupFiles": { + "type": "array", + "description": "The list of backup files for the current database.", + "items": { + "type": "string" + }, + "readOnly": true + }, + "position": { + "description": "Position of current database backup in the file.", + "type": "integer", + "readOnly": true + }, + "isDamaged": { + "type": "boolean", + "description": "Database was damaged when backed up, but the backup operation was requested to continue despite errors.", + "readOnly": true + }, + "isCompressed": { + "type": "boolean", + "description": "Whether the backup set is compressed", + "readOnly": true + }, + "familyCount": { + "type": "integer", + "description": "Number of files in the backup set.", + "readOnly": true + }, + "backupFinishDate": { + "type": "string", + "format": "date-time", + "description": "Date and time when the backup operation finished.", + "readOnly": true + } + } + }, + "BackupType": { + "type": "string", + "description": "Enum of the different backup types.", + "enum": [ + "Database", + "TransactionLog", + "File", + "DifferentialDatabase", + "DifferentialFile", + "Partial", + "DifferentialPartial" + ], + "x-ms-enum": { + "name": "BackupType", + "modelAsString": true + } + }, + "DatabaseMigrationState": { + "type": "string", + "description": "Database level migration state.", + "enum": [ + "UNDEFINED", + "INITIAL", + "FULL_BACKUP_UPLOAD_START", + "LOG_SHIPPING_START", + "UPLOAD_LOG_FILES_START", + "CUTOVER_START", + "POST_CUTOVER_COMPLETE", + "COMPLETED", + "CANCELLED", + "FAILED" + ], + "x-ms-enum": { + "name": "DatabaseMigrationState", + "modelAsString": true + } } } -} +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json new file mode 100644 index 000000000000..672a54b1cbcf --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json @@ -0,0 +1,127 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ValidateMigrationInputSqlServerSqlMITaskInput": { + "type": "object", + "description": "Input for task that validates migration input for SQL to Azure SQL Managed Instance", + "properties": { + "sourceConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Information for connecting to source" + }, + "targetConnectionInfo": { + "$ref": "./Common.json#/definitions/SqlConnectionInfo", + "description": "Information for connecting to target" + }, + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlMIDatabaseInput" + } + }, + "selectedLogins": { + "type": "array", + "description": "Logins to migrate", + "items": { + "type": "string" + } + }, + "backupFileShare": { + "$ref": "./TasksCommon.json#/definitions/FileShare", + "description": "Backup file share information for all selected databases." + }, + "backupBlobShare": { + "$ref": "./TasksCommon.json#/definitions/BlobShare", + "description": "SAS URI of Azure Storage Account Container to be used for storing backup files." + }, + "backupMode": { + "$ref": "./TasksCommon.json#/definitions/BackupMode", + "description": "Backup Mode to specify whether to use existing backup or create new backup." + } + }, + "required": [ + "sourceConnectionInfo", + "targetConnectionInfo", + "selectedDatabases", + "backupBlobShare" + ] + }, + "ValidateMigrationInputSqlServerSqlMITaskOutput": { + "type": "object", + "description": "Output for task that validates migration input for SQL to Azure SQL Managed Instance migrations", + "properties": { + "id": { + "type": "string", + "description": "Result identifier", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of database", + "readOnly": true + }, + "restoreDatabaseNameErrors": { + "description": "Errors associated with the RestoreDatabaseName", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "backupFolderErrors": { + "description": "Errors associated with the BackupFolder path", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "backupShareCredentialsErrors": { + "description": "Errors associated with backup share user name and password credentials", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "backupStorageAccountErrors": { + "description": "Errors associated with the storage account provided.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "existingBackupErrors": { + "description": "Errors associated with existing backup files.", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + }, + "databaseBackupInfo": { + "$ref": "./TasksCommon.json#/definitions/DatabaseBackupInfo", + "description": "Information about backup files when existing backup mode is used." + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json new file mode 100644 index 000000000000..1dc1ec762509 --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json @@ -0,0 +1,54 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ValidateMigrationInputSqlServerSqlMISyncTaskInput": { + "type": "object", + "description": "Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario.", + "allOf": [ + { + "$ref": "TasksCommon.json#/definitions/SqlServerSqlMISyncTaskInput" + } + ] + }, + "ValidateMigrationInputSqlServerSqlMISyncTaskOutput": { + "type": "object", + "description": "Output for task that validates migration input for Azure SQL Database Managed Instance online migration", + "properties": { + "id": { + "type": "string", + "description": "Database identifier", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of database", + "readOnly": true + }, + "validationErrors": { + "description": "Errors associated with a selected database object", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} \ No newline at end of file diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json new file mode 100644 index 000000000000..0210c0ebcd7e --- /dev/null +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json @@ -0,0 +1,71 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Database Migration Service Resource Provider", + "version": "2018-04-19" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ValidateSyncMigrationInputSqlServerTaskInput": { + "type": "object", + "description": "Input for task that validates migration input for SQL sync migrations", + "properties": { + "sourceConnectionInfo": { + "description": "Information for connecting to source SQL server", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "targetConnectionInfo": { + "description": "Information for connecting to target", + "$ref": "./Common.json#/definitions/SqlConnectionInfo" + }, + "selectedDatabases": { + "type": "array", + "description": "Databases to migrate", + "items": { + "$ref": "./TasksCommon.json#/definitions/MigrateSqlServerSqlDbSyncDatabaseInput" + } + } + }, + "required": [ + "targetConnectionInfo", + "sourceConnectionInfo", + "selectedDatabases" + ] + }, + "ValidateSyncMigrationInputSqlServerTaskOutput": { + "type": "object", + "description": "Output for task that validates migration input for SQL sync migrations", + "properties": { + "id": { + "type": "string", + "description": "Database identifier", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Name of database", + "readOnly": true + }, + "validationErrors": { + "description": "Errors associated with a selected database object", + "type": "array", + "items": { + "$ref": "./Common.json#/definitions/ReportableException" + }, + "readOnly": true + } + } + } + } +} diff --git a/specification/datamigration/resource-manager/readme.md b/specification/datamigration/resource-manager/readme.md index 8a0cf304bde5..46f1fbd3cfcc 100644 --- a/specification/datamigration/resource-manager/readme.md +++ b/specification/datamigration/resource-manager/readme.md @@ -38,16 +38,34 @@ These settings apply only when `--tag=package-2018-04-19` is specified on the co ``` yaml $(tag) == 'package-2018-04-19' input-file: - Microsoft.DataMigration/stable/2018-04-19/datamigration.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/Commands.json - Microsoft.DataMigration/stable/2018-04-19/definitions/Common.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceMySqlTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourcePostgreSqlSyncTask.json - Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToSourceSqlServerTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForMySqlTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json - Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlDbTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMITask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlMiSyncTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ConnectToTargetSqlSqlDbSyncTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlSyncTask.json - Microsoft.DataMigration/stable/2018-04-19/definitions/GetUserTablesSqlTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateMySqlAzureDbForMySqlSyncTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbSyncTask.json - Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlDbTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMITask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/MigrateSqlServerSqlMiSyncTask.json - Microsoft.DataMigration/stable/2018-04-19/definitions/Projects.json - Microsoft.DataMigration/stable/2018-04-19/definitions/Services.json - Microsoft.DataMigration/stable/2018-04-19/definitions/Tasks.json - Microsoft.DataMigration/stable/2018-04-19/definitions/TasksCommon.json - Microsoft.DataMigration/stable/2018-04-19/definitions/MigrationValidation.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMITask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json +- Microsoft.DataMigration/stable/2018-04-19/definitions/ValidateSyncMigrationInputSqlServerTask.json ``` ### Tag: package-2018-07-15-preview @@ -61,10 +79,13 @@ input-file: - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/Common.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceMySqlTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourceSqlServerTask.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToSourcePostgreSqlSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForMySqlTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlDbTask.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMiSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlMITask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetSqlSqlDbSyncTask.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ConnectToTargetAzureDbForPostgreSqlSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetUserTablesSqlSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/GetUserTablesSqlTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSchemaSqlServerSqlDbTask.json @@ -72,6 +93,7 @@ input-file: - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigratePostgreSqlAzureDbForPostgreSqlSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlDbSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlDbTask.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMiSyncTask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrateSqlServerSqlMITask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MigrationValidation.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/MongoDbTasks.json @@ -82,6 +104,7 @@ input-file: - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/TasksCommon.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMITask.json - Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateSyncMigrationInputSqlServerTask.json +- Microsoft.DataMigration/preview/2018-07-15-preview/definitions/ValidateMigrationInputSqlServerSqlMiSyncTask.json ``` ### Tag: package-2018-03-31-preview From 7ec885283c68528b8d25f5ec533bcfd310b10c0f Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Fri, 14 Dec 2018 10:15:18 -0800 Subject: [PATCH 433/464] EventHub: 2018-preview - added new API for NetworkRuleSet (#4748) * added new NetworkRule APIs * updated lowerCamelCase for Parameters * pluralize NetworkRuleSets * fixed lint errors * fixed typo and updated examples files names for NetworkRuleSets * updated resource type name in url with plural and lowerCamelCase --- .../2018-01-01-preview/EventHub-preview.json | 3086 +++++++++-------- .../EHNetworkRuleSetCreate.json | 103 + .../EHNetworkRuleSetGet.json | 56 + 3 files changed, 1836 insertions(+), 1409 deletions(-) create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json create mode 100644 specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json index f7f1fdfe35ea..b14aa2e86ebe 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/EventHub-preview.json @@ -1,1411 +1,1679 @@ { - "swagger": "2.0", - "info": { - "title": "EventHub2018PreviewManagementClient", - "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", - "version": "2018-01-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [{ - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.EventHub/operations": { - "get": { - "tags": [ - "Operations" - ], - "operationId": "Operations_List", - "x-ms-examples": { - "EHOperations_List": { - "$ref": "./examples/Operations_List.json" - } - }, - "description": "Lists all of the available Event Hub REST API operations.", - "parameters": [{ - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { - "get": { - "tags": [ - "Event Hubs Clusters" - ], - "operationId": "Clusters_ListByResourceGroup", - "x-ms-examples": { - "ClustersListByResourceGroup": { - "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" - } - }, - "description": "Lists the available Event Hubs Clusters within an ARM resource group.", - "parameters": [{ - "$ref": "#/parameters/SubscriptionIdParameter" - }, { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Clusters returned successfully.", - "schema": { - "$ref": "#/definitions/ClusterListResult" - } - }, - "default": { - "description": "Event Hub Cluster error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { - "get": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Get", - "x-ms-examples": { - "ClusterGet": { - "$ref": "./examples/Clusters/ClusterGet.json" - } - }, - "description": "Gets the resource description of the specified Event Hubs Cluster.", - "parameters": [{ - "$ref": "#/parameters/SubscriptionIdParameter" - }, { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ClusterNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster resource description returned successfully.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Event Hubs Cluster" - ], - "operationId": "Clusters_Patch", - "x-ms-examples": { - "ClusterPatch": { - "$ref": "./examples/Clusters/ClusterPatch.json" - } - }, - "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", - "parameters": [{ - "$ref": "#/parameters/SubscriptionIdParameter" - }, { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ClusterNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - }, - "description": "The properties of the Event Hubs Cluster which should be updated." - } - ], - "responses": { - "200": { - "description": "Event Hubs Cluster successfully created.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "Event Hubs Cluster update request accepted.", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { - "patch": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Patch", - "parameters": [{ - "$ref": "#/parameters/SubscriptionIdParameter" - }, { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ClusterNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties", - "required": [ - "settings" - ] - }, - "description": "Parameters for creating an Event Hubs Cluster resource." - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationPatch": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" - } - }, - "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "201": { - "description": "Event Hubs Cluster setting configuration request successfully accepted.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "202": { - "description": "Event Hubs Cluster update request accepted." - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Event Hubs Cluster Configuration" - ], - "operationId": "Configuration_Get", - "parameters": [{ - "$ref": "#/parameters/SubscriptionIdParameter" - }, { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ClusterNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "x-ms-examples": { - "ClustersQuotasConfigurationGet": { - "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" - } - }, - "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", - "responses": { - "200": { - "description": "Event Hubs Cluster settings configuration returned.", - "schema": { - "$ref": "#/definitions/ClusterQuotaConfigurationProperties" - } - }, - "default": { - "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_List", - "x-ms-examples": { - "NamespacesListBySubscription": { - "$ref": "./examples/NameSpaces/EHNameSpaceList.json" - } - }, - "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", - "parameters": [{ - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListByResourceGroup", - "x-ms-examples": { - "NamespaceListByResourceGroup": { - "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" - } - }, - "description": "Lists the available Namespaces within a resource group.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespaces returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespaceListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdate", - "x-ms-examples": { - "NamespaceCreate": { - "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace", - "required": [ - "location" - ] - }, - "description": "Parameters for creating a namespace resource." - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace create request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "200": { - "description": "Namespace successfully created.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Delete", - "x-ms-examples": { - "NameSpaceDelete": { - "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" - } - }, - "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace successfully deleted." - }, - "202": { - "description": "Namespace delete request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Get", - "x-ms-examples": { - "NameSpaceGet": { - "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" - } - }, - "description": "Gets the description of the specified namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace returned successfully.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "patch": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_Update", - "x-ms-examples": { - "NamespacesUpdate": { - "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" - } - }, - "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Parameters for updating a namespace resource." - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "201": { - "description": "Namespace update request accepted.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "200": { - "description": "Namespace successfully updated.", - "schema": { - "$ref": "#/definitions/EHNamespace" - } - }, - "202": { - "description": "Namespace create or update request accepted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListIPFilterRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" - } - }, - "description": "Gets a list of IP Filter rules for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule successfully returned.", - "schema": { - "$ref": "#/definitions/IpFilterRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleCreate": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an IpFilterRule for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "The Namespace IpFilterRule." - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule created", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleDelete": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" - } - }, - "description": "Deletes an IpFilterRule for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace IpFilterRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetIpFilterRule", - "x-ms-examples": { - "NameSpaceIpFilterRuleGet": { - "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" - } - }, - "description": "Gets an IpFilterRule for a Namespace by rule name.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/IPFilterRuleNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace IpFilterRule returned successfully.", - "schema": { - "$ref": "#/definitions/IpFilterRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_ListVirtualNetworkRules", - "x-ms-examples": { - "ListIpFilterRules": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" - } - }, - "description": "Gets a list of VirtualNetwork rules for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule successfully returned.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRuleListResult" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { - "put": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleCreate": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" - } - }, - "description": "Creates or updates an VirtualNetworkRule for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "The Namespace VirtualNetworkRule." - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule created", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "delete": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_DeleteVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleDelete": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" - } - }, - "description": "Deletes an VirtualNetworkRule for a Namespace.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "204": { - "description": "No content." - }, - "200": { - "description": "Namespace VirtualNetworkRule successfully deleted." - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - }, - "get": { - "tags": [ - "Namespaces" - ], - "operationId": "Namespaces_GetVirtualNetworkRule", - "x-ms-examples": { - "NameSpaceVirtualNetworkRuleGet": { - "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" - } - }, - "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", - "parameters": [{ - "$ref": "#/parameters/ResourceGroupNameParameter" - }, { - "$ref": "#/parameters/NamespaceNameParameter" - }, { - "$ref": "#/parameters/VirtualNetworkRuleNameParameter" - }, { - "$ref": "#/parameters/ApiVersionParameter" - }, { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Namespace VirtualNetworkRule returned successfully.", - "schema": { - "$ref": "#/definitions/VirtualNetworkRule" - } - }, - "default": { - "description": "Eventhub error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - } - } - } - }, - "definitions": { - "OperationListResult": { - "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", - "properties": { - "value": { - "description": "List of Event Hub operations supported by the Microsoft.EventHub 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": "A Event Hub REST API operation", - "type": "object", - "properties": { - "name": { - "readOnly": true, - "type": "string", - "description": "Operation name: {provider}/{resource}/{operation}" - }, - "display": { - "description": "The object that represents the operation.", - "properties": { - "provider": { - "readOnly": true, - "type": "string", - "description": "Service provider: Microsoft.EventHub" - }, - "resource": { - "readOnly": true, - "type": "string", - "description": "Resource on which the operation is performed: Invoice, etc." - }, - "operation": { - "readOnly": true, - "type": "string", - "description": "Operation type: Read, write, delete, etc." - } - } - } - } - }, - "Cluster": { - "properties": { - "sku": { - "$ref": "#/definitions/ClusterSku", - "description": "Properties of the cluster SKU." - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "created": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was created." - }, - "updated": { - "readOnly": true, - "type": "string", - "description": "The UTC time when the Event Hubs Cluster was last updated." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." - } - }, - "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." - } - }, - "allOf": [{ - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Event Hubs Cluster resource in List or Get operations." - }, - "ClusterListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/Cluster" - }, - "description": "The Event Hubs Clusters present in the List Event Hubs operation results." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." - } - }, - "description": "The response of the List Event Hubs Clusters operation." - }, - "ClusterQuotaConfigurationProperties": { - "properties": { - "settings": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." - } - }, - "description": "Contains all settings for the cluster." - }, - "ErrorResponse": { - "description": "Error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" - } - } - }, - "TrackedResource": { - "properties": { - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - } - ], - "description": "Definition of an Azure resource." - }, - "Resource": { - "properties": { - "id": { - "type": "string", - "readOnly": true, - "description": "Resource Id" - }, - "name": { - "type": "string", - "readOnly": true, - "description": "Resource name" - }, - "type": { - "type": "string", - "readOnly": true, - "description": "Resource type" - } - }, - "description": "The Resource definition", - "x-ms-azure-resource": true - }, - "ClusterSku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Dedicated" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 32, - "minimum": 1, - "type": "integer", - "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters particular to a cluster instance." - }, - "EHNamespaceListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/EHNamespace" - }, - "description": "Result of the List Namespace operation" - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." - } - }, - "description": "The response of the List Namespace operation" - }, - "EHNamespace": { - "properties": { - "sku": { - "$ref": "#/definitions/Sku", - "description": "Properties of sku resource" - }, - "properties": { - "x-ms-client-flatten": true, - "properties": { - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the Namespace." - }, - "createdAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the Namespace was created." - }, - "updatedAt": { - "readOnly": true, - "format": "date-time", - "type": "string", - "description": "The time the Namespace was updated." - }, - "serviceBusEndpoint": { - "readOnly": true, - "type": "string", - "description": "Endpoint you can use to perform Service Bus operations." - }, - "metricId": { - "readOnly": true, - "type": "string", - "description": "Identifier for Azure Insights metrics." - }, - "isAutoInflateEnabled": { - "type": "boolean", - "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." - }, - "maximumThroughputUnits": { - "format": "int32", - "type": "integer", - "maximum": 20, - "minimum": 0, - "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" - }, - "kafkaEnabled": { - "type": "boolean", - "description": "Value that indicates whether Kafka is enabled for eventhub namespace." - }, - "zoneRedundant": { - "type": "boolean", - "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." - } - }, - "description": "Namespace properties supplied for create namespace operation." - } - }, - "allOf": [{ - "$ref": "#/definitions/TrackedResource" - } - ], - "description": "Single Namespace item in List or Get Operation" - }, - "Sku": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of this SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuName", - "modelAsString": true - } - }, - "tier": { - "type": "string", - "description": "The billing tier of this particular SKU.", - "enum": [ - "Basic", - "Standard" - ], - "x-ms-enum": { - "name": "SkuTier", - "modelAsString": true - } - }, - "capacity": { - "format": "int32", - "maximum": 20, - "minimum": 0, - "type": "integer", - "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." - } - }, - "required": [ - "name" - ], - "description": "SKU parameters supplied to the create namespace operation" - }, - "IpFilterRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "ipMask": { - "type": "string", - "description": "IP Mask" - }, - "action": { - "type": "string", - "description": "The IP Filter Action", - "enum": [ - "Accept", - "Reject" - ], - "x-ms-enum": { - "name": "IPAction", - "modelAsString": true - } - }, - "filterName": { - "type": "string", - "description": "IP Filter name" - } - }, - "description": "Properties supplied to create or update IpFilterRules" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get IpFilterRules operation" - }, - "IpFilterRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/IpFilterRule" - }, - "description": "Result of the List IpFilter Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" - } - }, - "description": "The response from the List namespace operation." - }, - "VirtualNetworkRule": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "properties": { - "virtualNetworkSubnetId": { - "type": "string", - "description": "ARM ID of Virtual Network Subnet" - } - }, - "description": "Properties supplied to create or update VirtualNetworkRules" - } - }, - "allOf": [{ - "$ref": "#/definitions/Resource" - } - ], - "description": "Single item in a List or Get VirtualNetworkRules operation" - }, - "VirtualNetworkRuleListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/VirtualNetworkRule" - }, - "description": "Result of the List VirtualNetwork Rules operation." - }, - "nextLink": { - "type": "string", - "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" - } - }, - "description": "The response from the List namespace operation." - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Client API version." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method", - "description": "Name of the resource group within the Azure subscription." - }, - "ClusterNameParameter": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The name of the Event Hubs Cluster." - }, - "NamespaceNameParameter": { - "name": "namespaceName", - "in": "path", - "required": true, - "type": "string", - "minLength": 6, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The Namespace name" - }, - "AuthorizationRuleNameParameter": { - "name": "authorizationRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The authorization rule name." - }, - "IPFilterRuleNameParameter": { - "name": "ipFilterRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The IP Filter Rule name." - }, - "VirtualNetworkRuleNameParameter": { - "name": "virtualNetworkRuleName", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "x-ms-parameter-location": "method", - "description": "The Virtual Network Rule name." - }, - "SkuNameParameter": { - "name": "sku", - "in": "path", - "required": true, - "type": "string", - "minLength": 1, - "maxLength": 50, - "x-ms-parameter-location": "method", - "description": "The sku type." - }, - "SkipParameter": { - "name": "$skip", - "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 0, - "maximum": 1000, - "x-ms-parameter-location": "method" - }, - "TopParameter": { - "name": "$top", - "description": "May be used to limit the number of results to the most recent N usageDetails.", - "in": "query", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 1000, - "x-ms-parameter-location": "method" - } - } + "swagger": "2.0", + "info": { + "title": "EventHub2018PreviewManagementClient", + "description": "Azure Event Hubs client for managing Event Hubs Cluster, IPFilter Rules and VirtualNetworkRules resources.", + "version": "2018-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.EventHub/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "EHOperations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "description": "Lists all of the available Event Hub REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { + "get": { + "tags": [ + "Event Hubs Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "ClustersListByResourceGroup": { + "$ref": "./examples/Clusters/ClustersListByResourceGroup.json" + } + }, + "description": "Lists the available Event Hubs Clusters within an ARM resource group.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Clusters returned successfully.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Event Hub Cluster error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { + "get": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "ClusterGet": { + "$ref": "./examples/Clusters/ClusterGet.json" + } + }, + "description": "Gets the resource description of the specified Event Hubs Cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster resource description returned successfully.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the cluster description get operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Event Hubs Cluster" + ], + "operationId": "Clusters_Patch", + "x-ms-examples": { + "ClusterPatch": { + "$ref": "./examples/Clusters/ClusterPatch.json" + } + }, + "description": "Modifies mutable properties on the Event Hubs Cluster. This operation is idempotent.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The properties of the Event Hubs Cluster which should be updated." + } + ], + "responses": { + "200": { + "description": "Event Hubs Cluster successfully created.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Event Hubs Cluster update request accepted.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs error response detailing why the Event Hubs Cluster update operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/quotaConfiguration/default": { + "patch": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Patch", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties", + "required": [ + "settings" + ] + }, + "description": "Parameters for creating an Event Hubs Cluster resource." + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationPatch": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationPatch.json" + } + }, + "description": "Replace all specified Event Hubs Cluster settings with those contained in the request body. Leaves the settings not specified in the request body unmodified.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "201": { + "description": "Event Hubs Cluster setting configuration request successfully accepted.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "202": { + "description": "Event Hubs Cluster update request accepted." + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Event Hubs Cluster Configuration" + ], + "operationId": "Configuration_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "x-ms-examples": { + "ClustersQuotasConfigurationGet": { + "$ref": "./examples/Clusters/ClusterQuotaConfigurationGet.json" + } + }, + "description": "Get all Event Hubs Cluster settings - a collection of key/value pairs which represent the quotas and settings imposed on the cluster.", + "responses": { + "200": { + "description": "Event Hubs Cluster settings configuration returned.", + "schema": { + "$ref": "#/definitions/ClusterQuotaConfigurationProperties" + } + }, + "default": { + "description": "Event Hubs Cluster error response describing why the get cluster quotas and settings operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_List", + "x-ms-examples": { + "NamespacesListBySubscription": { + "$ref": "./examples/NameSpaces/EHNameSpaceList.json" + } + }, + "description": "Lists all the available Namespaces within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListByResourceGroup", + "x-ms-examples": { + "NamespaceListByResourceGroup": { + "$ref": "./examples/NameSpaces/EHNameSpaceListByResourceGroup.json" + } + }, + "description": "Lists the available Namespaces within a resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespaces returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespaceListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdate", + "x-ms-examples": { + "NamespaceCreate": { + "$ref": "./examples/NameSpaces/EHNameSpaceCreate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a namespace resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Namespace create request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "200": { + "description": "Namespace successfully created.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Delete", + "x-ms-examples": { + "NameSpaceDelete": { + "$ref": "./examples/NameSpaces/EHNameSpaceDelete.json" + } + }, + "description": "Deletes an existing namespace. This operation also removes all associated resources under the namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace successfully deleted." + }, + "202": { + "description": "Namespace delete request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Get", + "x-ms-examples": { + "NameSpaceGet": { + "$ref": "./examples/NameSpaces/EHNameSpaceGet.json" + } + }, + "description": "Gets the description of the specified namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace returned successfully.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_Update", + "x-ms-examples": { + "NamespacesUpdate": { + "$ref": "./examples/NameSpaces/EHNameSpaceUpdate.json" + } + }, + "description": "Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Parameters for updating a namespace resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Namespace update request accepted.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "200": { + "description": "Namespace successfully updated.", + "schema": { + "$ref": "#/definitions/EHNamespace" + } + }, + "202": { + "description": "Namespace create or update request accepted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListIPFilterRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIPFilterRuleListAll.json" + } + }, + "description": "Gets a list of IP Filter rules for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule successfully returned.", + "schema": { + "$ref": "#/definitions/IpFilterRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/ipfilterrules/{ipFilterRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleCreate": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/ipFilterRuleNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "The Namespace IpFilterRule." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule created", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleDelete": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleDelete.json" + } + }, + "description": "Deletes an IpFilterRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/ipFilterRuleNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace IpFilterRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetIpFilterRule", + "x-ms-examples": { + "NameSpaceIpFilterRuleGet": { + "$ref": "./examples/NameSpaces/IPFilterRule/EHNameSpaceIpFilterRuleGet.json" + } + }, + "description": "Gets an IpFilterRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/ipFilterRuleNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace IpFilterRule returned successfully.", + "schema": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules": { + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_ListVirtualNetworkRules", + "x-ms-examples": { + "ListIpFilterRules": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleListAll.json" + } + }, + "description": "Gets a list of VirtualNetwork rules for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule successfully returned.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRuleListResult" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/virtualnetworkrules/{virtualNetworkRuleName}": { + "put": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_CreateOrUpdateVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleCreateorUpdate.json" + } + }, + "description": "Creates or updates an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "The Namespace VirtualNetworkRule." + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule created", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_DeleteVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleDelete": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleDelete.json" + } + }, + "description": "Deletes an VirtualNetworkRule for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No content." + }, + "200": { + "description": "Namespace VirtualNetworkRule successfully deleted." + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "operationId": "Namespaces_GetVirtualNetworkRule", + "x-ms-examples": { + "NameSpaceVirtualNetworkRuleGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNameSpaceVirtualNetworkRuleGet.json" + } + }, + "description": "Gets an VirtualNetworkRule for a Namespace by rule name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/virtualNetworkRuleNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace VirtualNetworkRule returned successfully.", + "schema": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "default": { + "description": "Eventhub error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/networkRuleSets/default": { + "put": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetCreate": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json" + } + }, + "operationId": "Namespaces_CreateOrUpdateNetworkRuleSet", + "description": "Create or update NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + }, + "description": "The Namespace IpFilterRule." + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Namespaces" + ], + "x-ms-examples": { + "NameSpaceNetworkRuleSetGet": { + "$ref": "./examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json" + } + }, + "operationId": "Namespaces_GetNetworkRuleSet", + "description": "Gets NetworkRuleSet for a Namespace.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/namespaceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Namespace NetworkRuleSet successfully returned.", + "schema": { + "$ref": "#/definitions/NetworkRuleSet" + } + }, + "default": { + "description": "ServiceBus error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Event Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Event Hub operations supported by the Microsoft.EventHub 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": "A Event Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft.EventHub" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource on which the operation is performed: Invoice, etc." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Operation type: Read, write, delete, etc." + } + } + } + } + }, + "Cluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ClusterSku", + "description": "Properties of the cluster SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "created": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was created." + }, + "updated": { + "readOnly": true, + "type": "string", + "description": "The UTC time when the Event Hubs Cluster was last updated." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "The metric ID of the cluster resource. Provided by the service and not modifiable by the user." + } + }, + "description": "Event Hubs Cluster properties supplied in responses in List or Get operations." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Single Event Hubs Cluster resource in List or Get operations." + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The Event Hubs Clusters present in the List Event Hubs operation results." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Empty unless the value parameter contains an incomplete list of Event Hubs Clusters." + } + }, + "description": "The response of the List Event Hubs Clusters operation." + }, + "ClusterQuotaConfigurationProperties": { + "properties": { + "settings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "All possible Cluster settings - a collection of key/value paired settings which apply to quotas and configurations imposed on the cluster." + } + }, + "description": "Contains all settings for the cluster." + }, + "ErrorResponse": { + "description": "Error response that indicates the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Definition of an Azure resource." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type" + } + }, + "description": "The Resource definition", + "x-ms-azure-resource": true + }, + "ClusterSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Dedicated" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 32, + "minimum": 1, + "type": "integer", + "description": "The quantity of Event Hubs Cluster Capacity Units contained in this cluster." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters particular to a cluster instance." + }, + "EHNamespaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EHNamespace" + }, + "description": "Result of the List Namespace operation" + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains incomplete list of namespaces." + } + }, + "description": "The response of the List Namespace operation" + }, + "EHNamespace": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "Properties of sku resource" + }, + "properties": { + "x-ms-client-flatten": true, + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Namespace." + }, + "createdAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was created." + }, + "updatedAt": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The time the Namespace was updated." + }, + "serviceBusEndpoint": { + "readOnly": true, + "type": "string", + "description": "Endpoint you can use to perform Service Bus operations." + }, + "metricId": { + "readOnly": true, + "type": "string", + "description": "Identifier for Azure Insights metrics." + }, + "isAutoInflateEnabled": { + "type": "boolean", + "description": "Value that indicates whether AutoInflate is enabled for eventhub namespace." + }, + "maximumThroughputUnits": { + "format": "int32", + "type": "integer", + "maximum": 20, + "minimum": 0, + "description": "Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)" + }, + "kafkaEnabled": { + "type": "boolean", + "description": "Value that indicates whether Kafka is enabled for eventhub namespace." + }, + "zoneRedundant": { + "type": "boolean", + "description": "Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones." + } + }, + "description": "Namespace properties supplied for create namespace operation." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "Single Namespace item in List or Get Operation" + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of this SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The billing tier of this particular SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "maximum": 20, + "minimum": 0, + "type": "integer", + "description": "The Event Hubs throughput units, value should be 0 to 20 throughput units." + } + }, + "required": [ + "name" + ], + "description": "SKU parameters supplied to the create namespace operation" + }, + "IpFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Accept", + "Reject" + ], + "x-ms-enum": { + "name": "IPAction", + "modelAsString": true + } + }, + "filterName": { + "type": "string", + "description": "IP Filter name" + } + }, + "description": "Properties supplied to create or update IpFilterRules" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get IpFilterRules operation" + }, + "IpFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + }, + "description": "Result of the List IpFilter Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of IpFilter Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "VirtualNetworkRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "properties": { + "virtualNetworkSubnetId": { + "type": "string", + "description": "ARM ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied to create or update VirtualNetworkRules" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Single item in a List or Get VirtualNetworkRules operation" + }, + "VirtualNetworkRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + }, + "description": "Result of the List VirtualNetwork Rules operation." + }, + "nextLink": { + "type": "string", + "description": "Link to the next set of results. Not empty if Value contains an incomplete list of VirtualNetwork Rules" + } + }, + "description": "The response from the List namespace operation." + }, + "Subnet": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID of Virtual Network Subnet" + } + }, + "description": "Properties supplied for Subnet" + }, + "NWRuleSetIpRules": { + "x-ms-client-flatten": true, + "properties": { + "ipMask": { + "type": "string", + "description": "IP Mask" + }, + "action": { + "type": "string", + "description": "The IP Filter Action", + "enum": [ + "Allow" + ], + "x-ms-enum": { + "name": "NetworkRuleIPAction", + "modelAsString": true + } + } + }, + "description": "The response from the List namespace operation." + }, + "NWRuleSetVirtualNetworkRules": { + "x-ms-client-flatten": true, + "properties": { + "subnet": { + "$ref": "#/definitions/Subnet", + "description": "Subnet properties" + }, + "ignoreMissingVnetServiceEndpoint": { + "type": "boolean", + "description": "Value that indicates whether to ignore missing Vnet Service Endpoint" + } + }, + "description": "The response from the List namespace operation." + }, + "NetworkRuleSet": { + "properties": { + "properties": { + "description": "NetworkRuleSet properties", + "x-ms-client-flatten": true, + "properties": { + "defaultAction": { + "type": "string", + "description": "Default Action for Network Rule Set", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "DefaultAction", + "modelAsString": true + } + }, + "virtualNetworkRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetVirtualNetworkRules" + }, + "description": "List VirtualNetwork Rules" + }, + "ipRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NWRuleSetIpRules" + }, + "description": "List of IpRules" + } + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Description of topic resource." + } + }, + "parameters": { + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the resource group within the Azure subscription." + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The name of the Event Hubs Cluster." + }, + "namespaceNameParameter": { + "name": "namespaceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 6, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The Namespace name" + }, + "authorizationRuleNameParameter": { + "name": "authorizationRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The authorization rule name." + }, + "ipFilterRuleNameParameter": { + "name": "ipFilterRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The IP Filter Rule name." + }, + "virtualNetworkRuleNameParameter": { + "name": "virtualNetworkRuleName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "x-ms-parameter-location": "method", + "description": "The Virtual Network Rule name." + }, + "skuNameParameter": { + "name": "sku", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 50, + "x-ms-parameter-location": "method", + "description": "The sku type." + }, + "skipParameter": { + "name": "$skip", + "description": "Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 0, + "maximum": 1000, + "x-ms-parameter-location": "method" + }, + "topParameter": { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N usageDetails.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "x-ms-parameter-location": "method" + } + } } \ No newline at end of file diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json new file mode 100644 index 000000000000..e90b46f684d9 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetCreate.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription", + "parameters": { + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" + }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" + }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { + "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" + }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/854d368f-1828-428f-8f3c-f2affa9b2f7d/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json new file mode 100644 index 000000000000..ddd005ee3956 --- /dev/null +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/NameSpaces/VirtualNetworkRule/EHNetworkRuleSetGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "namespaceName": "sdk-Namespace-6019", + "resourceGroupName": "ResourceGroup", + "api-version": "2018-01-01-preview", + "subscriptionId": "Subscription" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subscriptionid/resourceGroups/resourcegroupid/providers/Microsoft.EventHub/namespaces/sdk-Namespace-9659/networkruleset/default", + "name": "default", + "type": "Microsoft.EventHub/Namespaces/NetworkRuleSet", + "properties": { + "defaultAction": "Deny", + "virtualNetworkRules": [ + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet2" }, + "ignoreMissingVnetServiceEndpoint": true + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet3" }, + "ignoreMissingVnetServiceEndpoint": false + }, + { + "subnet": { "id": "/subscriptions/subscriptionid/resourcegroups/resourcegroupid/providers/Microsoft.Network/virtualNetworks/myvn/subnets/subnet6" }, + "ignoreMissingVnetServiceEndpoint": false + } + ], + "ipRules": [ + { + "ipMask": "1.1.1.1", + "action": "Allow" + }, + { + "ipMask": "1.1.1.2", + "action": "Allow" + }, + { + "ipMask": "1.1.1.3", + "action": "Allow" + }, + { + "ipMask": "1.1.1.4", + "action": "Allow" + }, + { + "ipMask": "1.1.1.5", + "action": "Allow" + } + ] + } + } + } + } +} From 72e806d809ab08b0e0d3ffc679f8c8d662074010 Mon Sep 17 00:00:00 2001 From: Matt Boersma Date: Fri, 14 Dec 2018 23:43:28 -0700 Subject: [PATCH 434/464] [AKS] add C# config to readme.md (#4896) * [AKS] add C# config to readme.md * Updating csharp tags and fixing python tags so as to address python sdk breaking changes * Revert some changes now that multi-api should work for python SDK * Add .NET SDK to "Swagger to SDK" auto-PR section --- .../resource-manager/readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/specification/containerservices/resource-manager/readme.md b/specification/containerservices/resource-manager/readme.md index 800d8674dd7d..6efba03d7355 100644 --- a/specification/containerservices/resource-manager/readme.md +++ b/specification/containerservices/resource-manager/readme.md @@ -206,12 +206,28 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js + - repo: azure-sdk-for-net - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_service'] ``` +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.Management.ContainerService + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/ContainerService/Management.ContainerService/Generated + clear-output-folder: true +``` + ## Go See configuration in [readme.go.md](./readme.go.md) @@ -233,6 +249,7 @@ description: "Container Service Client" ``` ### Java multi-api + ``` yaml $(java) && $(multiapi) batch: - tag: package-2017-09-only From b3ee4f4c2a3c4fa3ca16a788f147f2577fe31d74 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 12:09:05 -0500 Subject: [PATCH 435/464] typo: datafactory/resource-manager/Microsoft.DataFactory (#4925) - culster -> cluster --- .../2018-06-01/entityTypes/Pipeline.json | 900 +++++++++--------- 1 file changed, 450 insertions(+), 450 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 45224d1ec626..5301d93af796 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 @@ -685,455 +685,455 @@ } } }, - "AmazonMWSSource": { - "description": "A copy activity Amazon Marketplace Web Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "AzurePostgreSqlSource": { - "description": "A copy activity Azure PostgreSQL source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ConcurSource": { - "description": "A copy activity Concur Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "CouchbaseSource": { - "description": "A copy activity Couchbase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "DrillSource": { - "description": "A copy activity Drill server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "EloquaSource": { - "description": "A copy activity Eloqua server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GoogleBigQuerySource": { - "description": "A copy activity Google BigQuery service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "GreenplumSource": { - "description": "A copy activity Greenplum Database source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HBaseSource": { - "description": "A copy activity HBase server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HiveSource": { - "description": "A copy activity Hive Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "HubspotSource": { - "description": "A copy activity Hubspot Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ImpalaSource": { - "description": "A copy activity Impala server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "JiraSource": { - "description": "A copy activity Jira Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MagentoSource": { - "description": "A copy activity Magento server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MariaDBSource": { - "description": "A copy activity MariaDB server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "MarketoSource": { - "description": "A copy activity Marketo server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PaypalSource": { - "description": "A copy activity Paypal Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PhoenixSource": { - "description": "A copy activity Phoenix server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "PrestoSource": { - "description": "A copy activity Presto server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "QuickBooksSource": { - "description": "A copy activity QuickBooks server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ServiceNowSource": { - "description": "A copy activity ServiceNow server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ShopifySource": { - "description": "A copy activity Shopify Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SparkSource": { - "description": "A copy activity Spark Server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SquareSource": { - "description": "A copy activity Square Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "XeroSource": { - "description": "A copy activity Xero Service source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ZohoSource": { - "description": "A copy activity Zoho server source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "NetezzaSource": { - "description": "A copy activity Netezza source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "VerticaSource": { - "description": "A copy activity Vertica source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "SalesforceMarketingCloudSource": { - "description": "A copy activity Salesforce Marketing Cloud source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } - }, - "ResponsysSource": { - "description": "A copy activity Responsys source.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/CopySource" - } - ], - "properties": { - "query": { - "type": "object", - "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." - } - } + "AmazonMWSSource": { + "description": "A copy activity Amazon Marketplace Web Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "AzurePostgreSqlSource": { + "description": "A copy activity Azure PostgreSQL source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ConcurSource": { + "description": "A copy activity Concur Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "CouchbaseSource": { + "description": "A copy activity Couchbase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "DrillSource": { + "description": "A copy activity Drill server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "EloquaSource": { + "description": "A copy activity Eloqua server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GoogleBigQuerySource": { + "description": "A copy activity Google BigQuery service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "GreenplumSource": { + "description": "A copy activity Greenplum Database source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HBaseSource": { + "description": "A copy activity HBase server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HiveSource": { + "description": "A copy activity Hive Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "HubspotSource": { + "description": "A copy activity Hubspot Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ImpalaSource": { + "description": "A copy activity Impala server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "JiraSource": { + "description": "A copy activity Jira Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MagentoSource": { + "description": "A copy activity Magento server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MariaDBSource": { + "description": "A copy activity MariaDB server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "MarketoSource": { + "description": "A copy activity Marketo server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PaypalSource": { + "description": "A copy activity Paypal Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PhoenixSource": { + "description": "A copy activity Phoenix server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "PrestoSource": { + "description": "A copy activity Presto server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "QuickBooksSource": { + "description": "A copy activity QuickBooks server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ServiceNowSource": { + "description": "A copy activity ServiceNow server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ShopifySource": { + "description": "A copy activity Shopify Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SparkSource": { + "description": "A copy activity Spark Server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SquareSource": { + "description": "A copy activity Square Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "XeroSource": { + "description": "A copy activity Xero Service source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ZohoSource": { + "description": "A copy activity Zoho server source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "NetezzaSource": { + "description": "A copy activity Netezza source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "VerticaSource": { + "description": "A copy activity Vertica source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "SalesforceMarketingCloudSource": { + "description": "A copy activity Salesforce Marketing Cloud source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } + }, + "ResponsysSource": { + "description": "A copy activity Responsys source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "query": { + "type": "object", + "description": "A query to retrieve data from source. Type: string (or Expression with resultType string)." + } + } } , "AmazonRedshiftSource": { "description": "A copy activity source for Amazon Redshift Source.", @@ -1750,7 +1750,7 @@ }, "queryTimeout": { "type": "integer", - "description": "Query timeout value (in minutes). Effective when the HDInsight culster is with ESP (Enterprise Security Package)" + "description": "Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package)" } } }, From 7f82579a7778e6e1a2beb5691f9e7d62354ed25c Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 12:13:52 -0500 Subject: [PATCH 436/464] typo: labservices/resource-manager/Microsoft.LabServices (#4926) - evironments -> environments --- .../Microsoft.LabServices/stable/2018-10-15/ML.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json index 1ad5db20bab3..6b2ba7663f13 100644 --- a/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json +++ b/specification/labservices/resource-manager/Microsoft.LabServices/stable/2018-10-15/ML.json @@ -3439,7 +3439,7 @@ "type": "object", "properties": { "environments": { - "description": "List of all the evironments", + "description": "List of all the environments", "type": "array", "items": { "$ref": "#/definitions/EnvironmentDetails" } } From 4fc6951ddc8b51b9519bc9531b8b39af13c7a792 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:07:59 -0500 Subject: [PATCH 437/464] typo: servicefabric/data-plane/Microsoft.ServiceFabric (#4930) - nodetype -> node type --- .../Microsoft.ServiceFabric/stable/6.2/servicefabric.json | 2 +- .../Microsoft.ServiceFabric/stable/6.3/servicefabric.json | 2 +- .../Microsoft.ServiceFabric/stable/6.4/servicefabric.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json index c3ac806afb72..c3a09dd8f281 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.2/servicefabric.json @@ -15010,7 +15010,7 @@ "properties": { "NodeTypeInclusionList": { "type": "array", - "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/NodeType" } diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json index 41fa3e280d3e..107710547f3a 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.3/servicefabric.json @@ -15421,7 +15421,7 @@ "properties": { "NodeTypeInclusionList": { "type": "array", - "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/NodeType" } diff --git a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json index d41f58cbe3ee..b48ec46e3f39 100644 --- a/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json +++ b/specification/servicefabric/data-plane/Microsoft.ServiceFabric/stable/6.4/servicefabric.json @@ -15846,7 +15846,7 @@ "properties": { "NodeTypeInclusionList": { "type": "array", - "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a nodetype (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", + "description": "A list of node types to include in Chaos faults.\nAll types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types.\nIf a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of\nNodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList.\nhappens to reside on a node of NodeTypeX.\nAt most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration.", "items": { "$ref": "#/definitions/NodeType" } From 2eecd7bf8b1bf53dd26c3330d5d949fb4d29db97 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:09:00 -0500 Subject: [PATCH 438/464] typo: nuget -> NuGet (#4921) --- specification/azurestack/resource-manager/readme.md | 2 +- .../cognitiveservices/data-plane/TextAnalytics/readme.md | 6 +++--- specification/compute/resource-manager/readme.md | 2 +- specification/visualstudio/resource-manager/readme.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/azurestack/resource-manager/readme.md b/specification/azurestack/resource-manager/readme.md index f06d9ffce1c4..60d2ed7bcc4a 100644 --- a/specification/azurestack/resource-manager/readme.md +++ b/specification/azurestack/resource-manager/readme.md @@ -9,7 +9,7 @@ The Azure Stack RP comprises of small services where each service has its own ta Hence, each sub-service has its own swagger spec. All of them are tied together using this configuration and are packaged together into one Azure Stack client library. -This makes it easier for customers to download one (nuget/npm/pip/maven/gem) Azure Stack client library package rather than installing individual packages for each sub service. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) Azure Stack client library package rather than installing individual packages for each sub service. --- diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md index 3a4d6c8d4cac..f12e86aef86f 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/readme.md +++ b/specification/cognitiveservices/data-plane/TextAnalytics/readme.md @@ -1,7 +1,7 @@ # Cognitive Services Language SDK The Cognitive Service Language SDK has support for the Text Analytics Cognitive Service. -While this repository contains the [Autorest](https://aka.ms/autorest) generated SDK, the easiest way to consume the SDK is by installing the Nuget package for it. +While this repository contains the [Autorest](https://aka.ms/autorest) generated SDK, the easiest way to consume the SDK is by installing the NuGet package for it. Note that the Cognitive Services Language SDK is simply a wrapper on top of the Text Analytics Cognitive service. As such, it will generate calls to the Azure service. @@ -11,12 +11,12 @@ You must have a [Cognitive Services API account](https://docs.microsoft.com/azur You must also have the [endpoint and access key](../How-tos/text-analytics-how-to-access-key.md) that was generated for you during sign up. -## Installing the Nuget SDK Package +## Installing the NuGet SDK Package 1. Create a new Console solution in Visual Studio. 1. Right click on the solution and click **Manage NuGet Packages for Solution** 1. Mark the **Include Prerelease** checkbox. 1. Select the **Browse** tab, and Search for **Microsoft.Azure.CognitiveServices.Language** -1. Select the Nuget package and install it. +1. Select the NuGet package and install it. ## Calling the Text Analytics API using the SDK The following code snippets show to consume the SDK. Note that you will need to replace `client.SubscriptionKey` with the key you received when you signed up and `client.AzureRegion` with the region you signed up for. diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index b8a23076a955..5616fae4f3ff 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -9,7 +9,7 @@ The compute RP comprises of small services where each service has its own tag. Hence, each sub-service has its own swagger spec. All of them are tied together using this configuration and are packaged together into one compute client library. -This makes it easier for customers to download one (nuget/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. --- diff --git a/specification/visualstudio/resource-manager/readme.md b/specification/visualstudio/resource-manager/readme.md index 273fce78f603..7024b0319542 100644 --- a/specification/visualstudio/resource-manager/readme.md +++ b/specification/visualstudio/resource-manager/readme.md @@ -9,7 +9,7 @@ The App service RP comprises of services where each service has its own tag. Hence, each sub-service has its own swagger spec. All of them are tied together using this configuration and are packaged together into one compute client library. -This makes it easier for customers to download one (nuget/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. --- From ef60b7cef6da05549e3f7b7bbaaf7af169f88aad Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:09:33 -0500 Subject: [PATCH 439/464] typo: sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine (#4928) - paramenters > parameters - aysnc -> async --- .../preview/2017-03-01-preview/sqlvm.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json index 5e5e51fc6068..d42907b5cb2d 100644 --- a/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json +++ b/specification/sqlvirtualmachine/resource-manager/Microsoft.SqlVirtualMachine/preview/2017-03-01-preview/sqlvm.json @@ -633,7 +633,7 @@ }, "x-ms-long-running-operation": true, "x-ms-examples": { - "Creates or updates a SQL virtual machine with max paramenters.": { + "Creates or updates a SQL virtual machine with max parameters.": { "$ref": "./examples/CreateOrUpdateSqlVirtualMachineMAX.json" }, "Creates or updates a SQL virtual machine and joins it to a SQL virtual machine group.": { @@ -823,7 +823,7 @@ "type": "object", "properties": { "provisioningState": { - "description": "Provisioning state to track the aysnc operation status.", + "description": "Provisioning state to track the async operation status.", "type": "string", "readOnly": true }, @@ -1048,7 +1048,7 @@ "type": "object", "properties": { "provisioningState": { - "description": "Provisioning state to track the aysnc operation status.", + "description": "Provisioning state to track the async operation status.", "type": "string", "readOnly": true }, @@ -1311,7 +1311,7 @@ ] }, "provisioningState": { - "description": "Provisioning state to track the aysnc operation status.", + "description": "Provisioning state to track the async operation status.", "type": "string", "readOnly": true }, From 1833009e9ffddb3affeb0f4f95230d55b364c11e Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:10:02 -0500 Subject: [PATCH 440/464] typo: batch/data-plane/Microsoft.Batch (#4918) - comptue -> compute - pre-empted -> preempted --- .../Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json index 6ac4c2f7e671..665ac345a8a3 100644 --- a/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json +++ b/specification/batch/data-plane/Microsoft.Batch/stable/2018-12-01.8.0/BatchService.json @@ -13065,7 +13065,7 @@ "items": { "$ref": "#/definitions/DataDisk" }, - "title": "The configuration for data disks attached to the comptue nodes in the pool.", + "title": "The configuration for data disks attached to the compute nodes in the pool.", "description": "This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. This cannot be updated. Each node gets its own disk (the disk is not a file share). Existing disks cannot be attached, each attached disk is empty. When the node is removed from the pool, the disk and all data associated with it is also deleted. The disk is not formatted after being attached, it must be formatted before use - for more information see https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux and https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine." }, "licenseType": { @@ -14355,7 +14355,7 @@ "state": { "type": "string", "title": "The current state of the compute node.", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available.", + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available.", "enum": [ "idle", "rebooting", @@ -14428,7 +14428,7 @@ }, { "value": "preempted", - "description": "The low-priority node has been preempted. Tasks which were running on the node when it was pre-empted will be rescheduled when another node becomes available." + "description": "The low-priority node has been preempted. Tasks which were running on the node when it was preempted will be rescheduled when another node becomes available." } ] } From e68ab381025e7007653b89ac9222ed24b18a2070 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:20:17 -0500 Subject: [PATCH 441/464] typo: apimanagement/control-plane/Microsoft.ApiManagement (#4882) Camel case example files --- .../preview/2017-03-01/apimanagement.json | 4 ++-- .../2017-03-01/apimauthorizationservers.json | 20 +++++++++---------- .../2017-03-01/apimidentityprovider.json | 20 +++++++++---------- .../2017-03-01/apimportalsettings.json | 8 ++++---- .../preview/2017-03-01/apimsubscriptions.json | 8 ++++---- .../preview/2017-03-01/apimtenant.json | 12 +++++------ .../preview/2017-03-01/apimusers.json | 4 ++-- ...ManagementDeleteAuthorizationServers.json} | 0 ...ApiManagementDeleteIdentityProviders.json} | 0 ...ApiManagementGetAuthorizationServers.json} | 0 ...=> ApiManagementGetIdentityProviders.json} | 0 ...ApiManagementGetPortalSettingsSignIn.json} | 0 ...piManagementListAuthorizationServers.json} | 0 ...> ApiManagementListIdentityProviders.json} | 0 ...n => ApiManagementListPolicySnippets.json} | 0 ... => ApiManagementListTenantSyncState.json} | 0 ...iManagementPatchAuthorizationServers.json} | 0 ... ApiManagementPatchIdentityProviders.json} | 0 ...ostSubscriptionsRegeneratePrimaryKey.json} | 0 ...tSubscriptionsRegenerateSecondaryKey.json} | 0 ...gementPostTenantRegeneratePrimaryKey.json} | 0 ...mentPostTenantRegenerateSecondaryKey.json} | 0 ...ApiManagementPostUsersGenerateSsoUrl.json} | 0 ...ApiManagementPutAuthorizationServers.json} | 0 ...=> ApiManagementPutIdentityProviders.json} | 0 ...ApiManagementPutPortalSettingsSignUp.json} | 0 26 files changed, 38 insertions(+), 38 deletions(-) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementDeleteAuthorizationservers.json => ApiManagementDeleteAuthorizationServers.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementDeleteIdentityproviders.json => ApiManagementDeleteIdentityProviders.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementGetAuthorizationservers.json => ApiManagementGetAuthorizationServers.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementGetIdentityproviders.json => ApiManagementGetIdentityProviders.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementGetPortalSettingSignIn.json => ApiManagementGetPortalSettingsSignIn.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementListAuthorizationservers.json => ApiManagementListAuthorizationServers.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementListIdentityproviders.json => ApiManagementListIdentityProviders.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementListPolicysnippets.json => ApiManagementListPolicySnippets.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementListTenantSyncstate.json => ApiManagementListTenantSyncState.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPatchAuthorizationservers.json => ApiManagementPatchAuthorizationServers.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPatchIdentityproviders.json => ApiManagementPatchIdentityProviders.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPostSubscriptionsRegenerateprimarykey.json => ApiManagementPostSubscriptionsRegeneratePrimaryKey.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPostSubscriptionsRegeneratesecondarykey.json => ApiManagementPostSubscriptionsRegenerateSecondaryKey.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPostTenantRegenerateprimarykey.json => ApiManagementPostTenantRegeneratePrimaryKey.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPostTenantRegeneratesecondarykey.json => ApiManagementPostTenantRegenerateSecondaryKey.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPostUsersGeneratessourl.json => ApiManagementPostUsersGenerateSsoUrl.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPutAuthorizationservers.json => ApiManagementPutAuthorizationServers.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPutIdentityproviders.json => ApiManagementPutIdentityProviders.json} (100%) rename specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/{ApiManagementPutPortalsettingsSignUp.json => ApiManagementPutPortalSettingsSignUp.json} (100%) diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimanagement.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimanagement.json index e326f354e302..671f8b4cc8ea 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimanagement.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimanagement.json @@ -237,8 +237,8 @@ "operationId": "PolicySnippets_List", "description": "Lists all policy snippets.", "x-ms-examples": { - "ApiManagementListPolicysnippets": { - "$ref": "./examples/ApiManagementListPolicysnippets.json" + "ApiManagementListPolicySnippets": { + "$ref": "./examples/ApiManagementListPolicySnippets.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimauthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimauthorizationservers.json index 224184a24901..da67aa4c12c4 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimauthorizationservers.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimauthorizationservers.json @@ -50,8 +50,8 @@ "operationId": "AuthorizationServer_List", "description": "Lists a collection of authorization servers defined within a service instance.", "x-ms-examples": { - "ApiManagementListAuthorizationservers": { - "$ref": "./examples/ApiManagementListAuthorizationservers.json" + "ApiManagementListAuthorizationServers": { + "$ref": "./examples/ApiManagementListAuthorizationServers.json" } }, "parameters": [ @@ -94,8 +94,8 @@ "operationId": "AuthorizationServer_Get", "description": "Gets the details of the authorization server specified by its identifier.", "x-ms-examples": { - "ApiManagementGetAuthorizationservers": { - "$ref": "./examples/ApiManagementGetAuthorizationservers.json" + "ApiManagementGetAuthorizationServers": { + "$ref": "./examples/ApiManagementGetAuthorizationServers.json" } }, "parameters": [ @@ -134,8 +134,8 @@ "operationId": "AuthorizationServer_CreateOrUpdate", "description": "Creates new authorization server or updates an existing authorization server.", "x-ms-examples": { - "ApiManagementPutAuthorizationservers": { - "$ref": "./examples/ApiManagementPutAuthorizationservers.json" + "ApiManagementPutAuthorizationServers": { + "$ref": "./examples/ApiManagementPutAuthorizationServers.json" } }, "parameters": [ @@ -183,8 +183,8 @@ "operationId": "AuthorizationServer_Update", "description": "Updates the details of the authorization server specified by its identifier.", "x-ms-examples": { - "ApiManagementPatchAuthorizationservers": { - "$ref": "./examples/ApiManagementPatchAuthorizationservers.json" + "ApiManagementPatchAuthorizationServers": { + "$ref": "./examples/ApiManagementPatchAuthorizationServers.json" } }, "parameters": [ @@ -230,8 +230,8 @@ "operationId": "AuthorizationServer_Delete", "description": "Deletes specific authorization server instance.", "x-ms-examples": { - "ApiManagementDeleteAuthorizationservers": { - "$ref": "./examples/ApiManagementDeleteAuthorizationservers.json" + "ApiManagementDeleteAuthorizationServers": { + "$ref": "./examples/ApiManagementDeleteAuthorizationServers.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimidentityprovider.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimidentityprovider.json index 07150f47dbd0..fa9521941ea9 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimidentityprovider.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimidentityprovider.json @@ -50,8 +50,8 @@ "operationId": "IdentityProvider_List", "description": "Lists a collection of Identity Provider configured in the specified service instance.", "x-ms-examples": { - "ApiManagementListIdentityproviders": { - "$ref": "./examples/ApiManagementListIdentityproviders.json" + "ApiManagementListIdentityProviders": { + "$ref": "./examples/ApiManagementListIdentityProviders.json" } }, "externalDocs": { @@ -89,8 +89,8 @@ "operationId": "IdentityProvider_Get", "description": "Gets the configuration details of the identity Provider configured in specified service instance.", "x-ms-examples": { - "ApiManagementGetIdentityproviders": { - "$ref": "./examples/ApiManagementGetIdentityproviders.json" + "ApiManagementGetIdentityProviders": { + "$ref": "./examples/ApiManagementGetIdentityProviders.json" } }, "parameters": [ @@ -129,8 +129,8 @@ "operationId": "IdentityProvider_CreateOrUpdate", "description": "Creates or Updates the IdentityProvider configuration.", "x-ms-examples": { - "ApiManagementPutIdentityproviders": { - "$ref": "./examples/ApiManagementPutIdentityproviders.json" + "ApiManagementPutIdentityProviders": { + "$ref": "./examples/ApiManagementPutIdentityProviders.json" } }, "parameters": [ @@ -178,8 +178,8 @@ "operationId": "IdentityProvider_Update", "description": "Updates an existing IdentityProvider configuration.", "x-ms-examples": { - "ApiManagementPatchIdentityproviders": { - "$ref": "./examples/ApiManagementPatchIdentityproviders.json" + "ApiManagementPatchIdentityProviders": { + "$ref": "./examples/ApiManagementPatchIdentityProviders.json" } }, "parameters": [ @@ -225,8 +225,8 @@ "operationId": "IdentityProvider_Delete", "description": "Deletes the specified identity provider configuration.", "x-ms-examples": { - "ApiManagementDeleteIdentityproviders": { - "$ref": "./examples/ApiManagementDeleteIdentityproviders.json" + "ApiManagementDeleteIdentityProviders": { + "$ref": "./examples/ApiManagementDeleteIdentityProviders.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimportalsettings.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimportalsettings.json index 3320105c8d31..dfe8feb91162 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimportalsettings.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimportalsettings.json @@ -50,8 +50,8 @@ "operationId": "SignInSettings_Get", "description": "Get Sign-In settings.", "x-ms-examples": { - "ApiManagementGetPortalSettingSignIn": { - "$ref": "./examples/ApiManagementGetPortalSettingSignIn.json" + "ApiManagementGetPortalSettingsSignIn": { + "$ref": "./examples/ApiManagementGetPortalSettingsSignIn.json" } }, "parameters": [ @@ -242,8 +242,8 @@ "operationId": "SignUpSettings_CreateOrUpdate", "description": "Create or Update Sign-Up settings.", "x-ms-examples": { - "ApiManagementPutPortalsettingsSignUp": { - "$ref": "./examples/ApiManagementPutPortalsettingsSignUp.json" + "ApiManagementPutPortalSettingsSignUp": { + "$ref": "./examples/ApiManagementPutPortalSettingsSignUp.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json index d11185157a7d..c62d4ceedd3d 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimsubscriptions.json @@ -300,8 +300,8 @@ "operationId": "Subscription_RegeneratePrimaryKey", "description": "Regenerates primary key of existing subscription of the API Management service instance.", "x-ms-examples": { - "ApiManagementPostSubscriptionsRegenerateprimarykey": { - "$ref": "./examples/ApiManagementPostSubscriptionsRegenerateprimarykey.json" + "ApiManagementPostSubscriptionsRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementPostSubscriptionsRegeneratePrimaryKey.json" } }, "parameters": [ @@ -333,8 +333,8 @@ "operationId": "Subscription_RegenerateSecondaryKey", "description": "Regenerates secondary key of existing subscription of the API Management service instance.", "x-ms-examples": { - "ApiManagementPostSubscriptionsRegeneratesecondarykey": { - "$ref": "./examples/ApiManagementPostSubscriptionsRegeneratesecondarykey.json" + "ApiManagementPostSubscriptionsRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementPostSubscriptionsRegenerateSecondaryKey.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json index 7371f669fb9d..cf300c03c5e4 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimtenant.json @@ -133,8 +133,8 @@ "operationId": "TenantAccess_RegeneratePrimaryKey", "description": "Regenerate primary access key.", "x-ms-examples": { - "ApiManagementPostTenantRegenerateprimarykey": { - "$ref": "./examples/ApiManagementPostTenantRegenerateprimarykey.json" + "ApiManagementPostTenantRegeneratePrimaryKey": { + "$ref": "./examples/ApiManagementPostTenantRegeneratePrimaryKey.json" } }, "parameters": [ @@ -166,8 +166,8 @@ "operationId": "TenantAccess_RegenerateSecondaryKey", "description": "Regenerate secondary access key.", "x-ms-examples": { - "ApiManagementPostTenantRegeneratesecondarykey": { - "$ref": "./examples/ApiManagementPostTenantRegeneratesecondarykey.json" + "ApiManagementPostTenantRegenerateSecondaryKey": { + "$ref": "./examples/ApiManagementPostTenantRegenerateSecondaryKey.json" } }, "parameters": [ @@ -462,8 +462,8 @@ "operationId": "TenantConfiguration_GetSyncState", "description": "Gets the status of the most recent synchronization between the configuration database and the Git repository.", "x-ms-examples": { - "ApiManagementListTenantSyncstate": { - "$ref": "./examples/ApiManagementListTenantSyncstate.json" + "ApiManagementListTenantSyncState": { + "$ref": "./examples/ApiManagementListTenantSyncState.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimusers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimusers.json index b787439ee50d..ab5849403bc7 100644 --- a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimusers.json +++ b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/apimusers.json @@ -300,8 +300,8 @@ "operationId": "User_GenerateSsoUrl", "description": "Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.", "x-ms-examples": { - "ApiManagementPostUsersGeneratessourl": { - "$ref": "./examples/ApiManagementPostUsersGeneratessourl.json" + "ApiManagementPostUsersGenerateSsoUrl": { + "$ref": "./examples/ApiManagementPostUsersGenerateSsoUrl.json" } }, "parameters": [ diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteAuthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteAuthorizationServers.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteAuthorizationservers.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteAuthorizationServers.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteIdentityproviders.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteIdentityProviders.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteIdentityproviders.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementDeleteIdentityProviders.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetAuthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetAuthorizationServers.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetAuthorizationservers.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetAuthorizationServers.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetIdentityproviders.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetIdentityProviders.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetIdentityproviders.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetIdentityProviders.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetPortalSettingSignIn.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetPortalSettingsSignIn.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetPortalSettingSignIn.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementGetPortalSettingsSignIn.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListAuthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListAuthorizationServers.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListAuthorizationservers.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListAuthorizationServers.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListIdentityproviders.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListIdentityProviders.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListIdentityproviders.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListIdentityProviders.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListPolicysnippets.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListPolicySnippets.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListPolicysnippets.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListPolicySnippets.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListTenantSyncstate.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListTenantSyncState.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListTenantSyncstate.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementListTenantSyncState.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchAuthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchAuthorizationServers.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchAuthorizationservers.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchAuthorizationServers.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchIdentityproviders.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchIdentityProviders.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchIdentityproviders.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPatchIdentityProviders.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegenerateprimarykey.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegeneratePrimaryKey.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegenerateprimarykey.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegeneratePrimaryKey.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegeneratesecondarykey.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegenerateSecondaryKey.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegeneratesecondarykey.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostSubscriptionsRegenerateSecondaryKey.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegenerateprimarykey.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegeneratePrimaryKey.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegenerateprimarykey.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegeneratePrimaryKey.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegeneratesecondarykey.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegenerateSecondaryKey.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegeneratesecondarykey.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostTenantRegenerateSecondaryKey.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostUsersGeneratessourl.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostUsersGenerateSsoUrl.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostUsersGeneratessourl.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPostUsersGenerateSsoUrl.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutAuthorizationservers.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutAuthorizationServers.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutAuthorizationservers.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutAuthorizationServers.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutIdentityproviders.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutIdentityProviders.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutIdentityproviders.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutIdentityProviders.json diff --git a/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutPortalsettingsSignUp.json b/specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutPortalSettingsSignUp.json similarity index 100% rename from specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutPortalsettingsSignUp.json rename to specification/apimanagement/control-plane/Microsoft.ApiManagement/preview/2017-03-01/examples/ApiManagementPutPortalSettingsSignUp.json From af82bd81ba4c0578c0b11cbc70d8f3518fbdcc20 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:21:34 -0500 Subject: [PATCH 442/464] typo: sql/resource-manager/Microsoft.Sql (#4929) - recoverabel -> recoverable --- .../Microsoft.Sql/preview/2017-03-01-preview/databases.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json index a715b92b00b0..63cca91c8cbf 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/databases.json @@ -174,7 +174,7 @@ "Creates a database from restore with restorableDroppedDatabaseId.": { "$ref": "./examples/CreateDatabaseRestoreMode2.json" }, - "Creates a database from recoverabelDatabaseId.": { + "Creates a database from recoverable DatabaseId.": { "$ref": "./examples/CreateDatabaseRecoveryMode.json" } } From b81fd621bf72491368bb12080a33fad8b850479c Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:22:31 -0500 Subject: [PATCH 443/464] typo: resourcehealth/resource-manager/Microsoft.ResourceHealth (#4922) --- .../preview/2018-08-01/ResourceHealth.json | 4 ++-- ...ilitystatuses_List.json => AvailabilityStatuses_List.json} | 0 ...statuses_List.json => ChildAvailabilityStatuses_List.json} | 0 .../stable/2015-01-01/resourcehealth.json | 4 +--- ...statuses_List.json => ChildAvailabilityStatuses_List.json} | 0 .../stable/2017-07-01/resourcehealth.json | 3 +-- 6 files changed, 4 insertions(+), 7 deletions(-) rename specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/{Availabilitystatuses_List.json => AvailabilityStatuses_List.json} (100%) rename specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/{ChildAvailabilitystatuses_List.json => ChildAvailabilityStatuses_List.json} (100%) rename specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/{ChildAvailabilitystatuses_List.json => ChildAvailabilityStatuses_List.json} (100%) diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json index 4cd7b2d047cf..804c01c8a889 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json @@ -347,7 +347,7 @@ }, "x-ms-examples": { "GetHealthHistoryByResource": { - "$ref": "./examples/Availabilitystatuses_List.json" + "$ref": "./examples/AvailabilityStatuses_List.json" } } } @@ -658,7 +658,7 @@ }, "updates": { "type": "array", - "description": "List of updates for given servie health event.", + "description": "List of updates for given service health event.", "items": { "$ref": "#/definitions/update" } diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_List.json similarity index 100% rename from specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/Availabilitystatuses_List.json rename to specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/examples/AvailabilityStatuses_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatuses_List.json similarity index 100% rename from specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilitystatuses_List.json rename to specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/examples/ChildAvailabilityStatuses_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json index c4aec6044b53..0e5e742ad659 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2015-01-01/resourcehealth.json @@ -164,7 +164,6 @@ } } }, - "x-ms-examples": { "GetCurrentHealthByResource": { "$ref": "./examples/AvailabilityStatus_GetByResource.json" @@ -262,7 +261,6 @@ } } }, - "x-ms-examples": { "GetCurrentHealthByResource": { "$ref": "./examples/ChildAvailabilityStatus_GetByResource.json" @@ -315,7 +313,7 @@ }, "x-ms-examples": { "GetHealthHistoryByResource": { - "$ref": "./examples/ChildAvailabilitystatuses_List.json" + "$ref": "./examples/ChildAvailabilityStatuses_List.json" } } } diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatuses_List.json similarity index 100% rename from specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilitystatuses_List.json rename to specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/examples/ChildAvailabilityStatuses_List.json diff --git a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json index e6cade97e1e7..36ba052e997d 100644 --- a/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json +++ b/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2017-07-01/resourcehealth.json @@ -261,7 +261,6 @@ } } }, - "x-ms-examples": { "GetCurrentHealthByResource": { "$ref": "./examples/ChildAvailabilityStatus_GetByResource.json" @@ -314,7 +313,7 @@ }, "x-ms-examples": { "GetHealthHistoryByResource": { - "$ref": "./examples/ChildAvailabilitystatuses_List.json" + "$ref": "./examples/ChildAvailabilityStatuses_List.json" } } } From 4da18bee25b878eb758256518bff6da17750252d Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 14:23:21 -0500 Subject: [PATCH 444/464] typo: web/resource-manager/Microsoft.Web (#4919) - nuget -> NuGet - mimuntes -> minutes - repesenting -> representing - souce -> source - containting -> containing - databses -> databases - inclue -> include - Priviledged -> Privileged --- .../Microsoft.Web/stable/2015-08-01/service.json | 14 +++++++------- .../Microsoft.Web/stable/2016-08-01/WebApps.json | 2 +- .../Microsoft.Web/stable/2018-02-01/WebApps.json | 2 +- specification/web/resource-manager/readme.md | 2 +- 4 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json b/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json index f7870916f11c..a2d3ecc68f6c 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2015-08-01/service.json @@ -18509,7 +18509,7 @@ }, "changeIntervalInMinutes": { "format": "int32", - "description": "[Optional] Specifies interval in mimuntes to reevaluate ReroutePercentage", + "description": "[Optional] Specifies interval in minutes to reevaluate ReroutePercentage", "type": "integer" }, "minReroutePercentage": { @@ -19626,7 +19626,7 @@ } }, "MetricDefinition": { - "description": "Class repesenting metadata for the metrics", + "description": "Class representing metadata for the metrics", "type": "object", "allOf": [ { @@ -19665,7 +19665,7 @@ } }, "MetricAvailabilily": { - "description": "Class repesenting metrics availability and retention", + "description": "Class representing metrics availability and retention", "type": "object", "properties": { "timeGrain": { @@ -19914,7 +19914,7 @@ } }, "SourceControlCollection": { - "description": "Collection of soure controls", + "description": "Collection of source controls", "type": "object", "properties": { "value": { @@ -20505,7 +20505,7 @@ } }, "CsmSiteRecoveryEntity": { - "description": "Class containting details about site recovery operation.", + "description": "Class containing details about site recovery operation.", "type": "object", "properties": { "snapshotTime": { @@ -21498,7 +21498,7 @@ "type": "string" }, "databases": { - "description": "Collection of databses which should be restored. This list has to match the list of databases included in the backup.", + "description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.", "type": "array", "items": { "$ref": "#/definitions/DatabaseBackupSetting" @@ -21627,7 +21627,7 @@ "type": "object", "properties": { "includePrivacy": { - "description": "If true then the list of agreements will inclue agreements for domain privacy as well.", + "description": "If true then the list of agreements will include agreements for domain privacy as well.", "type": "boolean" } } diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json index 9fa698acc458..ec314f07e90b 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2016-08-01/WebApps.json @@ -16686,7 +16686,7 @@ "type": "string" }, "priviledgedProcessorTime": { - "description": "Priviledged processor time.", + "description": "Privileged processor time.", "type": "string" }, "state": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json index 46d0444b6595..1b450e2db1b3 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2018-02-01/WebApps.json @@ -19974,7 +19974,7 @@ "type": "string" }, "priviledged_processor_time": { - "description": "Priviledged processor time.", + "description": "Privileged processor time.", "type": "string" }, "state": { diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md index 35ada8e4b8f8..a955cbb2bea0 100644 --- a/specification/web/resource-manager/readme.md +++ b/specification/web/resource-manager/readme.md @@ -9,7 +9,7 @@ The App service RP comprises of services where each service has its own tag. Hence, each sub-service has its own swagger spec. All of them are tied together using this configuration and are packaged together into one compute client library. -This makes it easier for customers to download one (nuget/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. +This makes it easier for customers to download one (NuGet/npm/pip/maven/gem) compute client library package rather than installing individual packages for each sub service. --- From 34dc9433c2216439f0c4edf074c2cba6a4e0b159 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 15:06:57 -0500 Subject: [PATCH 445/464] typo: iothub/resource-manager/Microsoft.Devices (#4923) - Double word "the" - Thehub -> The hub - Double word "state" --- .../preview/2018-12-01-preview/iothub.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json index 2d625f517795..7487dbf365a5 100644 --- a/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json +++ b/specification/iothub/resource-manager/Microsoft.Devices/preview/2018-12-01-preview/iothub.json @@ -511,7 +511,7 @@ ], "responses": { "200": { - "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the the Event Hub-compatible endpoint in this IoT hub", + "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" } @@ -1910,7 +1910,7 @@ "readOnly": true }, "state": { - "description": "Thehub state state.", + "description": "The hub state.", "type": "string", "readOnly": true }, @@ -2068,7 +2068,7 @@ "type": "object", "properties": { "sasTtlAsIso8601": { - "description": "The period of time for which the 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.", + "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" }, From 5cb975981ace996909ddc5a759252b3a016a1b4a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 15:08:36 -0500 Subject: [PATCH 446/464] typo: datamigration/resource-manager/Microsoft.DataMigration (#4924) - ertificate -> certificate --- .../2018-04-19/definitions/GetTdeCertificatesSqlTask.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json index 4ea9e72610b0..4a9f15ae8e03 100644 --- a/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json +++ b/specification/datamigration/resource-manager/Microsoft.DataMigration/stable/2018-04-19/definitions/GetTdeCertificatesSqlTask.json @@ -70,7 +70,7 @@ }, "SelectedCertificateInput": { "type": "object", - "description": "Info for ertificate to be exported for TDE enabled databases.", + "description": "Info for certificate to be exported for TDE enabled databases.", "properties": { "certificateName": { "type": "string", From 9470b39c8de234500c74e6863c89fd0fdc74cc8a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 15:13:21 -0500 Subject: [PATCH 447/464] typo: alertsmanagement/resource-manager/Microsoft.AlertsManagement (#4879) - Aler -> Alert - Succesfully -> Successfully - GetbyId -> GetById --- .../preview/2018-05-05-preview/AlertsManagement.json | 8 ++++---- .../examples/{Alerts_GetbyId.json => Alerts_GetById.json} | 0 ...{SmartGroups_GetbyId.json => SmartGroups_GetById.json} | 0 .../stable/2018-05-05/AlertsManagement.json | 4 ++-- .../examples/{Alerts_GetbyId.json => Alerts_GetById.json} | 0 ...{SmartGroups_GetbyId.json => SmartGroups_GetById.json} | 0 specification/alertsmanagement/resource-manager/readme.md | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) rename specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/{Alerts_GetbyId.json => Alerts_GetById.json} (100%) rename specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/{SmartGroups_GetbyId.json => SmartGroups_GetById.json} (100%) rename specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/{Alerts_GetbyId.json => Alerts_GetById.json} (100%) rename specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/{SmartGroups_GetbyId.json => SmartGroups_GetById.json} (100%) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json index b57a92105dc9..84709a47634e 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json @@ -40,7 +40,7 @@ ], "responses": { "200": { - "description": "OK. Succesfully retrieved operations list.", + "description": "OK. Successfully retrieved operations list.", "schema": { "$ref": "#/definitions/operationsList" } @@ -107,7 +107,7 @@ ], "responses": { "200": { - "description": "OK. Succesfully listed alert objects.", + "description": "OK. Successfully listed alert objects.", "schema": { "$ref": "#/definitions/alertsList" } @@ -164,7 +164,7 @@ }, "x-ms-examples": { "GetById": { - "$ref": "./examples/Alerts_GetbyId.json" + "$ref": "./examples/Alerts_GetById.json" } } } @@ -395,7 +395,7 @@ }, "x-ms-examples": { "Get": { - "$ref": "./examples/SmartGroups_GetbyId.json" + "$ref": "./examples/SmartGroups_GetById.json" } } } diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetById.json similarity index 100% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetbyId.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/Alerts_GetById.json diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetById.json similarity index 100% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetbyId.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/examples/SmartGroups_GetById.json diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json index be39f0573a39..11257261b16a 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json @@ -176,7 +176,7 @@ }, "x-ms-examples": { "GetById": { - "$ref": "./examples/Alerts_GetbyId.json" + "$ref": "./examples/Alerts_GetById.json" } } } @@ -437,7 +437,7 @@ }, "x-ms-examples": { "Get": { - "$ref": "./examples/SmartGroups_GetbyId.json" + "$ref": "./examples/SmartGroups_GetById.json" } } } diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/Alerts_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/Alerts_GetById.json similarity index 100% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/Alerts_GetbyId.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/Alerts_GetById.json diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/SmartGroups_GetbyId.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/SmartGroups_GetById.json similarity index 100% rename from specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/SmartGroups_GetbyId.json rename to specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/examples/SmartGroups_GetById.json diff --git a/specification/alertsmanagement/resource-manager/readme.md b/specification/alertsmanagement/resource-manager/readme.md index dcc1aebce0dd..162e94311ba5 100644 --- a/specification/alertsmanagement/resource-manager/readme.md +++ b/specification/alertsmanagement/resource-manager/readme.md @@ -2,7 +2,7 @@ > see https://aka.ms/autorest -This is the AutoRest configuration file for AlerManagement. +This is the AutoRest configuration file for AlertManagement. --- From e74dde5a37ecb15061b4588677ff4f4181dda029 Mon Sep 17 00:00:00 2001 From: yaborens <43987580+yaborens@users.noreply.github.com> Date: Mon, 17 Dec 2018 22:30:42 +0200 Subject: [PATCH 448/464] cost-management - API changes (#4818) * Update specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json Add more Scopes to Alerts. Also add /updateStatus to Alerts * Add billing parameter to departments * Add alert parameters --- .../2018-08-01-preview/costmanagement.json | 781 +++++++++++++++++- .../2018-08-01-preview/examples/Alert.json | 5 +- .../examples/AlertList.json | 10 +- 3 files changed, 782 insertions(+), 14 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json index 39a8195423e8..5303e371095c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/costmanagement.json @@ -1860,13 +1860,486 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListByEnrollment", + "description": "List all alerts for an enrollment.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListByDepartment", + "description": "List all alerts for a department.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListByAccount", + "description": "List all alerts for an account.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListByManagementGroups", + "description": "List all alerts for Management Groups.", + "x-ms-examples": { + "Alert_List": { + "$ref": "./examples/AlertList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { + "name": "$filter", + "description": "May be used to filter alerts by properties/definition/type, properties/definition/category, properties/definition/criteria, properties/costEntityId, properties/creationTime, properties/closeTime, properties/status, properties/source. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N alerts.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}": { "get": { "tags": [ "Alerts" ], - "operationId": "Alerts_GetBySubscription", - "description": "Gets the alert for a subscription by alert ID.", + "operationId": "Alerts_GetBySubscription", + "description": "Gets the alert for a subscription by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetByResourceGroupName", + "description": "Gets the alert for a resource group under a subscription by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetByEnrollment", + "description": "Gets the alert for an enrollment by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetByDepartment", + "description": "Gets the alert for a department by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetByAccount", + "description": "Gets the alert for an account by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_GetAlertByManagementGroups", + "description": "Gets an alert for Management Groups by alert ID.", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1880,7 +2353,7 @@ "$ref": "#/parameters/apiVersionParameter" }, { - "$ref": "#/parameters/subscriptionIdParameter" + "$ref": "#/parameters/managementGroupIdParameter" }, { "$ref": "#/parameters/alertIdParameter" @@ -1902,16 +2375,61 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}": { - "get": { + "/subscriptions/{subscriptionId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus": { + "patch": { "tags": [ "Alerts" ], - "operationId": "Alerts_GetByResourceGroupName", - "description": "Gets the alert for a resource group under a subscription by alert ID.", - "externalDocs": { - "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + "operationId": "Alerts_UpdateSubscriptionAlertStatus", + "description": "Update alerts status for a subscription.", + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus": { + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_UpdateResourceGroupNameAlertStatus", + "description": "Update alerts status for a resource group under a subscription.", "x-ms-examples": { "Alert": { "$ref": "./examples/Alert.json" @@ -1924,11 +2442,218 @@ { "$ref": "#/parameters/resourceGroupNameParameter" }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus": { + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_UpdateBillingAccountAlertStatus", + "description": "Update alerts status for billing account.", + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus": { + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_UpdateDepartmentsAlertStatus", + "description": "Update alerts status for a department.", + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/departmentIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}/providers/Microsoft.CostManagement/alerts/{alertId}/updateStatus": { + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_UpdateEnrollmentAccountAlertStatus", + "description": "Update alerts status for an enrollment account.", + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountIdParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.CostManagement/alerts/{alertId}/UpdateStatus": { + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_UpdateManagementGroupAlertStatus", + "description": "Update alerts status for management group.", + "x-ms-examples": { + "Alert": { + "$ref": "./examples/Alert.json" + } + }, + "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { + "$ref": "#/parameters/managementGroupIdParameter" + }, + { "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Alert" + }, + "description": "Parameters supplied to the update alerts status operation." } ], "responses": { @@ -3014,7 +3739,8 @@ "type": "object", "additionalProperties": { "type": "string" - } + }, + "readOnly": true }, "creationTime": { "format": "date-time", @@ -3040,7 +3766,23 @@ "x-ms-enum": { "name": "AlertStatus", "modelAsString": true - }, + } + }, + "statusModificationTime": { + "description": "The current status when alert status was modified.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "modificationTime": { + "description": "The current status when alert was modified.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "modificationUsername": { + "description": "The username who modified the alert.", + "type": "string", "readOnly": true } } @@ -3048,6 +3790,7 @@ "AlertDefinition": { "description": "The definition (rule) of an Alert", "type": "object", + "readOnly": true, "properties" : { "category": { "description": "Category of the alert.", @@ -3132,6 +3875,22 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "Management Group ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account Id", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" }, "reportNameParameter": { "name": "reportName", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json index 303607957fb9..7b453b028762 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/Alert.json @@ -26,7 +26,10 @@ "costEntityId": "123", "creationTime": "2018-09-03T11:21:43.3495582+03:00", "status": "Active", - "closeTime": "2018-09-10T11:21:43.3495582+03:00" + "closeTime": "2018-09-10T11:21:43.3495582+03:00", + "modificationTime": "2018-12-05T10:04:36.0321998Z", + "statusModificationUserName": "Ido Ben", + "statusModificationTime": "2018-12-05T10:04:36.0321998Z" } } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json index fed8b98dd1dd..a81a0565f8dd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2018-08-01-preview/examples/AlertList.json @@ -27,7 +27,10 @@ "costEntityId": "123", "creationTime": "2018-09-03T11:21:43.3495582+03:00", "status": "Resolved", - "closeTime": "2018-09-10T11:21:43.3495582+03:00" + "closeTime": "2018-09-10T11:21:43.3495582+03:00", + "modificationTime": "2018-12-05T10:04:36.0321998Z", + "statusModificationUserName": "Ido Ben", + "statusModificationTime": "2018-12-05T10:04:36.0321998Z" } }, { @@ -49,7 +52,10 @@ "costEntityId": "abc", "creationTime": "2018-09-03T11:21:43.3495582+03:00", "status": "Active", - "closeTime": "1970-01-01T00:00:00.0000000+00:00" + "closeTime": "1970-01-01T00:00:00.0000000+00:00", + "modificationTime": "2018-12-05T10:04:36.0321998Z", + "statusModificationUserName": "Ido Ben", + "statusModificationTime": "2018-12-05T10:04:36.0321998Z" } } ] From 8d950932d054f5ecc044ec8e7a943e56cbe3f449 Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 15:32:10 -0500 Subject: [PATCH 449/464] typo: logic/resource-manager/Microsoft.Logic (#4927) - releaseversion -> release version --- .../Microsoft.Logic/preview/2015-08-01-preview/logic.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json b/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json index 815f043f5b86..5e7722b0701c 100644 --- a/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json +++ b/specification/logic/resource-manager/Microsoft.Logic/preview/2015-08-01-preview/logic.json @@ -1727,7 +1727,7 @@ "$ref": "#/definitions/IntegrationAccountResource" } ] - }, + }, "IntegrationAccountPartnerProperties": { "type": "object", "properties": { @@ -2849,7 +2849,7 @@ "name": "HashingAlgorithm", "modelAsString": false } - }, + }, "EncryptionAlgorithm": { "type": "string", "enum": [ @@ -3488,7 +3488,7 @@ }, "messageRelease": { "type": "string", - "description": "The message releaseversion." + "description": "The message release version." }, "dataElementSeparator": { "type": "integer", From 428778799a33b6a2f7b4a8f2e09376e2babb55cc Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Mon, 17 Dec 2018 15:35:26 -0500 Subject: [PATCH 450/464] typo: guestconfiguration/resource-manager/Microsoft.GuestConfiguration (#4920) - implmented -> implemented - assingment -> assignment - configuation -> configuration --- .../stable/2018-11-20/guestconfiguration.json | 18 +++++++++--------- .../resource-manager/readme.md | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json index 8435ecc61a8f..92ba26085102 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json @@ -117,7 +117,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -274,7 +274,7 @@ "in": "path", "required": true, "type": "string", - "description": "The guest configuration assingment name." + "description": "The guest configuration assignment name." }, { "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" @@ -454,7 +454,7 @@ "enum": [ "DSC" ] - }, + }, "name": { "type": "string", "description": "Name of the guest configuration." @@ -515,7 +515,7 @@ "ApplyOnly", "ApplyAndMonitor", "ApplyAndAutoCorrect" - ] + ] }, "allowModuleOverwrite": { "type": "string", @@ -527,7 +527,7 @@ "enum": [ "True", "False" - ] + ] }, "actionAfterReboot": { "type": "string", @@ -540,7 +540,7 @@ "enum": [ "ContinueConfiguration", "StopConfiguration" - ] + ] }, "refreshFrequencyMins": { "type": "number", @@ -560,7 +560,7 @@ "enum": [ "True", "False" - ] + ] }, "configurationModeFrequencyMins": { "type": "number", @@ -692,7 +692,7 @@ "vm": { "$ref": "#/definitions/VMInfo", "description": "Information about the VM." - }, + }, "startTime": { "type": "string", "format": "date-time", @@ -834,7 +834,7 @@ "properties": { "type": "object", "readOnly": true, - "description": "Properties of a guest configuation assignment resource." + "description": "Properties of a guest configuration assignment resource." } }, "description": "The guest configuration assignment resource." diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 8a005afcc101..f3546bd74c41 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -71,7 +71,7 @@ directive: - suppress: OperationsAPIImplementation from: guestconfiguration.json where: $.paths - reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implmented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540' + reason: 'Microsoft.GuestConfiguration is a proxy resource provider under Microsoft.Compute. However, Operations API for is implemented. So, suppressing the false positive. Please refer PR https://github.com/Azure/azure-rest-api-specs-pr/pull/540' - suppress: OperationsAPIImplementation from: guestconfiguration_NotImplemented.json where: $.paths From 92a9287bd6ea1a9623f12921552dbcbf2608f600 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Mon, 17 Dec 2018 14:05:53 -0800 Subject: [PATCH 451/464] Event Grid 2019-01-01 API Version: Swagger and related test examples (#4899) * EventGrid: Update README files to include the current new preview api version 2018-09-preview * Update readme.go.md with related api version info * fix parsing failure due to missing closing ``` in readme.go.md * suppress failure due to known tool bug per approval from adxsr * Fix suppression message * add swagger and fix related examples for EventGrid 2019-01-01 API Version * Fix name mismatch in eventgrid.json in the examples to fix build failure * fix readme files to reflect correct location to eventgrid json file for stable version * remove 2019-01-01 from not dot NET multi-api sections to avoid auto-generating the corresponding SDKs * fix text * fix examples * Fix examples * Suppress failure due to known tool bug * example fixes * Adds suppression to readme --- .../stable/2019-01-01/EventGrid.json | 2209 +++++++++++++++++ ...ateForCustomTopic_EventHubDestination.json | 65 + ...stomTopic_HybridConnectionDestination.json | 65 + ...orCustomTopic_StorageQueueDestination.json | 66 + ...dateForCustomTopic_WebhookDestination.json | 66 + ...bscriptions_CreateOrUpdateForResource.json | 49 + ...ptions_CreateOrUpdateForResourceGroup.json | 49 + ...iptions_CreateOrUpdateForSubscription.json | 47 + ...entSubscriptions_DeleteForCustomTopic.json | 12 + .../EventSubscriptions_DeleteForResource.json | 12 + ...tSubscriptions_DeleteForResourceGroup.json | 12 + ...ntSubscriptions_DeleteForSubscription.json | 12 + .../EventSubscriptions_GetForCustomTopic.json | 38 + .../EventSubscriptions_GetForResource.json | 38 + ...ventSubscriptions_GetForResourceGroup.json | 38 + ...EventSubscriptions_GetForSubscription.json | 38 + ...ubscriptions_GetFullUrlForCustomTopic.json | 14 + ...ntSubscriptions_GetFullUrlForResource.json | 14 + ...scriptions_GetFullUrlForResourceGroup.json | 14 + ...bscriptions_GetFullUrlForSubscription.json | 14 + .../EventSubscriptions_ListByResource.json | 88 + ...bscriptions_ListGlobalByResourceGroup.json | 61 + ...ListGlobalByResourceGroupForTopicType.json | 43 + ...ubscriptions_ListGlobalBySubscription.json | 60 + ..._ListGlobalBySubscriptionForTopicType.json | 42 + ...criptions_ListRegionalByResourceGroup.json | 70 + ...stRegionalByResourceGroupForTopicType.json | 71 + ...scriptions_ListRegionalBySubscription.json | 69 + ...istRegionalBySubscriptionForTopicType.json | 70 + ...entSubscriptions_UpdateForCustomTopic.json | 55 + .../EventSubscriptions_UpdateForResource.json | 52 + ...tSubscriptions_UpdateForResourceGroup.json | 52 + ...ntSubscriptions_UpdateForSubscription.json | 52 + .../2019-01-01/examples/Operations_List.json | 83 + .../2019-01-01/examples/TopicTypes_Get.json | 22 + .../2019-01-01/examples/TopicTypes_List.json | 37 + .../examples/TopicTypes_ListEventTypes.json | 34 + .../examples/Topics_CreateOrUpdate.json | 33 + .../2019-01-01/examples/Topics_Delete.json | 12 + .../2019-01-01/examples/Topics_Get.json | 26 + .../examples/Topics_ListByResourceGroup.json | 43 + .../examples/Topics_ListBySubscription.json | 42 + .../examples/Topics_ListEventTypes.json | 38 + .../examples/Topics_ListSharedAccessKeys.json | 16 + .../examples/Topics_RegenerateKey.json | 19 + .../2019-01-01/examples/Topics_Update.json | 32 + .../eventgrid/resource-manager/readme.go.md | 10 + .../eventgrid/resource-manager/readme.md | 64 +- .../eventgrid/resource-manager/readme.ruby.md | 10 + 49 files changed, 4163 insertions(+), 15 deletions(-) create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/EventGrid.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListByResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Operations_List.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_List.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_ListEventTypes.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_CreateOrUpdate.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Delete.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListEventTypes.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListSharedAccessKeys.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_RegenerateKey.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Update.json diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/EventGrid.json new file mode 100644 index 000000000000..d780860e7242 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/EventGrid.json @@ -0,0 +1,2209 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-01-01", + "title": "EventGridManagementClient", + "description": "Azure EventGrid Management Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an event subscription", + "description": "Get properties of an event subscription", + "operationId": "EventSubscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetForSubscription": { + "$ref": "./examples/EventSubscriptions_GetForSubscription.json" + }, + "EventSubscriptions_GetForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetForResourceGroup.json" + }, + "EventSubscriptions_GetForResource": { + "$ref": "./examples/EventSubscriptions_GetForResource.json" + }, + "EventSubscriptions_GetForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetForCustomTopic.json" + } + } + }, + "put": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Create or update an event subscription", + "description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.", + "operationId": "EventSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionInfo", + "in": "body", + "description": "Event subscription properties containing the destination and filter information", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription CreateOrUpdate request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_CreateOrUpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForSubscription.json" + }, + "EventSubscriptions_CreateOrUpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json" + }, + "EventSubscriptions_CreateOrUpdateForResource": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResource.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Delete an event subscription", + "description": "Delete an existing event subscription", + "operationId": "EventSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_DeleteForSubscription": { + "$ref": "./examples/EventSubscriptions_DeleteForSubscription.json" + }, + "EventSubscriptions_DeleteForResourceGroup": { + "$ref": "./examples/EventSubscriptions_DeleteForResourceGroup.json" + }, + "EventSubscriptions_DeleteForResource": { + "$ref": "./examples/EventSubscriptions_DeleteForResource.json" + }, + "EventSubscriptions_DeleteForCustomTopic": { + "$ref": "./examples/EventSubscriptions_DeleteForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Update an event subscription", + "description": "Asynchronously updates an existing event subscription.", + "operationId": "EventSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be updated", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionUpdateParameters", + "in": "body", + "description": "Updated event subscription information", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscriptionUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription update request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_UpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_UpdateForSubscription.json" + }, + "EventSubscriptions_UpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_UpdateForResourceGroup.json" + }, + "EventSubscriptions_UpdateForResource": { + "$ref": "./examples/EventSubscriptions_UpdateForResource.json" + }, + "EventSubscriptions_UpdateForCustomTopic": { + "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription", + "description": "Get the full endpoint URL for an event subscription", + "operationId": "EventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionFullUrl" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetFullUrlForSubscription": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForSubscription.json" + }, + "EventSubscriptions_GetFullUrlForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResourceGroup.json" + }, + "EventSubscriptions_GetFullUrlForResource": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResource.json" + }, + "EventSubscriptions_GetFullUrlForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForCustomTopic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an aggregated list of all global event subscriptions under an Azure subscription", + "description": "List all aggregated global event subscriptions under a specific Azure subscription", + "operationId": "EventSubscriptions_ListGlobalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions for a topic type", + "description": "List all global event subscriptions under an Azure subscription for a topic type.", + "operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under an Azure subscription and resource group", + "description": "List all global event subscriptions under a specific Azure subscription and resource group", + "operationId": "EventSubscriptions_ListGlobalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under a resource group for a topic type", + "description": "List all global event subscriptions under a resource group for a specific topic type.", + "operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription", + "description": "List all event subscriptions from the given location under a specific Azure subscription", + "operationId": "EventSubscriptions_ListRegionalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group", + "operationId": "EventSubscriptions_ListRegionalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription for a topic type", + "description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.", + "operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type", + "operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all event subscriptions for a specific topic", + "description": "List all event subscriptions that have been created for a specific topic", + "operationId": "EventSubscriptions_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "EventSubscriptions_ListByResource": { + "$ref": "./examples/EventSubscriptions_ListByResource.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations", + "description": "List the available operations supported by the Microsoft.EventGrid resource provider", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get a topic", + "description": "Get properties of a topic", + "operationId": "Topics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Get": { + "$ref": "./examples/Topics_Get.json" + } + } + }, + "put": { + "tags": [ + "Topics" + ], + "summary": "Create a topic", + "description": "Asynchronously creates a new topic with the specified parameters.", + "operationId": "Topics_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "name": "topicInfo", + "in": "body", + "description": "Topic information", + "required": true, + "schema": { + "$ref": "#/definitions/Topic" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_CreateOrUpdate": { + "$ref": "./examples/Topics_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Topics" + ], + "summary": "Delete a topic", + "description": "Delete existing topic", + "operationId": "Topics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Delete": { + "$ref": "./examples/Topics_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Topics" + ], + "summary": "Update a topic", + "description": "Asynchronously updates a topic with the specified parameters.", + "operationId": "Topics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "name": "topicUpdateParameters", + "in": "body", + "description": "Topic update information", + "required": true, + "schema": { + "$ref": "#/definitions/TopicUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Topic update request accepted.", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Update": { + "$ref": "./examples/Topics_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under an Azure subscription", + "description": "List all the topics under an Azure subscription", + "operationId": "Topics_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Topics_ListBySubscription": { + "$ref": "./examples/Topics_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under a resource group", + "description": "List all the topics under a resource group", + "operationId": "Topics_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Topics_ListByResourceGroup": { + "$ref": "./examples/Topics_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": { + "post": { + "tags": [ + "Topics" + ], + "summary": "List keys for a topic", + "description": "List the two keys used to publish to a topic", + "operationId": "Topics_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListSharedAccessKeys": { + "$ref": "./examples/Topics_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": { + "post": { + "tags": [ + "Topics" + ], + "summary": "Regenerate key for a topic", + "description": "Regenerate a shared access key for a topic", + "operationId": "Topics_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key", + "required": true, + "schema": { + "$ref": "#/definitions/TopicRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_RegenerateKey": { + "$ref": "./examples/Topics_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topic event types", + "description": "List event types for a topic", + "operationId": "Topics_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the topic", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Topics_ListEventTypes": { + "$ref": "./examples/Topics_ListEventTypes.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List topic types", + "description": "List all registered topic types", + "operationId": "TopicTypes_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "TopicTypes_List": { + "$ref": "./examples/TopicTypes_List.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "Get a topic type", + "description": "Get information about a topic type", + "operationId": "TopicTypes_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypeInfo" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "TopicTypes_Get": { + "$ref": "./examples/TopicTypes_Get.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List event types", + "description": "List event types for a topic type", + "operationId": "TopicTypes_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "TopicTypes_ListEventTypes": { + "$ref": "./examples/TopicTypes_ListEventTypes.json" + } + } + } + } + }, + "definitions": { + "EventSubscriptionProperties": { + "description": "Properties of the Event Subscription", + "type": "object", + "properties": { + "topic": { + "description": "Name of the topic of the event subscription.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the event subscription.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed", + "AwaitingManualAction" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EventSubscriptionProvisioningState", + "modelAsString": true + } + }, + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The DeadLetter destination of the event subscription." + } + } + }, + "Resource": { + "description": "Definition of a Resource", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "EventSubscriptionFilter": { + "description": "Filter for the Event Subscription", + "type": "object", + "properties": { + "subjectBeginsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path prefix.\r\nThe format of this depends on the publisher of the events. \r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "subjectEndsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path suffix.\r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "includedEventTypes": { + "description": "A list of applicable event types that need to be part of the event subscription. \r\nIf it is desired to subscribe to all event types, the string \"all\" needs to be specified as an element in this list.", + "type": "array", + "items": { + "type": "string" + } + }, + "isSubjectCaseSensitive": { + "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter \r\nshould be compared in a case sensitive manner.", + "default": false, + "type": "boolean" + } + } + }, + "RetryPolicy": { + "description": "Information about the retry policy for an event subscription", + "type": "object", + "properties": { + "maxDeliveryAttempts": { + "format": "int32", + "description": "Maximum number of delivery retry attempts for events.", + "type": "integer" + }, + "eventTimeToLiveInMinutes": { + "format": "int32", + "description": "Time To Live (in minutes) for events.", + "type": "integer" + } + } + }, + "WebHookEventSubscriptionDestinationProperties": { + "description": "Information about the webhook destination properties for an event subscription.", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + }, + "endpointBaseUrl": { + "description": "The base URL that represents the endpoint of the destination of an event subscription.", + "type": "string", + "readOnly": true + } + } + }, + "StorageBlobDeadLetterDestinationProperties": { + "description": "Properties of the storage blob based dead letter destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that is the destination of the deadletter events. For example: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft.Storage/storageAccounts/{StorageAccountName}", + "type": "string" + }, + "blobContainerName": { + "description": "The name of the Storage blob container that is the destination of the deadletter events", + "type": "string" + } + } + }, + "StorageBlobDeadLetterDestination": { + "description": "Information about the storage blob based dead letter destination.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeadLetterDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties", + "description": "The properties of the Storage Blob based deadletter destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageBlob" + }, + "WebHookEventSubscriptionDestination": { + "description": "Information about the webhook destination for an event subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties", + "description": "WebHook Properties of the event subscription destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "WebHook" + }, + "DeadLetterDestination": { + "description": "Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.", + "type": "object", + "required": [ + "endpointType" + ], + "properties": { + "endpointType": { + "description": "Type of the endpoint for the dead letter destination", + "enum": [ + "StorageBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "DeadLetterEndPointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventHubEventSubscriptionDestinationProperties": { + "description": "The properties for a event hub destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.", + "type": "string" + } + } + }, + "EventHubEventSubscriptionDestination": { + "description": "Information about the event hub destination for an event subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties", + "description": "Event Hub Properties of the event subscription destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "StorageQueueEventSubscriptionDestinationProperties": { + "description": "The properties for a storage queue destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.", + "type": "string" + }, + "queueName": { + "description": "The name of the Storage queue under a storage account that is the destination of an event subscription.", + "type": "string" + } + } + }, + "StorageQueueEventSubscriptionDestination": { + "description": "Information about the storage queue destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties", + "description": "Storage Queue Properties of the event subscription destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageQueue" + }, + "HybridConnectionEventSubscriptionDestinationProperties": { + "description": "The properties for a hybrid connection destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.", + "type": "string" + } + } + }, + "HybridConnectionEventSubscriptionDestination": { + "description": "Information about the HybridConnection destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties", + "description": "Hybrid connection Properties of the event subscription destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "HybridConnection" + }, + "EventSubscriptionDestination": { + "description": "Information about the destination for an event subscription", + "type": "object", + "required": [ + "endpointType" + ], + "properties": { + "endpointType": { + "description": "Type of the endpoint for the event subscription destination", + "enum": [ + "WebHook", + "EventHub", + "StorageQueue", + "HybridConnection" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventSubscription": { + "description": "Event Subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventSubscriptionProperties", + "description": "Properties of the event subscription", + "x-ms-client-flatten": true + } + } + }, + "EventSubscriptionUpdateParameters": { + "description": "Properties of the Event Subscription update", + "type": "object", + "properties": { + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The DeadLetter destination of the event subscription." + } + } + }, + "EventSubscriptionFullUrl": { + "description": "Full endpoint url of an event subscription", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + } + } + }, + "EventSubscriptionsListResult": { + "description": "Result of the List EventSubscriptions operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of EventSubscriptions", + "type": "array", + "items": { + "$ref": "#/definitions/EventSubscription" + } + } + } + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + }, + "TopicProperties": { + "description": "Properties of the Topic", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TopicProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "description": "Endpoint for the topic.", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResource": { + "description": "Definition of a Tracked Resource", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Location of the resource", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Topic": { + "description": "EventGrid Topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicProperties", + "description": "Properties of the topic", + "x-ms-client-flatten": true + } + } + }, + "TopicUpdateParameters": { + "description": "Properties of the Topic update", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TopicsListResult": { + "description": "Result of the List Topics operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of Topics", + "type": "array", + "items": { + "$ref": "#/definitions/Topic" + } + } + } + }, + "TopicSharedAccessKeys": { + "description": "Shared access keys of the Topic", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the topic.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the topic.", + "type": "string" + } + } + }, + "TopicRegenerateKeyRequest": { + "description": "Topic regenerate share access key request", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate key1 or key2", + "type": "string" + } + } + }, + "EventTypesListResult": { + "description": "Result of the List Event Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of event types", + "type": "array", + "items": { + "$ref": "#/definitions/EventType" + } + } + } + }, + "EventTypeProperties": { + "description": "Properties of the event type", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the event type.", + "type": "string" + }, + "description": { + "description": "Description of the event type.", + "type": "string" + }, + "schemaUrl": { + "description": "Url of the schema for this event type.", + "type": "string" + } + } + }, + "EventType": { + "description": "Event Type for a subject under a topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventTypeProperties", + "description": "Properties of the event type.", + "x-ms-client-flatten": true + } + } + }, + "TopicTypesListResult": { + "description": "Result of the List Topic Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of topic types", + "type": "array", + "items": { + "$ref": "#/definitions/TopicTypeInfo" + } + } + } + }, + "TopicTypeProperties": { + "description": "Properties of a topic type.", + "type": "object", + "properties": { + "provider": { + "description": "Namespace of the provider of the topic type.", + "type": "string" + }, + "displayName": { + "description": "Display Name for the topic type.", + "type": "string" + }, + "description": { + "description": "Description of the topic type.", + "type": "string" + }, + "resourceRegionType": { + "description": "Region type of the resource.", + "enum": [ + "RegionalResource", + "GlobalResource" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceRegionType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the topic type", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TopicTypeProvisioningState", + "modelAsString": true + } + }, + "supportedLocations": { + "description": "List of locations supported by this topic type.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TopicTypeInfo": { + "description": "Properties of a topic type info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicTypeProperties", + "description": "Properties of the topic type info", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of the API to be used with the client request.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } + } \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json new file mode 100644 index 000000000000..a9d6c337dec6 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json new file mode 100644 index 000000000000..d254f31f7cc9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "HybridConnection", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + }, + "endpointType": "HybridConnection" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json new file mode 100644 index 000000000000..063a0106c541 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "StorageQueue", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json new file mode 100644 index 000000000000..83a6186d91b1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://contosofunction.azurewebsites.net/api/HttpTriggerCSharp1?code=" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointUrl": null, + "endpointBaseUrl": "https://contosofunction.azurewebsites.net/api/HttpTriggerCSharp1" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResource.json new file mode 100644 index 000000000000..130af51f5df2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResource.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2019-01-01", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json new file mode 100644 index 000000000000..0375149313cc --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2019-01-01", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json new file mode 100644 index 000000000000..4204f27d842a --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2019-01-01", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForCustomTopic.json new file mode 100644 index 000000000000..cce3201d3077 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForCustomTopic.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResource.json new file mode 100644 index 000000000000..bdf161d7204f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResource.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2019-01-01" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResourceGroup.json new file mode 100644 index 000000000000..b238cbdf7f41 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2019-01-01" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForSubscription.json new file mode 100644 index 000000000000..24bf6cc42f23 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_DeleteForSubscription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2019-01-01" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForCustomTopic.json new file mode 100644 index 000000000000..d67677160928 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForCustomTopic.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResource.json new file mode 100644 index 000000000000..816df3aac984 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResource.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResourceGroup.json new file mode 100644 index 000000000000..6ab3f9741272 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForSubscription.json new file mode 100644 index 000000000000..556becd0fc68 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetForSubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json new file mode 100644 index 000000000000..bc58d3771743 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResource.json new file mode 100644 index 000000000000..26aba43cf31f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResource.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json new file mode 100644 index 000000000000..f00c6204bb9d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForSubscription.json new file mode 100644 index 000000000000..573f5efd5ae6 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_GetFullUrlForSubscription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListByResource.json new file mode 100644 index 000000000000..023af1f7432a --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListByResource.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.EventGrid", + "resourceTypeName": "topics", + "resourceName": "exampletopic2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json new file mode 100644 index 000000000000..4cc3676ac68b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..b991ff4d69b7 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicTypeName": "Microsoft.Resources.ResourceGroups", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscription.json new file mode 100644 index 000000000000..faf78facf10c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..5a19d61f3d6e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "topicTypeName": "Microsoft.Resources.Subscriptions", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json new file mode 100644 index 000000000000..2b9f85f8403c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..ad243388fa96 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscription.json new file mode 100644 index 000000000000..4bfc6e86dcb0 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscription.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..286d231dfe5b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForCustomTopic.json new file mode 100644 index 000000000000..bd15eb6234fc --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForCustomTopic.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResource.json new file mode 100644 index 000000000000..c2215e558f27 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResource.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2019-01-01", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResourceGroup.json new file mode 100644 index 000000000000..9d34348e61d2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForResourceGroup.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2019-01-01", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForSubscription.json new file mode 100644 index 000000000000..1aba0269b691 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/EventSubscriptions_UpdateForSubscription.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2019-01-01", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "includedEventTypes": [ + "All" + ], + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Operations_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Operations_List.json new file mode 100644 index 000000000000..cb18d775e61b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Operations_List.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EventGrid/register/action", + "display": { + "provider": "Microsoft Event Grid", + "resource": "EventGrid Resource Provider", + "operation": "Registers the EventGrid Resource Provider", + "description": "Registers the eventSubscription for the EventGrid resource provider and enables the creation of Event Grid subscriptions." + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Write EventSubscription", + "description": "Create or update a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Read EventSubscription", + "description": "Read a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Delete EventSubscription", + "description": "Delete a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Write Topic", + "description": "Create or update a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Read Topic", + "description": "Read a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Delete Topic", + "description": "Delete a topic" + }, + "origin": "UserAndSystem" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_Get.json new file mode 100644 index 000000000000..d86fe416ddb4 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_List.json new file mode 100644 index 000000000000..0b050fe55aef --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Microsoft EventHubs service events.", + "displayName": "EventHubs Namespace", + "provider": "Microsoft.Eventhub", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces", + "name": "Microsoft.Eventhub.Namespaces", + "type": "Microsoft.EventGrid/topicTypes" + }, + { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_ListEventTypes.json new file mode 100644 index 000000000000..79370c691453 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/TopicTypes_ListEventTypes.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "Blob Created", + "description": "Raised when a blob is created.", + "schemaUrl": "tbd" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_CreateOrUpdate.json new file mode 100644 index 000000000000..2d7b702aeaca --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_CreateOrUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2019-01-01", + "topicInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Delete.json new file mode 100644 index 000000000000..7db78a66b0a8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName" : "exampletopic1", + "api-version": "2019-01-01" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Get.json new file mode 100644 index 000000000000..35ff2e4fa0b3 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListByResourceGroup.json new file mode 100644 index 000000000000..a5c32d869feb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListBySubscription.json new file mode 100644 index 000000000000..f572f1329bdd --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListEventTypes.json new file mode 100644 index 000000000000..2e90a053001e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListEventTypes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.Storage", + "resourceTypeName": "storageAccounts", + "resourceName": "ExampleStorageAccount", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Raised when a blob is created.", + "schemaUrl": "tbd", + "displayName": "Blob Created" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListSharedAccessKeys.json new file mode 100644 index 000000000000..4721e171a150 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName" : "exampletopic2", + "api-version": "2019-01-01" + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_RegenerateKey.json new file mode 100644 index 000000000000..8d6c31538807 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName" : "exampletopic2", + "api-version": "2019-01-01", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Update.json new file mode 100644 index 000000000000..201db2cf43a5 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2019-01-01/examples/Topics_Update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2019-01-01", + "topicUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} \ No newline at end of file diff --git a/specification/eventgrid/resource-manager/readme.go.md b/specification/eventgrid/resource-manager/readme.go.md index f77675d88cd1..0c7f7516672f 100644 --- a/specification/eventgrid/resource-manager/readme.go.md +++ b/specification/eventgrid/resource-manager/readme.go.md @@ -19,6 +19,16 @@ batch: - tag: package-2017-09-preview - tag: package-2017-06-preview ``` + +### Tag: package-2019-01 and go + +These settings apply only when `--tag=package-2019-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-01-01/$(namespace) +``` + ### Tag: package-2018-09-preview and go These settings apply only when `--tag=package-2018-09-preview --go` is specified on the command line. diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index be7dcc9ba2a0..63c26f117550 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Azure EventGrid. - - --- + ## Getting Started + To build the SDK for Azure EventGrid, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,20 +15,37 @@ To build the SDK for Azure EventGrid, simply [Install AutoRest](https://aka.ms/a To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Azure EventGrid API. ``` yaml openapi-type: arm -tag: package-2018-09-preview +tag: package-2019-01 ``` +### Tag: package-2019-01 + +These settings apply only when `--tag=package-2019-01` is specified on the command line. + +``` yaml $(tag) == 'package-2019-01' +input-file: +- Microsoft.EventGrid/stable/2019-01-01/EventGrid.json +``` + +## Suppression + +``` yaml +directive: + - suppress: TrackedResourcePatchOperation + from: EventGrid.json + reason: PATCH operation already exists in the json file but this is known issue in the ARM validation. +``` ### Tag: package-2018-09-preview @@ -46,6 +63,13 @@ directive: - suppress: TrackedResourcePatchOperation from: EventGrid.json reason: PATCH operation already exists in the json file but this is known issue in the ARM validation. + - suppress: ONE_OF_MULTIPLE + from: EventGrid.json + where: $.definitions.EventSubscriptionProperties.properties.destination + reason: |- + This is a false positive. We have multiple EventSubscriptionDestination types (EventHubEventSubscriptionDestination, HybridConnectionEventSubscriptionDestination etc.) and each of them has corresponding property classes e.g. EventHubEventSubscriptionDestinationProperties and HybridConnectionEventSubscriptionDestinationProperties have both a property called resourceId which is why the validation appears to be flagging this. + + However, the discriminator value (endpointType) is separate for each of these destinations, hence based on the discriminator it will get deserialized into the appropriate type. ``` ### Tag: package-2018-05-preview @@ -57,7 +81,6 @@ input-file: - Microsoft.EventGrid/preview/2018-05-01-preview/EventGrid.json ``` - ### Tag: package-2018-01 These settings apply only when `--tag=package-2018-01` is specified on the command line. @@ -67,7 +90,6 @@ input-file: - Microsoft.EventGrid/stable/2018-01-01/EventGrid.json ``` - ### Tag: package-2017-09-preview These settings apply only when `--tag=package-2017-09-preview` is specified on the command line. @@ -77,7 +99,6 @@ input-file: - Microsoft.EventGrid/preview/2017-09-15-preview/EventGrid.json ``` - ### Tag: package-2017-06-preview These settings apply only when `--tag=package-2017-06-preview` is specified on the command line. @@ -87,10 +108,9 @@ input-file: - Microsoft.EventGrid/preview/2017-06-15-preview/EventGrid.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -109,7 +129,6 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_event_grid'] ``` - ## C# These settings apply only when `--csharp` is specified on the command line. @@ -142,11 +161,13 @@ python: package-version: 1.0.0 clear-output-folder: true ``` + ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true output-folder: $(python-sdks-folder)/azure-mgmt-eventgrid/azure/mgmt/eventgrid ``` + ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true @@ -180,13 +201,26 @@ batch: - tag: package-2018-01 ``` -### Tag: package-2018-09-preview and java +### Tag: package-2019-01 and java + +These settings apply only when `--tag=package-2019-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2019-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventgrid.v2019_01_01 + output-folder: $(azure-libraries-for-java-folder)/eventgrid/resource-manager/v2019_01_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-09-preview and java -These settings apply only when `--tag=package-2018-09-preview --java` is specified on the command line. +These settings apply only when `--tag=package-2018-09-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. +Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2018-09-preview' && $(java) && $(multiapi) +``` yaml $(tag) == 'package-2018-09-preview' && $(java) && $(multiapi) java: namespace: com.microsoft.azure.management.eventgrid.v2018_09_15_preview output-folder: $(azure-libraries-for-java-folder)/eventgrid/resource-manager/v2018_09_15_preview diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md index 8c534cd95f85..1b6ccfeb2fb4 100644 --- a/specification/eventgrid/resource-manager/readme.ruby.md +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -19,6 +19,16 @@ batch: - tag: package-2017-06-preview ``` +### Tag: package-2019-01 and ruby + +These settings apply only when `--tag=package-2019-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-01' && $(ruby) +namespace: "Azure::EventGrid::Mgmt::V2019_01_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + ### Tag: package-2018-09-preview and ruby These settings apply only when `--tag=package-2018-09-preview --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. From a87e466231ad967ee6d0c94f1c593e7d3142e1dc Mon Sep 17 00:00:00 2001 From: Sarangan Rajamanickam Date: Mon, 17 Dec 2018 14:19:09 -0800 Subject: [PATCH 452/464] Fix the MoTTool to catch an exception (#4934) --- scripts/momentOfTruth.js | 3 ++- scripts/momentOfTruthPostProcessing.js | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/scripts/momentOfTruth.js b/scripts/momentOfTruth.js index c193f883aa9a..079ca28e7bf8 100644 --- a/scripts/momentOfTruth.js +++ b/scripts/momentOfTruth.js @@ -78,6 +78,7 @@ async function getLinterResult(swaggerPath) { console.log(`An error occurred while executing JSON.parse() on the linter output for ${swaggerPath}:`); console.dir(resultString); console.dir(e, { depth: null, colors: true }); + process.exit(1) } } return []; @@ -87,7 +88,7 @@ async function getLinterResult(swaggerPath) { async function runTools(swagger, beforeOrAfter) { console.log(`Processing "${swagger}":`); const linterErrors = await getLinterResult(swagger); - console.log(`Linter produced ${linterErrors.length} results`); + console.log(linterErrors); await updateResult(swagger, linterErrors, beforeOrAfter); }; diff --git a/scripts/momentOfTruthPostProcessing.js b/scripts/momentOfTruthPostProcessing.js index e838c8e683aa..0ebada4bc33f 100644 --- a/scripts/momentOfTruthPostProcessing.js +++ b/scripts/momentOfTruthPostProcessing.js @@ -63,6 +63,7 @@ try { console.log(`Failed to read diff results from file ${logFilepath}`); console.log("File content:"); console.log(data); + process.exit(1) } function compareJsonRef(beforeJsonRef, afterJsonRef) { From fe5107094b812b9ecee12c3d598bf5546e719611 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Mon, 17 Dec 2018 16:49:33 -0800 Subject: [PATCH 453/464] QnQMaker py conf (#4936) --- .../data-plane/QnAMaker/readme.md | 25 +----------------- .../data-plane/QnAMaker/readme.python.md | 26 +++++++++++++++++++ 2 files changed, 27 insertions(+), 24 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/QnAMaker/readme.python.md diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.md index 46c348f2d021..3b34d948675f 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/readme.md +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.md @@ -53,30 +53,7 @@ csharp: ## 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: - license-header: MICROSOFT_MIT_NO_VERSION - add-credentials: true - payload-flattening-threshold: 2 - namespace: azure.cognitiveservices.knowledge.qnamaker - package-name: azure-cognitiveservices-knowledge-qnamaker - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-qnamaker/azure/cognitiveservices/knowledge/qnamaker -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-cognitiveservices-knowledge-qnamaker -``` +See configuration in [readme.python.md](./readme.python.md) ## Go diff --git a/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md new file mode 100644 index 000000000000..ef14d552823a --- /dev/null +++ b/specification/cognitiveservices/data-plane/QnAMaker/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + add-credentials: true + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.knowledge.qnamaker + package-name: azure-cognitiveservices-knowledge-qnamaker + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-knowledge-qnamaker/azure/cognitiveservices/knowledge/qnamaker +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-cognitiveservices-knowledge-qnamaker +``` From 60ba6c3597808284eb834fb432a0b20e9fc8c837 Mon Sep 17 00:00:00 2001 From: Matt Boersma Date: Tue, 18 Dec 2018 13:31:13 -0700 Subject: [PATCH 454/464] [AKS] mark ACS endpoints as deprecated (#4917) ACS will be decommissioned at the end of January, 2020. Users are encouraged to use AKS instead. --- .../stable/2016-03-30/containerService.json | 19 +++++++++++--- .../stable/2016-09-30/containerService.json | 25 ++++++++++++++----- .../stable/2017-01-31/containerService.json | 25 ++++++++++++++----- .../stable/2017-07-01/containerService.json | 5 ++++ 4 files changed, 58 insertions(+), 16 deletions(-) diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json index a09cb216a1b9..01437fb2681c 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-03-30/containerService.json @@ -18,6 +18,7 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -46,6 +47,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { "put": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -105,6 +107,7 @@ "x-ms-long-running-operation": true }, "get": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -142,6 +145,7 @@ } }, "delete": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -182,6 +186,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -268,7 +273,9 @@ } }, "description": "Profile for the container service orchestrator.", - "required": [ "orchestratorType" ] + "required": [ + "orchestratorType" + ] }, "ContainerServiceMasterProfile": { "properties": { @@ -430,7 +437,9 @@ } }, "description": "SSH configuration for Linux-based VMs running on Azure.", - "required": ["publicKeys"] + "required": [ + "publicKeys" + ] }, "ContainerServiceSshPublicKey": { "properties": { @@ -451,7 +460,9 @@ "description": "Profile for the container service VM diagnostic agent." } }, - "required": ["vmDiagnostics"] + "required": [ + "vmDiagnostics" + ] }, "ContainerServiceVMDiagnostics": { "properties": { @@ -489,7 +500,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/ContainerService" + "$ref": "#/definitions/ContainerService" }, "description": "the list of container services." } diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json index 39d97dbc3e87..4c4cba0373e7 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2016-09-30/containerService.json @@ -18,6 +18,7 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -47,6 +48,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { "put": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -107,11 +109,12 @@ "x-ms-long-running-operation": true }, "get": { + "deprecated": true, "tags": [ "ContainerService" ], "operationId": "ContainerServices_Get", - "summary":"Gets the properties of the specified container service.", + "summary": "Gets the properties of the specified container service.", "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", "parameters": [ { @@ -145,6 +148,7 @@ } }, "delete": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -186,6 +190,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -265,7 +270,9 @@ } }, "description": "Properties to configure a custom container service cluster.", - "required": ["orchestrator"] + "required": [ + "orchestrator" + ] }, "ContainerServiceServicePrincipalProfile": { "properties": { @@ -302,7 +309,9 @@ } }, "description": "Profile for the container service orchestrator.", - "required": [ "orchestratorType" ] + "required": [ + "orchestratorType" + ] }, "ContainerServiceMasterProfile": { "properties": { @@ -469,7 +478,9 @@ } }, "description": "SSH configuration for Linux-based VMs running on Azure.", - "required": ["publicKeys"] + "required": [ + "publicKeys" + ] }, "ContainerServiceSshPublicKey": { "properties": { @@ -490,7 +501,9 @@ "description": "Profile for the container service VM diagnostic agent." } }, - "required": ["vmDiagnostics"] + "required": [ + "vmDiagnostics" + ] }, "ContainerServiceVMDiagnostics": { "properties": { @@ -528,7 +541,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/ContainerService" + "$ref": "#/definitions/ContainerService" }, "description": "the list of container services." }, diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json index cf7a1df8e4a7..5b5b60c22420 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-01-31/containerService.json @@ -36,6 +36,7 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -70,6 +71,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { "put": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -135,11 +137,12 @@ } }, "get": { + "deprecated": true, "tags": [ "ContainerService" ], "operationId": "ContainerServices_Get", - "summary":"Gets the properties of the specified container service.", + "summary": "Gets the properties of the specified container service.", "description": "Gets the properties of the specified container service in the specified subscription and resource group. The operation returns the properties including state, orchestrator, number of masters and agents, and FQDNs of masters and agents. ", "parameters": [ { @@ -178,6 +181,7 @@ } }, "delete": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -224,6 +228,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -308,7 +313,9 @@ } }, "description": "Properties to configure a custom container service cluster.", - "required": ["orchestrator"] + "required": [ + "orchestrator" + ] }, "ContainerServiceServicePrincipalProfile": { "properties": { @@ -345,7 +352,9 @@ } }, "description": "Profile for the container service orchestrator.", - "required": [ "orchestratorType" ] + "required": [ + "orchestratorType" + ] }, "ContainerServiceMasterProfile": { "properties": { @@ -512,7 +521,9 @@ } }, "description": "SSH configuration for Linux-based VMs running on Azure.", - "required": ["publicKeys"] + "required": [ + "publicKeys" + ] }, "ContainerServiceSshPublicKey": { "properties": { @@ -533,7 +544,9 @@ "description": "Profile for the container service VM diagnostic agent." } }, - "required": ["vmDiagnostics"] + "required": [ + "vmDiagnostics" + ] }, "ContainerServiceVMDiagnostics": { "properties": { @@ -571,7 +584,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/ContainerService" + "$ref": "#/definitions/ContainerService" }, "description": "the list of container services." }, diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json index 7bf721fb0bc5..0be58e80fc65 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2017-07-01/containerService.json @@ -36,6 +36,7 @@ "paths": { "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerServices" ], @@ -70,6 +71,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices/{containerServiceName}": { "put": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -131,6 +133,7 @@ } }, "get": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -170,6 +173,7 @@ } }, "delete": { + "deprecated": true, "tags": [ "ContainerService" ], @@ -212,6 +216,7 @@ }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/containerServices": { "get": { + "deprecated": true, "tags": [ "ContainerServices" ], From e13c045c8ac4400832160175e4f440d55bae5650 Mon Sep 17 00:00:00 2001 From: Qingqing Date: Wed, 19 Dec 2018 08:58:58 -0800 Subject: [PATCH 455/464] [AKS]: SP/AAD update operation for 2018-03-31 and 2018-08-01-preview (#4937) * add operation for 2018-03-31 and 2018-08-01-preview * correct example fileName * add default response and 202, correct typo --- .../ManagedClustersResetAADProfile.json | 74 ++++++++ ...dClustersResetServicePrincipalProfile.json | 67 +++++++ .../2018-08-01-preview/managedClusters.json | 169 ++++++++++++++++++ .../ManagedClustersResetAADProfile.json | 74 ++++++++ ...dClustersResetServicePrincipalProfile.json | 67 +++++++ .../stable/2018-03-31/managedClusters.json | 122 +++++++++++++ 6 files changed, 573 insertions(+) create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..d0191f93e886 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "aadProfile": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "aadProfile": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "tenantID": "tenantid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } + } + \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..c1f93e9bc5f0 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } + } + \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json index 7a3fb8844ed6..8dd8e8005aee 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/preview/2018-08-01-preview/managedClusters.json @@ -521,6 +521,140 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile":{ + "post":{ + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset Service Principal Profile of a managed cluster.", + "description": "Update the service principal Profile for a managed cluster.", + "parameters":[ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile":{ + "post":{ + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset AAD Profile of a managed cluster.", + "description": "Update the AAD Profile for a managed cluster.", + "parameters":[ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } } }, "definitions": { @@ -1438,6 +1572,41 @@ } }, "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." } }, "parameters": { diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..5b1418a8da45 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "aadProfile": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "aadProfile": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "tenantID": "tenantid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } + } + \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..6a14e1456664 --- /dev/null +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2018-03-31", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "storageProfile": "ManagedDisks", + "maxPods": 110, + "osType": "Linux" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } + } + \ No newline at end of file diff --git a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json index aa36a7aaea6a..6ce659b61557 100644 --- a/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json +++ b/specification/containerservices/resource-manager/Microsoft.ContainerService/stable/2018-03-31/managedClusters.json @@ -521,6 +521,128 @@ } } } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile":{ + "post":{ + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset Service Principal Profile of a managed cluster.", + "description": "Update the service principal Profile for a managed cluster.", + "parameters":[ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile":{ + "post":{ + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset AAD Profile of a managed cluster.", + "description": "Update the AAD Profile for a managed cluster.", + "parameters":[ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed cluster resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } } }, "definitions": { From a29634e23abd47fe0c2549ade2c4d85e131467ef Mon Sep 17 00:00:00 2001 From: Sudhindra Kovalam Date: Wed, 19 Dec 2018 11:23:58 -0800 Subject: [PATCH 456/464] chore) add x-ms-client-id property (#4946) --- .../stable/2018-05-01/maps-management.json | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json index 727b920e3175..80932cdb5ec4 100644 --- a/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json +++ b/specification/maps/resource-manager/Microsoft.Maps/stable/2018-05-01/maps-management.json @@ -589,6 +589,11 @@ "readOnly": true, "description": "The SKU of this account.", "$ref": "#/definitions/Sku" + }, + "properties": { + "readOnly": true, + "description": "The map account properties.", + "$ref": "#/definitions/MapsAccountProperties" } }, "allOf": [ @@ -784,6 +789,15 @@ } } } + }, + "MapsAccountProperties": { + "description": "Additional Map account properties", + "properties": { + "x-ms-client-id":{ + "description": "A unique identifier for the maps account", + "type":"string" + } + } } } } From 7119de004768fea8a3a2571e3e729d6e20d7264d Mon Sep 17 00:00:00 2001 From: Rich Franklin Date: Wed, 19 Dec 2018 15:28:35 -0800 Subject: [PATCH 457/464] Instance Metadata Service: Initial Commit (#4493) * Instance Metadata Service: Initial Commit Initial commit of Instance Metadata Service -Added Swagger for 2018-10-01 -Added examples for 2018-10-01 * Instance Metadata Service: Updates -Removed erroneous format tags -Added security section * Instance Metadata Service: Updates -Moved to imds/data-plane from imds/resource-provider * Instance Metadata Service: Added language .md files * Instance Metadata Service: Updated ErrorResponse -Removed individual error codes from operations * Instance Metadata Service: Updates to Swagger -Created separate Identity error property -Updated descriptions and added them where necessary -Created parameters section and moved api-version and Metadata to it -Renamed operationIds * Added x-ms-parameter-location to Metadata parameter * -Minor property name changes -Removed previous API versions from enum * -Fixed a typo * -Added missing descriptions * -Added more missing descriptions * -Changed openapi type to data-plane * -Added DefinitionsPropertiesNamesCamelCase suppression to readme * -Forgot one camelcase suppression * -Removed a newline --- .../2018-10-01/examples/getattesteddata.json | 50 ++ .../2018-10-01/examples/getidentityinfo.json | 43 + .../2018-10-01/examples/getidentitytoken.json | 50 ++ .../examples/getinstancemetadata.json | 82 ++ .../stable/2018-10-01/imds.json | 765 ++++++++++++++++++ .../imds/data-plane/readme.csharp.md | 20 + specification/imds/data-plane/readme.go.md | 10 + specification/imds/data-plane/readme.md | 73 ++ .../imds/data-plane/readme.nodejs.md | 16 + .../imds/data-plane/readme.python.md | 27 + specification/imds/data-plane/readme.ruby.md | 10 + .../imds/data-plane/readme.typescript.md | 14 + 12 files changed, 1160 insertions(+) create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json create mode 100644 specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json create mode 100644 specification/imds/data-plane/readme.csharp.md create mode 100644 specification/imds/data-plane/readme.go.md create mode 100644 specification/imds/data-plane/readme.md create mode 100644 specification/imds/data-plane/readme.nodejs.md create mode 100644 specification/imds/data-plane/readme.python.md create mode 100644 specification/imds/data-plane/readme.ruby.md create mode 100644 specification/imds/data-plane/readme.typescript.md diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json new file mode 100644 index 000000000000..f263d37ed78f --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "nonce": "abcde12345", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "encoding": "pkcs7", + "signature": "MIID2gYJKoZIhvcNAQcCoIIDyzCCA8cCAQExDzANBgkqhkiG9w0BAQsFADCBggYJKoZIhvcNAQcBoHUEc3sibm9uY2UiOiIxMTExMTExMTExIiwicGxhbiI6eyJuYW1lIjoiIiwicHJvZHVjdCI6IiIsInB1Ymxpc2hlciI6IiJ9LCJ2bUlkIjoiMDJhYWI4YTQtNzRlZi00NzZlLTgxODItZjZkMmJhNDE2NmE2In2gggI/MIICOzCCAaSgAwIBAgIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQQFADArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbTAeFw0xODExMDgxODUzMDRaFw0xODEyMDgxODUzMDNaMCsxKTAnBgNVBAMTIHRlc3RzdWJkb21haW4ubWV0YWRhdGEuYXp1cmUuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDEi0FVslYnUX+MneC7ERMU4ZM88z4J80r7RPgvzxCPNhXUQlWm3cmVRZMD8kKMv7brkvEsATP7Ak60/I/XEtOga4LGCvMaQa8I/MW8IhSyp2Vj015glAiV8TeUI5DuOIOS96lQvM+G7bt23swkIwVjm1u1ViTZiKKytwpY/EGqzQIDAQABo2AwXjBcBgNVHQEEVTBTgBAt3MRgJmEoUMiPy7k06cLfoS0wKzEpMCcGA1UEAxMgdGVzdHN1YmRvbWFpbi5tZXRhZGF0YS5henVyZS5jb22CEEFrBY1zd+aASShVyN0KzN0wDQYJKoZIhvcNAQEEBQADgYEAd87qiZnRlGIFQ5IEcL/A7ru23WSQAOBsNPt70Fg1GtaEHcYshKUJFhGwXOgZ11cY5wRfrSvEKuzvhAeIZwkvzkBjC04g8sRrjN5leLY5CsKzQhjN52TUMsHhqTM58tfAnICeTddQwn6LOgfqtYH5WO+F/VbFCwPstYUqjmQEYAoxgegwgeUCAQEwPzArMSkwJwYDVQQDEyB0ZXN0c3ViZG9tYWluLm1ldGFkYXRhLmF6dXJlLmNvbQIQQWsFjXN35oBJKFXI3QrM3TANBgkqhkiG9w0BAQsFADANBgkqhkiG9w0BAQEFAASBgCbkRKmQ1MdWZPVOrX7ZBKHQUWPFrQQNdjk3KB67GkY0W0Taxut4K7D2PmiflVEwxB92pTbaZZr/dldu1k1ab1YamHcVYdgZgxIkoOWohGR0ym8oL9JHjFMEqHUbEPtDwE8X+djtDd8TVdb6LYe77IXmz/VaX4whuejlSvQXjaL" + } + }, + "400": { + "body": { + "error": "Bad request" + } + }, + "403": { + "body": { + "error": "Forbidden" + } + }, + "404": { + "body": { + "error": "Not found" + } + }, + "405": { + "body": { + "error": "Not allowed" + } + }, + "429": { + "body": { + "error": "Too many requests" + } + }, + "503": { + "body": { + "error": "Service unavailable" + } + }, + "500": { + "body": { + "error": "Server error" + } + } + } +} \ No newline at end of file diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json new file mode 100644 index 000000000000..e0857d0bceb9 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "tenantId": "abd8daee-d393-4239-9377-883adda3d40f" + } + }, + "400": { + "body": { + "error": "invalid_request", + "error_description": "Bad request" + } + }, + "404": { + "body": { + "error": "not_found", + "error_description": "Not found" + } + }, + "405": { + "body": { + "error": "method_not_allowed", + "error_description": "Not allowed" + } + }, + "429": { + "body": { + "error": "too_many_requests", + "error_description": "Too many requests" + } + }, + "500": { + "body": { + "error": "server_error", + "error_description": "Server error" + } + } + } +} \ No newline at end of file diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json new file mode 100644 index 000000000000..0cf1fd061608 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "Metadata": "true", + "resource": "https://vault.azure.net" + }, + "responses": { + "200": { + "body": { + "access_token": "dummytoken", + "client_id": "be5947ed-3560-4afe-9504-59967a63f810", + "expires_in": "3599", + "expires_on": "1541705014", + "ext_expires_in": "262800", + "not_before": "1508961830", + "resource": "https://va" + } + }, + "400": { + "body": { + "error": "invalid_request", + "error_description": "Bad request" + } + }, + "404": { + "body": { + "error": "not_found", + "error_description": "Not found" + } + }, + "405": { + "body": { + "error": "method_not_allowed", + "error_description": "Not allowed" + } + }, + "429": { + "body": { + "error": "too_many_requests", + "error_description": "Too many requests" + } + }, + "500": { + "body": { + "error": "server_error", + "error_description": "Server error" + } + } + } +} \ No newline at end of file diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json new file mode 100644 index 000000000000..c5f5cb36b8f3 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "Metadata": "true" + }, + "responses": { + "200": { + "body": { + "compute": { + "azEnvironment": "AZUREPUBLICCLOUD", + "location": "westus", + "name": "examplevmname", + "offer": "Windows", + "osType": "linux", + "placementGroupId": "f67c14ab-e92c-408c-ae2d-da15866ec79a", + "plan": { + "name": "planName", + "product": "planProduct", + "publisher": "planPublisher" + }, + "platformFaultDomain": "36", + "platformUpdateDomain": "42", + "publicKeys": [ + { + "keyData": "ssh-rsa 0", + "path": "/home/user/.ssh/authorized_keys0" + }, + { + "keyData": "ssh-rsa 1", + "path": "/home/user/.ssh/authorized_keys1" + } + ], + "publisher": "RDFE-Test-Microsoft-Windows-Server-Group", + "resourceGroupName": "macikgo-test-may-23", + "sku": "Windows-Server-2012-R2-Datacenter", + "subscriptionId": "8d10da13-8125-4ba9-a717-bf7490507b3d", + "tags": "baz:bash;foo:bar", + "version": "15.05.22", + "vmId": "02aab8a4-74ef-476e-8182-f6d2ba4166a6", + "vmScaleSetName": "crpteste9vflji9", + "vmSize": "Standard_A3", + "zone": "" + } + } + }, + "400": { + "body": { + "error": "Bad request" + } + }, + "403": { + "body": { + "error": "Forbidden" + } + }, + "404": { + "body": { + "error": "Not found" + } + }, + "405": { + "body": { + "error": "Not allowed" + } + }, + "429": { + "body": { + "error": "Too many requests" + } + }, + "503": { + "body": { + "error": "Service unavailable" + } + }, + "500": { + "body": { + "error": "Server error" + } + } + } +} \ No newline at end of file diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json new file mode 100644 index 000000000000..ecd501259644 --- /dev/null +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json @@ -0,0 +1,765 @@ +{ + "swagger": "2.0", + "info": { + "title": "InstanceMetadataClient", + "description": "The Azure Instance Metadata Client", + "version": "2018-10-01" + }, + "host": "169.254.169.254", + "basePath": "/metadata", + "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": { + "/instance": { + "get": { + "operationId": "Instances_GetMetadata", + "description": "Get Instance Metadata for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Instance" + } + }, + "400": { + "description": "Invalid request", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "405": { + "description": "Method not allowed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Instance Metadata for the VM": { + "$ref": "./examples/getinstancemetadata.json" + } + } + } + }, + "/attested/document": { + "get": { + "operationId": "Attested_GetDocument", + "description": "Get Attested Data for the Virtual Machine.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "nonce", + "in": "query", + "required": false, + "type": "string", + "description": "This is a string of up to 32 random alphanumeric characters." + }, + { + "$ref": "#/parameters/MetadataParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AttestedData" + } + }, + "400": { + "description": "Invalid request", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "405": { + "description": "Method not allowed", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "503": { + "description": "Service unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "500": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Attested Data for the VM": { + "$ref": "./examples/getattesteddata.json" + } + } + } + }, + "/identity/oauth2/token": { + "get": { + "tags": [ + "Get token" + ], + "description": "Get a Token from Azure AD", + "operationId": "Identity_GetToken", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "name": "resource", + "in": "query", + "type": "string", + "description": "This is the urlencoded identifier URI of the sink resource for the requested Azure AD token. The resulting token contains the corresponding aud for this resource.", + "required": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "client_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD client id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with object_id and msi_res_id.", + "required": false + }, + { + "name": "object_id", + "in": "query", + "type": "string", + "description": "This identifies, by Azure AD object id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and msi_res_id.", + "required": false + }, + { + "name": "msi_res_id", + "in": "query", + "type": "string", + "description": "This identifies, by urlencoded ARM resource id, a specific explicit identity to use when authenticating to Azure AD. Mutually exclusive with client_id and object_id.", + "required": false + }, + { + "name": "authority", + "in": "query", + "type": "string", + "description": "This indicates the authority to request AAD tokens from. Defaults to the known authority of the identity to be used.", + "required": false + }, + { + "name": "bypass_cache", + "in": "query", + "type": "string", + "enum": [ + "true" + ], + "description": "If provided, the value must be 'true'. This indicates to the server that the token must be retrieved from Azure AD and cannot be retrieved from an internal cache.", + "required": false, + "x-ms-enum": { + "name": "BypassCache", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityTokenResponse" + } + }, + "400": { + "description": "Invalid request", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "405": { + "description": "Method not allowed", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "500": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Token for the VM": { + "$ref": "./examples/getidentitytoken.json" + } + } + } + }, + "/identity/info": { + "get": { + "tags": [ + "Get metadata information" + ], + "description": "Get information about AAD Metadata", + "operationId": "Identity_GetInfo", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/MetadataParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "$ref": "#/definitions/IdentityInfoResponse" + } + }, + "400": { + "description": "Invalid request", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "405": { + "description": "Method not allowed", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "500": { + "description": "Server error", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/IdentityErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Identity Info for the VM": { + "$ref": "./examples/getidentityinfo.json" + } + } + } + } + }, + "definitions": { + "Compute": { + "type": "object", + "properties": { + "azEnvironment": { + "type": "string", + "description": "This is the name of the environment in which the VM is running." + }, + "location": { + "type": "string", + "description": "This is the Azure Region in which the VM is running." + }, + "name": { + "type": "string", + "description": "This is the name of the VM." + }, + "offer": { + "type": "string", + "description": "This is the offer information for the VM image. This value is only present for images deployed from the Azure Image Gallery." + }, + "osType": { + "type": "string", + "description": "This value indicates the type of OS the VM is running, either Linux or Windows." + }, + "placementGroupId": { + "type": "string", + "description": "This is the placement group of your Virtual Machine Scale Set." + }, + "plan": { + "type": "object", + "description": "This contains the data about the plan.", + "$ref": "#/definitions/PlanProperties" + }, + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicKeysProperties" + }, + "description": "This is information about the SSH certificate" + }, + "platformFaultDomain": { + "type": "string", + "description": "This is the fault domain in which the VM." + }, + "platformUpdateDomain": { + "type": "string", + "description": "This is the update domain in which the VM." + }, + "provider": { + "type": "string", + "description": "This is the provider of the VM." + }, + "publisher": { + "type": "string", + "description": "This is the publisher of the VM image." + }, + "resourceGroupName": { + "type": "string", + "description": "This is the resource group for the VM." + }, + "sku": { + "type": "string", + "description": "This is the specific SKU for the VM image." + }, + "subscriptionId": { + "type": "string", + "description": "This is the Azure subscription for the VM." + }, + "tags": { + "type": "string", + "description": "This is the list of tags for your VM." + }, + "version": { + "type": "string", + "description": "This is the version of the VM image." + }, + "vmId": { + "type": "string", + "description": "This is the unique identifier for the VM." + }, + "vmScaleSetName": { + "type": "string", + "description": "This is the resource name of the VMSS." + }, + "vmSize": { + "type": "string", + "description": "This is the size of the VM." + }, + "zone": { + "type":"string", + "description":"This is the availability zone of the VM." + } + }, + "description": "Compute Metadata" + }, + "Network": { + "type": "object", + "properties": { + "interface": { + "type":"array", + "description": "This contains data about the network interface.", + "items": { + "type": "object", + "$ref": "#/definitions/NetworkInterface" + } + } + }, + "description": "Network Metadata" + }, + "NetworkInterface": { + "type": "object", + "description": "This contains data about the network interface.", + "properties": { + "ipv4": { + "type":"object", + "description": "This contains the IPv4 address.", + "properties": { + "ipAddress": { + "type":"array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv4 properties.", + "$ref":"#/definitions/Ipv4Properties" + } + }, + "subnet": { + "type":"array", + "description": "This is the subnet", + "items": { + "type": "object", + "description": "This contains the subnet properties.", + "$ref": "#/definitions/SubnetProperties" + } + } + } + }, + "ipv6": { + "type":"object", + "description": "This contains the IPv6 address.", + "properties": { + "ipAddress": { + "type":"array", + "description": "This is the IP address", + "items": { + "type": "object", + "description": "This contains the IPv6 properties.", + "$ref":"#/definitions/Ipv6Properties" + } + } + } + }, + "macAddress": { + "type":"string", + "description":"This is the MAC address of the interface." + } + } + }, + "PlanProperties": { + "type": "object", + "description": "This contains the data about the plan.", + "properties": { + "name": { + "type": "string", + "description": "This is the Plan ID." + }, + "publisher": { + "type": "string", + "description": "This is the publisher ID." + }, + "product": { + "type": "string", + "description": "This is the product of the image from the Marketplace." + } + } + }, + "PublicKeysProperties": { + "type": "object", + "description": "This contains the data about the public key.", + "properties": { + "path": { + "type": "string", + "description": "This specifies the full path on the VM where the SSH public key is stored." + }, + "keyData": { + "type": "string", + "description": "This is the SSH public key certificate used to authenticate with the VM." + } + } + }, + "Ipv4Properties": { + "type": "object", + "description": "This contains the IPv4 properties.", + "properties": { + "privateIpAddress": { + "type":"string", + "description":"This is the private IP address assigned to the interface." + }, + "publicIpAddress": { + "type":"string", + "description":"This is the public IP address assigned to the interface." + } + } + }, + "Ipv6Properties": { + "type": "object", + "description": "This contains the IPv6 properties.", + "properties": { + "privateIpAddress": { + "type":"string", + "description":"This is the private IPv6 address assigned to the interface." + } + } + }, + "SubnetProperties": { + "type": "object", + "description": "This contains the properties of the subnet.", + "properties": { + "address": { + "type":"string", + "description":"This is the address range of the subnet." + }, + "prefix": { + "type":"string", + "description":"This is the prefix of the subnet." + } + } + }, + "Instance": { + "type": "object", + "description": "This is the response from the Instance_GetMetadata operation.", + "properties": { + "compute": { + "$ref": "#/definitions/Compute", + "description": "Compute Metadata" + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network Metadata" + } + } + }, + "AttestedData": { + "type": "object", + "description": "This is the response from the Attested_GetDocument operation.", + "properties": { + "signature": { + "type": "string", + "description": "This is the encoded string containing the VM ID, plan information, public key, timestamp, and nonce value." + }, + "encoding": { + "type": "string", + "description": "This is the encoding scheme of the signature." + } + } + }, + "ErrorResponse": { + "description": "This is the response from an operation in the case an error occurs.", + "type": "object", + "properties": { + "error": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "IdentityErrorResponse": { + "type": "object", + "description": "This is the response from an Identity operation in the case an error occurs.", + "properties": { + "error": { + "type": "string", + "description": "Error code", + "enum": [ + "invalid_request", + "unauthorized_client", + "access_denied", + "unsupported_response_type", + "invalid_scope", + "server_error", + "service_unavailable", + "bad_request", + "forbidden", + "not_found", + "method_not_allowed", + "too_many_requests" + ], + "x-ms-enum": { + "name": "Error", + "modelAsString": true + } + }, + "error_description": { + "type": "string", + "description": "Error message indicating why the operation failed." + } + } + }, + "IdentityTokenResponse": { + "type": "object", + "description": "This is the response from the Identity_GetToken operation.", + "properties": { + "access_token": { + "type": "string", + "description": "This is the requested access token. The app can use this token to authenticate to the sink resource." + }, + "expires_in": { + "type": "string", + "description": "This is how long the access token is valid (in seconds)." + }, + "expires_on": { + "type": "string", + "description": "This is the time when the access token expires. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time. This value is used to determine the lifetime of cached tokens." + }, + "ext_expires_in": { + "type": "string", + "description": "This indicates the extended lifetime of the token." + }, + "not_before": { + "type": "string", + "description": "This is the time when the access token becomes effective. The date is represented as the number of seconds from 1970-01-01T0:0:0Z UTC until the expiration time." + }, + "resource": { + "type": "string", + "description": "This is the app ID URI of the sink resource." + }, + "token_type": { + "type": "string", + "description": "This indicates the token type value." + }, + "client_id": { + "type": "string", + "description": "This is the client_id specified in the request, if any." + }, + "object_id": { + "type": "string", + "description": "This is the object_id specified in the request, if any." + }, + "msi_res_id": { + "type": "string", + "description": "This is the msi_res_id specified in the request, if any." + } + } + }, + "IdentityInfoResponse": { + "type": "object", + "description": "This is the response from the Identity_GetInfo operation.", + "properties": { + "tenantId": { + "type": "string", + "description": "This is the AAD tenantId of the identity of the caller." + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "type": "string", + "enum": [ + "2018-10-01" + ], + "description": "This is the API version to use.", + "required": true, + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + } + }, + "MetadataParameter": { + "name": "Metadata", + "in": "header", + "type": "string", + "enum": [ + "true" + ], + "description": "This must be set to 'true'.", + "required": true, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/imds/data-plane/readme.csharp.md b/specification/imds/data-plane/readme.csharp.md new file mode 100644 index 000000000000..20481e7f6788 --- /dev/null +++ b/specification/imds/data-plane/readme.csharp.md @@ -0,0 +1,20 @@ +# C# Storage + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for IMDS. + +## Common C# Settings + +``` yaml $(csharp) +csharp: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + clear-output-folder: true +``` + +``` yaml $(csharp) && !$(multiapi) && !$(profile) +payload-flattening-threshold: 2 +namespace: Microsoft.Azure.InstanceMetadataService +output-folder: $(csharp-sdks-folder)/Azure/InstanceMetadataService/Generated +``` diff --git a/specification/imds/data-plane/readme.go.md b/specification/imds/data-plane/readme.go.md new file mode 100644 index 000000000000..a805b79cf2ba --- /dev/null +++ b/specification/imds/data-plane/readme.go.md @@ -0,0 +1,10 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: storage + clear-output-folder: true +``` diff --git a/specification/imds/data-plane/readme.md b/specification/imds/data-plane/readme.md new file mode 100644 index 000000000000..246faba00e21 --- /dev/null +++ b/specification/imds/data-plane/readme.md @@ -0,0 +1,73 @@ +# Instance Metadata Service +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Instance Metadata Service. + +## Getting Started +To build the SDKs for Instance Metadata Service, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: +> `autorest readme.md` + +To see additional help and options, run: +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information +These are the global settings for the Instance Metadata Service API. + +``` yaml +openapi-type: data-plane +azure-arm: true +tag: package-2018-05 +input-file: +- Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json +output-folder: ./Generated +``` + +## Suppression + ``` yaml + directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: The following properties follow the Oath2 spec, which does not use camelCase. + from: Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json + where: + - $.definitions.IdentityTokenResponse.properties.access_token + - $.definitions.IdentityTokenResponse.properties.expires_in + - $.definitions.IdentityTokenResponse.properties.expires_on + - $.definitions.IdentityTokenResponse.properties.ext_expires_in + - $.definitions.IdentityTokenResponse.properties.not_before + - $.definitions.IdentityTokenResponse.properties.resource + - $.definitions.IdentityTokenResponse.properties.token_type + - $.definitions.IdentityTokenResponse.properties.client_id + - $.definitions.IdentityTokenResponse.properties.object_id + - $.definitions.IdentityTokenResponse.properties.msi_res_id + - $.definitions.IdentityErrorResponse.properties.error_description + ``` + +--- +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. + +``` yaml $(csharp) +csharp: + azure-arm: true + output-folder: ./Generated + clear-output-folder: true +``` + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python +``` diff --git a/specification/imds/data-plane/readme.nodejs.md b/specification/imds/data-plane/readme.nodejs.md new file mode 100644 index 000000000000..744df7b8af95 --- /dev/null +++ b/specification/imds/data-plane/readme.nodejs.md @@ -0,0 +1,16 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + azure-arm: true + package-name: azure-imds + output-folder: $(node-sdks-folder)/lib/services/imds + payload-flattening-threshold: 2 + override-client-name: IMDSClient + generate-license-txt: true + generate-package-json: true + generate-readme-md: false +``` diff --git a/specification/imds/data-plane/readme.python.md b/specification/imds/data-plane/readme.python.md new file mode 100644 index 000000000000..daf2ae712b71 --- /dev/null +++ b/specification/imds/data-plane/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: azure.imds + package-name: azure-imds + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-imds/azure/imds +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/azure-imds +``` \ No newline at end of file diff --git a/specification/imds/data-plane/readme.ruby.md b/specification/imds/data-plane/readme.ruby.md new file mode 100644 index 000000000000..ef7d2c898277 --- /dev/null +++ b/specification/imds/data-plane/readme.ruby.md @@ -0,0 +1,10 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +``` yaml +package-name: azure_imds +package-version: "0.16.3" +azure-arm: true +``` + diff --git a/specification/imds/data-plane/readme.typescript.md b/specification/imds/data-plane/readme.typescript.md new file mode 100644 index 000000000000..cd79798fce9c --- /dev/null +++ b/specification/imds/data-plane/readme.typescript.md @@ -0,0 +1,14 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/imds" + output-folder: "$(typescript-sdks-folder)/packages/@azure/imds" + payload-flattening-threshold: 2 + override-client-name: IMDSClient + generate-metadata: true +``` From a1aae618591728f922a59bdcba6303ead4dcf745 Mon Sep 17 00:00:00 2001 From: Wei Wei Date: Sat, 22 Dec 2018 00:53:02 +0800 Subject: [PATCH 458/464] [Storage] Fix the UseSubDomainName (#4938) --- .../Microsoft.Storage/preview/2015-05-01-preview/storage.json | 2 +- .../Microsoft.Storage/preview/2018-03-01-preview/storage.json | 2 +- .../Microsoft.Storage/stable/2015-06-15/storage.json | 2 +- .../Microsoft.Storage/stable/2016-01-01/storage.json | 2 +- .../Microsoft.Storage/stable/2016-05-01/storage.json | 2 +- .../Microsoft.Storage/stable/2016-12-01/storage.json | 2 +- .../Microsoft.Storage/stable/2017-06-01/storage.json | 2 +- .../Microsoft.Storage/stable/2017-10-01/storage.json | 2 +- .../Microsoft.Storage/stable/2018-02-01/storage.json | 2 +- .../Microsoft.Storage/stable/2018-07-01/storage.json | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json index 65c97a8a7876..aa2d63dbe442 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2015-05-01-preview/storage.json @@ -510,7 +510,7 @@ "type": "string", "description": "Gets or sets the custom domain name. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" } diff --git a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json index 3ce80811b1c1..78381e8d4f4a 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/preview/2018-03-01-preview/storage.json @@ -1032,7 +1032,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json index 632499206027..6a6c1f14d34c 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2015-06-15/storage.json @@ -523,7 +523,7 @@ "type": "string", "description": "The custom domain name. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates" } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json index ac6c9b6c3f51..61424e2d5888 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-01-01/storage.json @@ -501,7 +501,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json index 28e55b03abcc..5aec59fef371 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-05-01/storage.json @@ -565,7 +565,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json index 5136a94d8d19..1b8af9e8daa8 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2016-12-01/storage.json @@ -568,7 +568,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json index 39f5e052379e..18764366ad22 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-06-01/storage.json @@ -900,7 +900,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json index 31ea509e580e..a8bd85c0490b 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2017-10-01/storage.json @@ -901,7 +901,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json index 2b659b3a8b04..f19ab5c57d4a 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-02-01/storage.json @@ -964,7 +964,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json index d88fa4a18d29..19feac6e62cf 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2018-07-01/storage.json @@ -940,7 +940,7 @@ "type": "string", "description": "Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source." }, - "useSubDomain": { + "useSubDomainName": { "type": "boolean", "description": "Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates." } From 07be8f95a42b41d359bf382ea91bac3c5221d32f Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Fri, 21 Dec 2018 09:32:40 -0800 Subject: [PATCH 459/464] Update SwaggerToSdk to new DockerHub address (#4957) * Update SwaggerToSdk to new DockerHub address * Update swagger-to-sdk.sh --- scripts/swagger-to-sdk.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/swagger-to-sdk.sh b/scripts/swagger-to-sdk.sh index ef8923dbe856..663c223bd6f3 100755 --- a/scripts/swagger-to-sdk.sh +++ b/scripts/swagger-to-sdk.sh @@ -1,5 +1,5 @@ #!/bin/sh python -c "import os; print('\n'.join(v for v in os.environ.keys() if v.startswith('TRAVIS')))" > /tmp/env_file -docker pull lmazuel/swagger-to-sdk -docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ lmazuel/swagger-to-sdk "$@" \ No newline at end of file +docker pull azuresdk/swagger-to-sdk +docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ azuresdk/swagger-to-sdk "$@" From 789256cb59131b904f83de5e83ed911ec74e7d74 Mon Sep 17 00:00:00 2001 From: AprilZhaoWY <43895863+AprilZhaoWY@users.noreply.github.com> Date: Fri, 21 Dec 2018 16:15:49 -0800 Subject: [PATCH 460/464] Add PATCH API example to hanaonazure (#4949) * Add PATCH API example to hanaonazure * Address PR feedback * Add Tags definiton back * Change operationId to HanaInstances_Update --- .../examples/HanaInstances_PatchTags.json | 48 +++++++++++++ .../HanaInstances_PatchTags_Delete.json | 46 ++++++++++++ .../2017-11-03-preview/hanaonazure.json | 72 ++++++++++++++++++- 3 files changed, 165 insertions(+), 1 deletion(-) create mode 100644 specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json create mode 100644 specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json new file mode 100644 index 000000000000..b9fff0a699a8 --- /dev/null +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2017-11-03-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "hanaInstanceName": "myHanaInstance", + "tagsParameter": { + "tags": { "testkey": "testvalue"} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance", + "name": "myHanaInstance", + "type": "Microsoft.HanaOnAzure/hanaInstances", + "location": "westus", + "tags": { + "testkey": "testvalue" + }, + "properties": { + "hanaInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "hanaInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..2c7fc4f5da13 --- /dev/null +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/examples/HanaInstances_PatchTags_Delete.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2017-11-03-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "hanaInstanceName": "myHanaInstance", + "tagsParameter": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.HanaOnAzure/hanaInstances/myHanaInstance", + "name": "myHanaInstance", + "type": "Microsoft.HanaOnAzure/hanaInstances", + "location": "westus", + "tags": {}, + "properties": { + "hanaInstanceId": "00000000-0000-0000-0000-000000000000", + "powerState": "started", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "hanaInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1" + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json index 25528e40009a..561b7078ad3a 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2017-11-03-preview/hanaonazure.json @@ -193,7 +193,54 @@ } } } - } + }, + "patch": { + "tags": [ + "HanaOnAzure" + ], + "operationId": "HanaInstances_Update", + "summary": "Patches the Tags field of a SAP HANA instance.", + "description": "Patches the Tags field of a SAP HANA instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of a HANA instance": { + "$ref": "./examples/HanaInstances_PatchTags.json" + }, + "Delete Tags field of a HANA instance": { + "$ref": "./examples/HanaInstances_PatchTags_Delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/HanaInstanceNameParameter" + }, + { + "$ref": "#/parameters/TagsParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HanaInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HanaOnAzure/hanaInstances/{hanaInstanceName}/restart": { "post": { @@ -547,6 +594,19 @@ "type": "string" } } + }, + "Tags": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags field of the HANA instance." + } + }, + "description": "Tags field of the HANA instance." } }, "parameters": { @@ -579,6 +639,16 @@ "required": true, "type": "string", "description": "Client API version." + }, + "TagsParameter": { + "name": "tagsParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tags" + }, + "description": "Request body that only contains the new Tags field", + "x-ms-parameter-location": "method" } } } From df184030825d2f42761bb76dfce9ff0fabf55843 Mon Sep 17 00:00:00 2001 From: Jemal Abdulkadir Date: Thu, 27 Dec 2018 11:57:41 -0800 Subject: [PATCH 461/464] Swagger change for Update configuration dynamic group Saved Search Query (#4964) --- .../createSoftwareUpdateConfiguration.json | 150 +++++++++--------- .../softwareUpdateConfiguration.json | 23 +++ 2 files changed, 100 insertions(+), 73 deletions(-) diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json index b6893335255c..dc301c59af0f 100755 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/examples/softwareUpdateConfiguration/createSoftwareUpdateConfiguration.json @@ -1,79 +1,83 @@ { "parameters": { - "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", - "resourceGroupName": "mygroup", - "automationAccountName": "myaccount", - "softwareUpdateConfigurationName": "testpatch", - "api-version": "2017-05-15-preview", - "parameters": { - "properties": { - "updateConfiguration": { - "operatingSystem": "Windows", - "duration": "PT2H0M", - "windows": { - "excludedKbNumbers": [ - "168934", - "168973" - ], - "includedUpdateClassifications": "Critical", - "rebootSetting": "IfRequired" - }, - "azureVirtualMachines": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" - ], - "nonAzureComputerNames": [ - "box1.contoso.com", - "box2.contoso.com" - ], - "targets": [ - { - "azureQueries": { - "scope": [ - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", - "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" - ], - "tagSettings": { - "tags": [ - { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ] - }, - { - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - } + "subscriptionId": "51766542-3ed7-4a72-a187-0c8ab644ddab", + "resourceGroupName": "mygroup", + "automationAccountName": "myaccount", + "softwareUpdateConfigurationName": "testpatch", + "api-version": "2017-05-15-preview", + "parameters": { + "properties": { + "updateConfiguration": { + "operatingSystem": "Windows", + "duration": "PT2H0M", + "windows": { + "excludedKbNumbers": [ + "168934", + "168973" + ], + "includedUpdateClassifications": "Critical", + "rebootSetting": "IfRequired" + }, + "azureVirtualMachines": [ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-01", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-02", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources/providers/Microsoft.Compute/virtualMachines/vm-03" ], - "filterOperator": "All" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - ] - }, - "scheduleInfo": { - "frequency": "Hour", - "startTime": "2017-10-19T12:22:57+00:00", - "timeZone": "America/Los_Angeles", - "interval": 1, - "expiryTime": "2018-11-09T11:22:57+00:00", - "advancedSchedule": { - "weekDays": [ - "Monday", - "Thursday" - ] - } - }, + "nonAzureComputerNames": [ + "box1.contoso.com", + "box2.contoso.com" + ], + "targets": + { + "azureQueries":[ + { + "scope":[ + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067/resourceGroups/myresources", + "/subscriptions/5ae68d89-69a4-454f-b5ce-e443cc4e0067" + ], + "tagSettings":{ + "tags":[ + { + "tag1": ["tag1Value1", "tag1Value2", "tag1Value3"] + }, + { + "tag2": ["tag2Value1", "tag2Value2", "tag2Value3"] + } + ], + "filterOperator" : "All" + }, + "locations":[ + "Japan East", + "UK South" + ] + } + ], + "nonAzureQueries":[ + { + "FunctionAlias": "SavedSearch1", + "WorkspaceId" : "WorkspaceId1" + }, + { + "FunctionAlias": "SavedSearch2", + "WorkspaceId" : "WorkspaceId2" + } + ] + + } + }, + "scheduleInfo": { + "frequency": "Hour", + "startTime": "2017-10-19T12:22:57+00:00", + "timeZone": "America/Los_Angeles", + "interval": 1, + "expiryTime": "2018-11-09T11:22:57+00:00", + "advancedSchedule": { + "weekDays": [ + "Monday", + "Thursday" + ] + } + }, "tasks": { "preTask": { "source": "HelloWorld", diff --git a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json index 2862d3dbe5ed..2c04af304423 100644 --- a/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json +++ b/specification/automation/resource-manager/Microsoft.Automation/preview/2017-05-15-preview/softwareUpdateConfiguration.json @@ -801,8 +801,31 @@ "type": "object", "$ref": "#/definitions/AzureQueryProperties" } + }, + "nonAzureQueries":{ + "description": "List of non Azure queries in the software update configuration.", + "type": "array", + "items": { + "type": "object", + "$ref": "#/definitions/NonAzureQueryProperties" + } + } + } + }, + "NonAzureQueryProperties":{ + "type": "object", + "description": "Non Azure query for the update configuration.", + "properties":{ + "functionAlias" :{ + "type": "string", + "description": "Log Analytics Saved Search name." + }, + "workspaceId" :{ + "type": "string", + "description": "Workspace Id for Log Analytics in which the saved Search is resided." } } + }, "AzureQueryProperties": { "type": "object", From d60524d0407bc78be99974c44e3468c937fe0e21 Mon Sep 17 00:00:00 2001 From: toweinbe <41298684+wtomw@users.noreply.github.com> Date: Wed, 2 Jan 2019 19:17:47 +0200 Subject: [PATCH 462/464] Settings API (#4969) --- .../preview/2017-08-01-preview/security.json | 28 +++++++++++++------ 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json index b01420e8dc9c..dd28fce11964 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json @@ -1492,10 +1492,7 @@ "properties": {}, "allOf": [ { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/SettingKind" + "$ref": "#/definitions/SettingResource" } ] }, @@ -1516,15 +1513,16 @@ } ] }, - "SettingKind": { + "SettingResource": { "type": "object", "description": "The kind of the security setting", "properties": { "kind": { "type": "string", - "description": "the kind of the settings string", + "description": "the kind of the settings string (DataExportSetting)", "enum": [ - "DataExportSetting" + "DataExportSetting", + "AlertSuppressionSetting" ], "x-ms-enum": { "name": "SettingKind", @@ -1532,11 +1530,23 @@ "values": [ { "value": "DataExportSetting" + }, + { + "value": "AlertSuppressionSetting" } ] } + } - } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] }, "DataExportSettingProperties": { "type": "object", @@ -1783,7 +1793,7 @@ "in": "path", "required": true, "type": "string", - "description": "Name of setting", + "description": "Name of setting: (MCAS/WDATP)", "enum": [ "MCAS", "WDATP" From 2bbf8c61828c6b7aa631a0fd239932fd87cb622a Mon Sep 17 00:00:00 2001 From: Nick Schonning Date: Wed, 2 Jan 2019 13:04:26 -0500 Subject: [PATCH 463/464] chore: Rename imds/data-plane/Microsoft.InstanceMetadataService examples (#4959) - Camel Case example file names - Trim trailing spaces --- ...attesteddata.json => getAttestedData.json} | 0 ...identityinfo.json => getIdentityInfo.json} | 0 ...entitytoken.json => getIdentityToken.json} | 0 ...metadata.json => getInstanceMetadata.json} | 0 .../stable/2018-10-01/imds.json | 48 +++++++++---------- 5 files changed, 24 insertions(+), 24 deletions(-) rename specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/{getattesteddata.json => getAttestedData.json} (100%) rename specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/{getidentityinfo.json => getIdentityInfo.json} (100%) rename specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/{getidentitytoken.json => getIdentityToken.json} (100%) rename specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/{getinstancemetadata.json => getInstanceMetadata.json} (100%) diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getAttestedData.json similarity index 100% rename from specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getattesteddata.json rename to specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getAttestedData.json diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getIdentityInfo.json similarity index 100% rename from specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentityinfo.json rename to specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getIdentityInfo.json diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getIdentityToken.json similarity index 100% rename from specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getidentitytoken.json rename to specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getIdentityToken.json diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getInstanceMetadata.json similarity index 100% rename from specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getinstancemetadata.json rename to specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/examples/getInstanceMetadata.json diff --git a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json index ecd501259644..4397970949a1 100644 --- a/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json +++ b/specification/imds/data-plane/Microsoft.InstanceMetadataService/stable/2018-10-01/imds.json @@ -1,4 +1,4 @@ -{ +{ "swagger": "2.0", "info": { "title": "InstanceMetadataClient", @@ -45,7 +45,7 @@ }, { "$ref": "#/parameters/MetadataParameter" - } + } ], "responses": { "200": { @@ -105,7 +105,7 @@ }, "x-ms-examples": { "Get Instance Metadata for the VM": { - "$ref": "./examples/getinstancemetadata.json" + "$ref": "./examples/getInstanceMetadata.json" } } } @@ -127,7 +127,7 @@ }, { "$ref": "#/parameters/MetadataParameter" - } + } ], "responses": { "200": { @@ -187,7 +187,7 @@ }, "x-ms-examples": { "Get Attested Data for the VM": { - "$ref": "./examples/getattesteddata.json" + "$ref": "./examples/getAttestedData.json" } } } @@ -305,7 +305,7 @@ }, "x-ms-examples": { "Get Identity Token for the VM": { - "$ref": "./examples/getidentitytoken.json" + "$ref": "./examples/getIdentityToken.json" } } } @@ -374,7 +374,7 @@ }, "x-ms-examples": { "Get Identity Info for the VM": { - "$ref": "./examples/getidentityinfo.json" + "$ref": "./examples/getIdentityInfo.json" } } } @@ -435,7 +435,7 @@ "publisher": { "type": "string", "description": "This is the publisher of the VM image." - }, + }, "resourceGroupName": { "type": "string", "description": "This is the resource group for the VM." @@ -443,7 +443,7 @@ "sku": { "type": "string", "description": "This is the specific SKU for the VM image." - }, + }, "subscriptionId": { "type": "string", "description": "This is the Azure subscription for the VM." @@ -460,7 +460,7 @@ "type": "string", "description": "This is the unique identifier for the VM." }, - "vmScaleSetName": { + "vmScaleSetName": { "type": "string", "description": "This is the resource name of the VMSS." }, @@ -472,7 +472,7 @@ "type":"string", "description":"This is the availability zone of the VM." } - }, + }, "description": "Compute Metadata" }, "Network": { @@ -485,7 +485,7 @@ "type": "object", "$ref": "#/definitions/NetworkInterface" } - } + } }, "description": "Network Metadata" }, @@ -496,8 +496,8 @@ "ipv4": { "type":"object", "description": "This contains the IPv4 address.", - "properties": { - "ipAddress": { + "properties": { + "ipAddress": { "type":"array", "description": "This is the IP address", "items": { @@ -520,8 +520,8 @@ "ipv6": { "type":"object", "description": "This contains the IPv6 address.", - "properties": { - "ipAddress": { + "properties": { + "ipAddress": { "type":"array", "description": "This is the IP address", "items": { @@ -573,12 +573,12 @@ "Ipv4Properties": { "type": "object", "description": "This contains the IPv4 properties.", - "properties": { + "properties": { "privateIpAddress": { "type":"string", "description":"This is the private IP address assigned to the interface." }, - "publicIpAddress": { + "publicIpAddress": { "type":"string", "description":"This is the public IP address assigned to the interface." } @@ -587,7 +587,7 @@ "Ipv6Properties": { "type": "object", "description": "This contains the IPv6 properties.", - "properties": { + "properties": { "privateIpAddress": { "type":"string", "description":"This is the private IPv6 address assigned to the interface." @@ -597,12 +597,12 @@ "SubnetProperties": { "type": "object", "description": "This contains the properties of the subnet.", - "properties": { + "properties": { "address": { "type":"string", "description":"This is the address range of the subnet." }, - "prefix": { + "prefix": { "type":"string", "description":"This is the prefix of the subnet." } @@ -618,7 +618,7 @@ }, "network": { "$ref": "#/definitions/Network", - "description": "Network Metadata" + "description": "Network Metadata" } } }, @@ -632,7 +632,7 @@ }, "encoding": { "type": "string", - "description": "This is the encoding scheme of the signature." + "description": "This is the encoding scheme of the signature." } } }, @@ -732,7 +732,7 @@ "type": "string", "description": "This is the AAD tenantId of the identity of the caller." } - } + } } }, "parameters": { From 2d5af451c03759d1979554d7189ca0c2c7529cb3 Mon Sep 17 00:00:00 2001 From: shouyangli <46120323+shouyangli@users.noreply.github.com> Date: Thu, 3 Jan 2019 03:21:30 +0800 Subject: [PATCH 464/464] Update Get.json (#4961) Same as PR #4960 Quota value should not be negative. It will output wrong document at: https://docs.microsoft.com/en-us/rest/api/azurestack/storagequotas/get --- .../preview/2015-12-01/examples/Quotas/Get.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json index 7f3b02edfd5a..630ce6ef9504 100644 --- a/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json +++ b/specification/azsadmin/resource-manager/storage/Microsoft.Storage.Admin/preview/2015-12-01/examples/Quotas/Get.json @@ -14,8 +14,8 @@ "type": "Microsoft.Storage.Admin/locations/quotas", "location": "local", "properties": { - "numberOfStorageAccounts": -1000000000, - "capacityInGb": -100000000 + "numberOfStorageAccounts": 20, + "capacityInGb": 2048 } } },